Struct avian3d::dynamics::rigid_body::Restitution

pub struct Restitution {
    pub coefficient: Scalar,
    pub combine_rule: CoefficientCombine,
}

A component for the coefficient of restitution. This controls how bouncy a rigid body is.

The coefficient is between 0 and 1, where 0 corresponds to a perfectly inelastic collision, and 1 corresponds to a perfectly elastic collision that preserves all kinetic energy. The default coefficient is 0.3, and it currently can not be configured at a global level.

When two bodies collide, their restitution coefficients are combined using the specified CoefficientCombine rule.

Example

Create a new Restitution component with a restitution coefficient of 0.4:

Restitution::new(0.4)

Configure how two restitution coefficients are combined with CoefficientCombine:

Restitution::new(0.4).with_combine_rule(CoefficientCombine::Multiply)

Combine the properties of two Restitution components:

use avian3d::prelude::*;

let first = Restitution::new(0.8).with_combine_rule(CoefficientCombine::Average);
let second = Restitution::new(0.5).with_combine_rule(CoefficientCombine::Multiply);

// CoefficientCombine::Multiply has higher priority, so the coefficients are multiplied
assert_eq!(
    first.combine(second),
    Restitution::new(0.4).with_combine_rule(CoefficientCombine::Multiply)
);

Fields

coefficient: Scalar

The coefficient of restitution.

This should be between 0 and 1, where 0 corresponds to a perfectly inelastic collision, and 1 corresponds to a perfectly elastic collision that preserves all kinetic energy. The default value is 0.3.

combine_rule: CoefficientCombine

The coefficient combine rule used when two bodies collide.

Implementations

impl Restitution

pub const ZERO: Self = _

A restitution coefficient of 0.0 and a combine rule of CoefficientCombine::Average.

This is equivalent to Restitution::PERFECTLY_INELASTIC.

pub const PERFECTLY_INELASTIC: Self = _

A restitution coefficient of 0.0, which corresponds to a perfectly inelastic collision.

Uses CoefficientCombine::Average.

pub const PERFECTLY_ELASTIC: Self = _

A restitution coefficient of 1.0, which corresponds to a perfectly elastic collision.

Uses CoefficientCombine::Average.

pub fn new(coefficient: Scalar) -> Self

Creates a new Restitution component with the given restitution coefficient.

pub fn with_combine_rule(&self, combine_rule: CoefficientCombine) -> Self

Sets the CoefficientCombine rule used.

pub fn combine(&self, other: Self) -> Self

Combines the properties of two Restitution components.

Trait Implementations

impl Clone for Restitution

fn clone(&self) -> Restitution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Restitution

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for Restitution

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

Formats the value using the given formatter.

impl Default for Restitution

fn default() -> Self

Returns the “default value” for a type.

impl From<f32> for Restitution

fn from(coefficient: Scalar) -> Self

Converts to this type from the input type.

impl FromReflect for Restitution

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, CoefficientCombine: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Restitution

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, CoefficientCombine: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for Restitution

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Restitution

fn partial_cmp(&self, other: &Restitution) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Reflect for Restitution

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, CoefficientCombine: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

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

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for Restitution

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, CoefficientCombine: FromReflect + TypePath + RegisterForReflection,

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

Returns a reference to the value of the field named name as a &dyn Reflect.

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

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

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

Returns a reference to the value of the field with index index as a &dyn Reflect.

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

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for Restitution

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Restitution

where Self: Any + Send + Sync, Scalar: FromReflect + TypePath + RegisterForReflection, CoefficientCombine: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Restitution

impl StructuralPartialEq for Restitution