Enum avian3d::collision::collider::ColliderConstructor
source · #[non_exhaustive]pub enum ColliderConstructor {
Show 17 variants
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,
},
}
Expand description
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,
PbrBundle {
mesh: meshes.add(Mesh::from(Cuboid::default())),
..default()
},
));
}
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Sphere
Constructs a collider with Collider::sphere
.
Cuboid
Constructs a collider with Collider::cuboid
.
RoundCuboid
Constructs a collider with Collider::round_cuboid
.
Cylinder
Constructs a collider with Collider::cylinder
.
Cone
Constructs a collider with Collider::cone
.
Capsule
Constructs a collider with Collider::capsule
.
CapsuleEndpoints
Constructs a collider with Collider::capsule_endpoints
.
HalfSpace
Constructs a collider with Collider::half_space
.
Segment
Constructs a collider with Collider::segment
.
Triangle
Constructs a collider with Collider::triangle
.
Polyline
Constructs a collider with Collider::polyline
.
Trimesh
Constructs a collider with Collider::trimesh
.
TrimeshWithConfig
Constructs a collider with Collider::trimesh_with_config
.
ConvexDecomposition
Constructs a collider with Collider::convex_decomposition
.
ConvexDecompositionWithConfig
Constructs a collider with Collider::convex_decomposition_with_config
.
ConvexHull
Constructs a collider with Collider::convex_hull
.
Heightfield
Constructs a collider with Collider::heightfield
.
Trait Implementations§
source§impl Clone for ColliderConstructor
impl Clone for ColliderConstructor
source§fn clone(&self) -> ColliderConstructor
fn clone(&self) -> ColliderConstructor
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Component for ColliderConstructor
impl Component for ColliderConstructor
source§const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table
const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table
source§fn register_component_hooks(_hooks: &mut ComponentHooks)
fn register_component_hooks(_hooks: &mut ComponentHooks)
ComponentHooks
.source§impl Debug for ColliderConstructor
impl Debug for ColliderConstructor
source§impl Enum for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
impl Enum for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
source§fn field(&self, __name_param: &str) -> Option<&dyn Reflect>
fn field(&self, __name_param: &str) -> Option<&dyn Reflect>
source§fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>
fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>
source§fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>
source§fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>
source§fn index_of(&self, __name_param: &str) -> Option<usize>
fn index_of(&self, __name_param: &str) -> Option<usize>
source§fn name_at(&self, __index_param: usize) -> Option<&str>
fn name_at(&self, __index_param: usize) -> Option<&str>
source§fn iter_fields(&self) -> VariantFieldIter<'_>
fn iter_fields(&self) -> VariantFieldIter<'_>
source§fn variant_name(&self) -> &str
fn variant_name(&self) -> &str
source§fn variant_index(&self) -> usize
fn variant_index(&self) -> usize
source§fn variant_type(&self) -> VariantType
fn variant_type(&self) -> VariantType
fn clone_dynamic(&self) -> DynamicEnum
source§fn is_variant(&self, variant_type: VariantType) -> bool
fn is_variant(&self, variant_type: VariantType) -> bool
source§fn variant_path(&self) -> String
fn variant_path(&self) -> String
source§impl FromReflect for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
impl FromReflect for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
source§fn from_reflect(__param0: &dyn Reflect) -> Option<Self>
fn from_reflect(__param0: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl GetTypeRegistration for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
impl GetTypeRegistration for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl PartialEq for ColliderConstructor
impl PartialEq for ColliderConstructor
source§fn eq(&self, other: &ColliderConstructor) -> bool
fn eq(&self, other: &ColliderConstructor) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Reflect for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
impl Reflect for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(
&mut self,
__value_param: Box<dyn Reflect>
) -> Result<(), Box<dyn Reflect>>
fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl TypePath for ColliderConstructor
impl TypePath for ColliderConstructor
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
impl Typed for ColliderConstructorwhere
Self: Any + Send + Sync,
Scalar: FromReflect + TypePath + RegisterForReflection,
Vector: FromReflect + TypePath + RegisterForReflection,
Vec<Vector>: FromReflect + TypePath + RegisterForReflection,
Option<Vec<[u32; 2]>>: FromReflect + TypePath + RegisterForReflection,
Vec<[u32; 3]>: FromReflect + TypePath + RegisterForReflection,
TrimeshFlags: FromReflect + TypePath + RegisterForReflection,
VhacdParameters: FromReflect + TypePath + RegisterForReflection,
Vec<Vec<Scalar>>: FromReflect + TypePath + RegisterForReflection,
impl StructuralPartialEq for ColliderConstructor
Auto Trait Implementations§
impl Freeze for ColliderConstructor
impl RefUnwindSafe for ColliderConstructor
impl Send for ColliderConstructor
impl Sync for ColliderConstructor
impl Unpin for ColliderConstructor
impl UnwindSafe for ColliderConstructor
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<C> Bundle for Cwhere
C: Component,
impl<C> Bundle for Cwhere
C: Component,
fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )
unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
source§fn get_component_ids(
components: &Components,
ids: &mut impl FnMut(Option<ComponentId>)
)
fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>) )
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<C> DynamicBundle for Cwhere
C: Component,
impl<C> DynamicBundle for Cwhere
C: Component,
fn get_components(self, func: &mut impl FnMut(StorageType, OwningPtr<'_>))
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.