Enum heron_core::CollisionShape [−][src]
pub enum CollisionShape { Sphere { radius: f32, }, Capsule { half_segment: f32, radius: f32, }, Cuboid { half_extends: Vec3, border_radius: Option<f32>, }, ConvexHull { points: Vec<Vec3>, border_radius: Option<f32>, }, HeightField { size: Vec2, heights: Vec<Vec<f32>>, }, }
Expand description
Components that defines the collision shape of a rigid body
The collision shape will be attached to the RigidBody
of the same entity.
If there isn’t any RigidBody
in the entity,
the collision shape will be attached to the RigidBody
of the parent entity.
Example
fn spawn(mut commands: Commands, mut materials: ResMut<Assets<ColorMaterial>>) { commands.spawn_bundle(todo!("Spawn your sprite/mesh, incl. at least a GlobalTransform")) .insert(RigidBody::Dynamic) // Create a dynamic rigid body .insert(CollisionShape::Sphere { radius: 1.0 }); // Attach a collision shape }
Variants
A sphere (or circle in 2d) shape defined by its radius
Show fields
Fields of Sphere
radius: f32
Radius of the sphere
A capsule shape
Show fields
A cuboid/rectangular shape
Show fields
Fields of Cuboid
half_extends: Vec3
The half extends on each axis. (x = half width, y = half height, z = half depth)
In 2d the z
axis is ignored
border_radius: Option<f32>
An optional border radius that will be used to round the corners of the cuboid
This radius refers to how much to add to the existing size of the cuboid, creating an extra buffer around the un-rounded extent.
A convex polygon/polyhedron shape
Show fields
Fields of ConvexHull
A shape defined by the height of points.
This shape is usefull for floors with relief.
Show fields
Trait Implementations
Returns a hash of the value (which includes the type) if hashing is supported. Otherwise
None
will be returned. Read more
Returns a “partial equal” comparison result if comparison is supported. Otherwise None
will be returned. Read more
Returns a serializable value, if serialization is supported. Otherwise None
will be
returned. Read more
Auto Trait Implementations
impl RefUnwindSafe for CollisionShape
impl Send for CollisionShape
impl Sync for CollisionShape
impl Unpin for CollisionShape
impl UnwindSafe for CollisionShape
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert 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
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
pub fn from_world(_world: &mut World) -> T
pub fn from_world(_world: &mut World) -> T
Creates Self
using data from the given [World]
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
pub fn vzip(self) -> V