Enum heron_core::CollisionShape
source · [−]#[non_exhaustive]
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>>,
},
Cone {
half_height: f32,
radius: f32,
},
Cylinder {
half_height: f32,
radius: f32,
},
Custom {
shape: CustomCollisionShape,
},
}
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) {
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 (Non-exhaustive)
This enum is marked as non-exhaustive
Sphere
Fields
radius: f32
Radius of the sphere
A sphere (or circle in 2d) shape defined by its radius
Capsule
Fields
half_segment: f32
Distance from the center of the capsule to the center of an hemisphere.
radius: f32
Radius of the hemispheres
A capsule shape
Cuboid
Fields
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
A cuboid/rectangular shape
ConvexHull
Fields
A convex polygon/polyhedron shape
HeightField
Fields
size: Vec2
The dimensions of the field.
In 2D, only the first element is taken into account.
A shape defined by the height of points.
This shape is usefull for floors with relief.
Cone
Fields
half_height: f32
Half of the height from the base of the cone to the top point
radius: f32
The radius of the base circle
A Cone shape, like a traffic cone, with a circular base
This shape is exclusive to the 3d API, you must enable the “3d” flag to use it.
For the 2d equivalent, look at Sphere
.
Cylinder
Fields
half_height: f32
Half of the height from the base of the cylinder to the top
radius: f32
The radius of the base circle
A Cylinder shape, it is a cirlce with a height
This shape is exclusive to the 3d API, you must enable the “3d” flag to use it.
For the 2d equivalent, look at Sphere
.
Custom
Fields
shape: CustomCollisionShape
The custom collision shape to use
A Custom shape, the actual shape is abstracted, and will be determined by a corresponding backend depending on the implementation details
See CustomCollisionShape
for more info.
Trait Implementations
sourceimpl Clone for CollisionShape
impl Clone for CollisionShape
sourcefn clone(&self) -> CollisionShape
fn clone(&self) -> CollisionShape
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Component for CollisionShape where
Self: Send + Sync + 'static,
impl Component for CollisionShape where
Self: Send + Sync + 'static,
type Storage = TableStorage
sourceimpl Debug for CollisionShape
impl Debug for CollisionShape
sourceimpl Default for CollisionShape
impl Default for CollisionShape
sourceimpl GetTypeRegistration for CollisionShape
impl GetTypeRegistration for CollisionShape
fn get_type_registration() -> TypeRegistration
sourceimpl Reflect for CollisionShape
impl Reflect for CollisionShape
fn type_name(&self) -> &str
fn any(&self) -> &dyn Any
fn any_mut(&mut self) -> &mut dyn Any
fn clone_value(&self) -> Box<dyn Reflect>
fn apply(&mut self, value: &dyn Reflect)
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
sourcefn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
Returns a hash of the value (which includes the type) if hashing is supported. Otherwise
None
will be returned. Read more
sourcefn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
Returns a “partial equal” comparison result if comparison is supported. Otherwise None
will be returned. Read more
sourcefn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
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
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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,
fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given [World]
impl<T> GetPath for T where
T: Reflect,
impl<T> GetPath for T where
T: Reflect,
fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,
fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more