Enum ColliderConstructor

#[non_exhaustive]
pub enum ColliderConstructor {
    Sphere {
        radius: Scalar,
    },
    Cuboid {
        x_length: Scalar,
        y_length: Scalar,
        z_length: Scalar,
    },
    RoundCuboid {
        x_length: Scalar,
        y_length: Scalar,
        z_length: Scalar,
        border_radius: Scalar,
    },
    Cylinder {
        radius: Scalar,
        height: Scalar,
    },
    Cone {
        radius: Scalar,
        height: Scalar,
    },
    Capsule {
        radius: Scalar,
        height: Scalar,
    },
    CapsuleEndpoints {
        radius: Scalar,
        a: Vector,
        b: Vector,
    },
    HalfSpace {
        outward_normal: Vector,
    },
    Segment {
        a: Vector,
        b: Vector,
    },
    Triangle {
        a: Vector,
        b: Vector,
        c: Vector,
    },
    Polyline {
        vertices: Vec<Vector>,
        indices: Option<Vec<[u32; 2]>>,
    },
    Trimesh {
        vertices: Vec<Vector>,
        indices: Vec<[u32; 3]>,
    },
    TrimeshWithConfig {
        vertices: Vec<Vector>,
        indices: Vec<[u32; 3]>,
        flags: TrimeshFlags,
    },
    ConvexDecomposition {
        vertices: Vec<Vector>,
        indices: Vec<[u32; 3]>,
    },
    ConvexDecompositionWithConfig {
        vertices: Vec<Vector>,
        indices: Vec<[u32; 3]>,
        params: VhacdParameters,
    },
    ConvexHull {
        points: Vec<Vector>,
    },
    Heightfield {
        heights: Vec<Vec<Scalar>>,
        scale: Vector,
    },
}

A component that will automatically generate a Collider at runtime using Collider::try_from_constructor. Enabling the collider-from-mesh feature activates support for computing the shape dynamically from the mesh attached to the same entity.

Since Collider is not Reflect, you can use this type to statically specify a collider’s shape instead.

This component will never override a pre-existing Collider component on the same entity.

See Also

For inserting colliders on an entity’s descendants, use ColliderConstructorHierarchy.

Panics

The system handling the generation of colliders will panic if the specified ColliderConstructor requires a mesh, but the entity does not have a Handle<Mesh> component.

Example

use avian3d::prelude::*;
use bevy::prelude::*;

fn setup(mut commands: Commands, mut assets: ResMut<AssetServer>, mut meshes: Assets<Mesh>) {
    // Spawn a cube with a convex hull collider generated from the mesh
    commands.spawn((
        ColliderConstructor::ConvexHullFromMesh,
        Mesh3d(meshes.add(Cuboid::default())),
    ));
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sphere

Constructs a collider with Collider::sphere.

Fields

radius: Scalar

Cuboid

Constructs a collider with Collider::cuboid.

Fields

x_length: Scalar

y_length: Scalar

z_length: Scalar

RoundCuboid

Constructs a collider with Collider::round_cuboid.

Fields

x_length: Scalar

y_length: Scalar

z_length: Scalar

border_radius: Scalar

Cylinder

Constructs a collider with Collider::cylinder.

Fields

radius: Scalar

height: Scalar

Cone

Constructs a collider with Collider::cone.

Fields

radius: Scalar

height: Scalar

Capsule

Constructs a collider with Collider::capsule.

Fields

radius: Scalar

height: Scalar

CapsuleEndpoints

Constructs a collider with Collider::capsule_endpoints.

Fields

radius: Scalar

a: Vector

b: Vector

HalfSpace

Constructs a collider with Collider::half_space.

Fields

outward_normal: Vector

Segment

Constructs a collider with Collider::segment.

Fields

a: Vector

b: Vector

Triangle

Constructs a collider with Collider::triangle.

Fields

a: Vector

b: Vector

c: Vector

Polyline

Constructs a collider with Collider::polyline.

Fields

vertices: Vec<Vector>

indices: Option<Vec<[u32; 2]>>

Trimesh

Constructs a collider with Collider::trimesh.

Fields

vertices: Vec<Vector>

indices: Vec<[u32; 3]>

TrimeshWithConfig

Constructs a collider with Collider::trimesh_with_config.

Fields

vertices: Vec<Vector>

indices: Vec<[u32; 3]>

flags: TrimeshFlags

ConvexDecomposition

Constructs a collider with Collider::convex_decomposition.

Fields

vertices: Vec<Vector>

indices: Vec<[u32; 3]>

ConvexDecompositionWithConfig

Constructs a collider with Collider::convex_decomposition_with_config.

Fields

vertices: Vec<Vector>

indices: Vec<[u32; 3]>

params: VhacdParameters

ConvexHull

Constructs a collider with Collider::convex_hull.

Fields

points: Vec<Vector>

Heightfield

Constructs a collider with Collider::heightfield.

Fields

heights: Vec<Vec<Scalar>>

scale: Vector

Trait Implementations

impl Clone for ColliderConstructor

fn clone(&self) -> ColliderConstructor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ColliderConstructor

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for ColliderConstructor

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

Formats the value using the given formatter.

impl Enum for ColliderConstructor

where ColliderConstructor: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vector: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vector>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Vec<[u32; 2]>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<[u32; 3]>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, TrimeshFlags: FromReflect + TypePath + MaybeTyped + RegisterForReflection, VhacdParameters: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vec<Scalar>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, __name_param: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize, ) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

Will return None if TypeInfo is not available.

impl FromReflect for ColliderConstructor

where ColliderConstructor: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vector: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vector>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Vec<[u32; 2]>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<[u32; 3]>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, TrimeshFlags: FromReflect + TypePath + MaybeTyped + RegisterForReflection, VhacdParameters: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vec<Scalar>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(__param0: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for ColliderConstructor

where ColliderConstructor: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vector: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vector>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Vec<[u32; 2]>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<[u32; 3]>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, TrimeshFlags: FromReflect + TypePath + MaybeTyped + RegisterForReflection, VhacdParameters: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vec<Scalar>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for ColliderConstructor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialReflect for ColliderConstructor

where ColliderConstructor: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vector: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vector>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Vec<[u32; 2]>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<[u32; 3]>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, TrimeshFlags: FromReflect + TypePath + MaybeTyped + RegisterForReflection, VhacdParameters: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vec<Scalar>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

fn try_apply( &mut self, __value_param: &dyn PartialReflect, ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ColliderConstructor

where ColliderConstructor: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vector: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vector>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Vec<[u32; 2]>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<[u32; 3]>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, TrimeshFlags: FromReflect + TypePath + MaybeTyped + RegisterForReflection, VhacdParameters: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vec<Scalar>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl TypePath for ColliderConstructor

where ColliderConstructor: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ColliderConstructor

where ColliderConstructor: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vector: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vector>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<Vec<[u32; 2]>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<[u32; 3]>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, TrimeshFlags: FromReflect + TypePath + MaybeTyped + RegisterForReflection, VhacdParameters: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<Vec<Scalar>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl StructuralPartialEq for ColliderConstructor