Enum heron_core::BodyType

pub enum BodyType {
    Dynamic,
    Static,
    Sensor,
}

Component that defines the type of rigid body.

Example

fn spawn(commands: &mut Commands, mut materials: ResMut<Assets<ColorMaterial>>) {
    commands.spawn(todo!("Spawn your sprite/mesh, incl. at least a GlobalTransform"))
        .with(Body::Sphere { radius: 1.0 }) // Make a body (is dynamic by default)
        .with(BodyType::Static); // Make it static (so that it doesn't move and is not affected by forces like gravity)
}

Variants

Dynamic

A dynamic body is normally affected by physic forces and affect the other bodies too.

This is the most "natural" type in the sense that, in the real life, everything is dynamic.

Static

A static body is not affected by physic forces and doesn't move. But it does affect the other bodies.

This effectively behaves like a dynamic body with infinite mass and zero velocity.

It is especially useful to model terrain and static obstacles.

Sensor

A sensor is not affected by physics forces and doesn't affect other bodies either. Other bodies will be able to penetrate the sensor.

A sensor is useful when we are only interested in collision events. One may for example add a sensor to detect when the player reach a certain area.

Trait Implementations

impl Clone for BodyType

fn clone(&self) -> BodyType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BodyType

impl Debug for BodyType

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

Formats the value using the given formatter.

impl Default for BodyType

fn default() -> Self

Returns the "default value" for a type.

impl Eq for BodyType

impl PartialEq<BodyType> for BodyType

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for BodyType

impl StructuralPartialEq for BodyType