Enum heron::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, Global>,
border_radius: Option<f32>,
},
HeightField {
size: Vec2,
heights: Vec<Vec<f32, Global>, Global>,
},
}
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
Fields of Sphere
radius: f32
Radius of the sphere
A capsule shape
Fields of Capsule
A cuboid/rectangular shape
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
Fields of ConvexHull
points: Vec<Vec3, Global>
A vector of points describing the convex hull
border_radius: Option<f32>
An optional border radius that will be used to round the corners of the convex hull
This radius refers to how much to add to the existing size of the hull, creating an extra buffer around the un-rounded mesh.
A shape defined by the height of points.
This shape is usefull for floors with relief.
Fields of HeightField
Trait Implementations
Returns the “default value” for a type. Read more
pub fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
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
impl<T> Pointable for T
impl<T> Pointable for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.