Struct ComputedMass

pub struct ComputedMass { /* private fields */ }

The total mass computed for a dynamic rigid body, taking into account colliders and descendants. Represents resistance to linear acceleration.

The total mass is computed as the sum of the masses of all attached colliders and the mass of the rigid body entity itself. The mass of an entity is determined by its Mass component, or if it is not present, from an attached Collider based on its shape and ColliderDensity.

A total mass of zero is a special case, and is interpreted as infinite mass, meaning the rigid body will not be affected by any forces.

Representation

Internally, the total mass is actually stored as the inverse mass 1.0 / mass. This is because most physics calculations operate on the inverse mass, and storing it directly allows for fewer divisions and guards against division by zero.

When using ComputedMass, you shouldn’t need to worry about this internal representation. The provided constructors and getters abstract away the implementation details.

In terms of performance, the main thing to keep in mind is that inverse is a no-op and value contains a division. When dividing by the mass, it’s better to use foo * mass.inverse() than foo / mass.value().

Related Types

• Mass can be used to set the mass associated with an individual entity.
• ComputedAngularInertia stores the total angular inertia of a rigid body, taking into account colliders and descendants.
• ComputedCenterOfMass stores the total center of mass of a rigid body, taking into account colliders and descendants.
• MassPropertyHelper is a SystemParam with utilities for computing and updating mass properties.

Implementations

impl ComputedMass

pub const INFINITY: Self = _

Infinite mass.

pub fn new(mass: Scalar) -> Self

Creates a new ComputedMass from the given mass.

Panics

Panics if the mass is negative or NaN when debug_assertions are enabled.

pub fn try_new(mass: Scalar) -> Result<Self, MassError>

Tries to create a new ComputedMass from the given mass.

Errors

Returns Err(MassError) if the mass is negative or NaN.

pub fn from_inverse(inverse_mass: Scalar) -> Self

Creates a new ComputedMass from the given inverse mass.

Panics

Panics if the inverse mass is negative or NaN when debug_assertions are enabled.

pub fn try_from_inverse(inverse_mass: Scalar) -> Result<Self, MassError>

Tries to create a new ComputedMass from the given inverse mass.

Errors

Returns Err(MassError) if the inverse mass is negative or NaN.

pub fn value(self) -> Scalar

Returns the mass. If it is infinite, returns zero.

Note that this involves a division because ComputedMass internally stores the inverse mass. If dividing by the mass, consider using foo * mass.inverse() instead of foo / mass.value().

pub fn inverse(self) -> Scalar

Returns the inverse mass.

This is a no-op because ComputedMass internally stores the inverse mass.

pub fn set(&mut self, mass: impl Into<ComputedMass>)

Sets the mass.

pub fn is_finite(self) -> bool

Returns true if the mass is neither infinite nor NaN.

pub fn is_infinite(self) -> bool

Returns true if the mass is positive infinity or negative infinity.

pub fn is_nan(self) -> bool

Returns true if the mass is NaN.

Trait Implementations

impl Clone for ComputedMass

fn clone(&self) -> ComputedMass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ComputedMass

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_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

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

impl Debug for ComputedMass

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

Formats the value using the given formatter.

impl Default for ComputedMass

fn default() -> ComputedMass

Returns the “default value” for a type.

impl From<ComputedMass> for Mass

fn from(mass: ComputedMass) -> Self

Converts to this type from the input type.

impl From<Mass> for ComputedMass

fn from(mass: Mass) -> Self

Converts to this type from the input type.

impl From<f32> for ComputedMass

fn from(mass: Scalar) -> Self

Converts to this type from the input type.

impl FromReflect for ComputedMass

where ComputedMass: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for ComputedMass

where ComputedMass: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + 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 ComputedMass

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialReflect for ComputedMass

where ComputedMass: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> 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 PartialReflect + '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 Reflect for ComputedMass

where ComputedMass: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Struct for ComputedMass

where ComputedMass: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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

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

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

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

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

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

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.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for ComputedMass

where ComputedMass: 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 ComputedMass

where ComputedMass: Any + Send + Sync, Scalar: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ComputedMass

impl StructuralPartialEq for ComputedMass