Enum rusty_engine::physics::Collider

pub enum Collider {
    NoCollider,
    Poly(Vec<Vec2>),
}

Represents the collider (or lack thereof) of a sprite. Two sprites need to have colliders AND have their Sprite.collision fields set to true to generate collision events. See the collider example to create your own colliders

Variants

NoCollider

Poly(Vec<Vec2>)

Implementations

impl Collider

pub fn rect<T: Into<Vec2>>(topleft: T, bottomright: T) -> Self

Generate a rectangular collider based on top-left and bottom-right points

pub fn poly<T: Into<Vec2> + Copy>(points: &[T]) -> Self

Convert a slice of Vec2’s into a polygon collider. This is helpful if you want to hard-code colliders in your code as arrays or vectors of Vec2.

pub fn circle_custom(radius: f32, vertices: usize) -> Self

Generate a polygon circle approximation with the specified radius and amount of vertices

pub fn circle(radius: f32) -> Self

Generate a 16-vertex polygon circle approximation. 16 was chosen as the default as it works quite well with the circular sprites in the asset pack.

pub fn is_poly(&self) -> bool

Whether or not the collider is a Collider::Poly.

pub fn is_convex(&self) -> bool

Whether the points in the collider represent a convex polygon (not concave or complex). This is important, because Rusty Engine’s collision detection doesn’t work correctly unless colliders are convex polygons.

This implementation is based on Rory Daulton’s answer on https://stackoverflow.com/questions/471962/how-do-i-efficiently-determine-if-a-polygon-is-convex-non-convex-or-complex?answertab=votes#tab-top

pub fn points(&self) -> Vec<Vec2>

Returns a Vec<Vec2> containing the points of the collider, or an empty Vec if there is no collider.

pub fn colliding(sprite1: &Sprite, sprite2: &Sprite) -> bool

Whether or not two sprites are currently colliding. This method ignores the collision field of the sprites.

Trait Implementations

impl Clone for Collider

fn clone(&self) -> Collider

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Collider

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Collider

fn default() -> Collider

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Collider

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Collider

fn eq(&self, other: &Collider) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Collider

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Collider