Struct bevy_xpbd_3d::components::Friction

pub struct Friction {
    pub dynamic_coefficient: Scalar,
    pub static_coefficient: Scalar,
    pub combine_rule: CoefficientCombine,
}

Controls how strongly the material of an entity prevents relative tangential movement at contact points.

For surfaces that are at rest relative to each other, static friction is used. Once the static friction is overcome, the bodies will start sliding relative to each other, and dynamic friction is applied instead.

0.0: No friction at all, the body slides indefinitely
1.0: High friction

Example

Create a new Friction component with dynamic and static friction coefficients of 0.4:

Friction::new(0.4)

Set the other friction coefficient:

// 0.4 static and 0.6 dynamic
Friction::new(0.4).with_dynamic_coefficient(0.6)
// 0.4 dynamic and 0.6 static
Friction::new(0.4).with_static_coefficient(0.6)

Configure how the friction coefficients of two Friction components are combined with CoefficientCombine:

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

Combine the properties of two Friction components:

use bevy_xpbd_3d::prelude::*;

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

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

Fields

dynamic_coefficient: Scalar

Coefficient of dynamic friction.

static_coefficient: Scalar

Coefficient of static friction.

combine_rule: CoefficientCombine

The coefficient combine rule used when two bodies collide.

Implementations

impl Friction

pub const ZERO: Self = _

Zero dynamic and static friction and CoefficientCombine::Average.

pub fn new(friction_coefficient: Scalar) -> Self

Creates a new Friction component with the same dynamic and static friction coefficients.

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

Sets the CoefficientCombine rule used.

pub fn with_dynamic_coefficient(&self, coefficient: Scalar) -> Self

Sets the coefficient of dynamic friction.

pub fn with_static_coefficient(&self, coefficient: Scalar) -> Self

Sets the coefficient of static friction.

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

Combines the properties of two Friction components.

Trait Implementations

impl Clone for Friction

fn clone(&self) -> Friction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Friction

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for Friction

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

Formats the value using the given formatter.

impl Default for Friction

fn default() -> Self

Returns the “default value” for a type.

impl From<f32> for Friction

fn from(coefficient: Scalar) -> Self

Converts to this type from the input type.

impl FromReflect for Friction

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

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 Friction

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

fn get_type_registration() -> TypeRegistration

impl PartialEq for Friction

fn eq(&self, other: &Friction) -> 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 Friction

fn partial_cmp(&self, other: &Friction) -> 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 Friction

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

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

Applies 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 reflect_hash(&self) -> Option<u64>

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

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

Debug formatter for the value.

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 Friction

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

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 Friction

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 Friction

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Friction

impl StructuralPartialEq for Friction