Struct heron_core::PhysicMaterial

pub struct PhysicMaterial {
    pub restitution: f32,
    pub density: f32,
    pub friction: f32,
}

Component that defines the physics properties of the rigid body

It must be inserted on the same entity of a RigidBody

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(CollisionShape::Sphere { radius: 1.0 }) // Make a body (is dynamic by default)
        .insert(PhysicMaterial {
            restitution: 0.5, // Define the restitution. Higher value means more "bouncy"
            density: 2.0, // Define the density. Higher value means heavier.
            friction: 0.5, // Define the friction. Higher value means higher friction.
        });
}

Fields

restitution: f32

Coefficient of restitution. Affect how much it “bounces” when colliding with other objects.

The higher the value, the more “bouncy”.

Typical values are between 0 (perfectly inelastic) and 1 (perfectly elastic)

density: f32

Density. It affects how much the body resists forces.

The higher the value, the heavier.

Value must be greater than 0. Except for sensor and static bodies, in which case the value is ignored.

friction: f32

Friction. It affects the relative motion of two bodies in contact.

The higher the value, the higher friction.

Typical values are between 0 (ideal) and 1 (max friction)

Implementations

impl PhysicMaterial

pub const PERFECTLY_INELASTIC_RESTITUTION: f32

Perfectly inelastic restitution coefficient, all kinematic energy is lost on collision. (Do not bounce at all)

pub const PERFECTLY_ELASTIC_RESTITUTION: f32

Perfectly elastic restitution coefficient, all kinematic energy is restated in movement. (Very bouncy)

Trait Implementations

impl Clone for PhysicMaterial

fn clone(&self) -> PhysicMaterial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PhysicMaterial

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

Formats the value using the given formatter.

impl Default for PhysicMaterial

fn default() -> Self

Returns the “default value” for a type.

impl GetTypeRegistration for PhysicMaterial

fn get_type_registration() -> TypeRegistration

impl PartialEq<PhysicMaterial> for PhysicMaterial

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

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

fn ne(&self, other: &PhysicMaterial) -> bool

This method tests for !=.

impl Reflect for PhysicMaterial

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 set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

fn apply(&mut self, value: &dyn Reflect)

fn reflect_ref(&self) -> ReflectRef<'_>

fn reflect_mut(&mut self) -> ReflectMut<'_>

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

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.

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.

impl Struct for PhysicMaterial

fn field(&self, name: &str) -> Option<&dyn Reflect>

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

fn name_at(&self, index: usize) -> Option<&str>

fn field_len(&self) -> usize

fn iter_fields(&self) -> FieldIter<'_>

fn clone_dynamic(&self) -> DynamicStruct

impl Copy for PhysicMaterial

impl StructuralPartialEq for PhysicMaterial