Skip to main content

ColliderShape

Enum ColliderShape 

Source
pub enum ColliderShape {
    Circle {
        radius: f32,
    },
    Aabb {
        half_extents: Vec2,
    },
    Obb {
        half_extents: Vec2,
    },
    Capsule {
        half_height: f32,
        radius: f32,
    },
    Polygon {
        vertices: Vec<Vec2>,
    },
}
Expand description

The geometric shape of a collider.

Each shape type has different performance characteristics and use cases:

  • Circle: Fastest collision detection, best for balls, projectiles
  • Box: Axis-aligned (AABB) or oriented (OBB), good for walls and platforms
  • Capsule: Good for characters, combines efficiency with smooth edges
  • Polygon: Most flexible but slowest, use sparingly for complex shapes

Variants§

§

Circle

Circle collider defined by radius.

Center is at the entity’s position. Fastest collision detection.

Fields

§radius: f32

Radius of the circle in world units

§

Aabb

Axis-Aligned Bounding Box (AABB).

Defined by half-extents (half-width, half-height) from the center. Fast collision detection, no rotation support.

Fields

§half_extents: Vec2

Half-extents (half-width, half-height)

§

Obb

Oriented Bounding Box (OBB).

Similar to AABB but can be rotated. Slightly slower than AABB.

Fields

§half_extents: Vec2

Half-extents (half-width, half-height)

§

Capsule

Capsule collider (rounded rectangle).

Defined by half-height and radius. Good for character controllers. The capsule extends vertically from the center.

Fields

§half_height: f32

Half-height of the capsule’s cylindrical section

§radius: f32

Radius of the capsule’s rounded ends

§

Polygon

Convex polygon collider.

Vertices must be in counter-clockwise order and form a convex hull. Slowest collision detection, use sparingly.

Fields

§vertices: Vec<Vec2>

Vertices in local space, counter-clockwise order

Implementations§

Source§

impl ColliderShape

Source

pub fn type_name(&self) -> &'static str

Returns the type name of this shape.

Source

pub fn compute_aabb(&self) -> Rect

Computes the axis-aligned bounding box (AABB) for this shape.

Returns a rectangle in local space that fully contains the shape. For rotated shapes (OBB, Polygon), this is a conservative bound.

Source

pub fn is_circle(&self) -> bool

Returns true if this shape is a circle.

Source

pub fn is_aabb(&self) -> bool

Returns true if this shape is an axis-aligned box (AABB).

Source

pub fn is_obb(&self) -> bool

Returns true if this shape is an oriented box (OBB).

Source

pub fn is_capsule(&self) -> bool

Returns true if this shape is a capsule.

Source

pub fn is_polygon(&self) -> bool

Returns true if this shape is a polygon.

Source

pub fn is_valid(&self) -> bool

Validates that the shape is well-formed.

Returns true if:

  • Radii and extents are positive
  • Polygons have at least 3 vertices
  • Polygon vertices form a convex hull (not checked, assumed by user)

Trait Implementations§

Source§

impl Clone for ColliderShape

Source§

fn clone(&self) -> ColliderShape

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ColliderShape

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ColliderShape

Source§

fn default() -> ColliderShape

Returns a unit circle (radius 1.0) as the default shape.

Source§

impl<'de> Deserialize<'de> for ColliderShape

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ColliderShape, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ColliderShape

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ColliderShape

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ColliderShape

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> Event for T
where T: Send + Sync + 'static,

Source§

impl<T> QueryState for T
where T: Send + Sync + Clone + 'static,

Source§

impl<T> Resource for T
where T: Send + Sync + 'static,