Struct ColliderMassProperties

pub struct ColliderMassProperties(/* private fields */);

A read-only component for the mass properties of a Collider. Computed automatically from the collider’s shape and ColliderDensity.

If the entity has the Mass, AngularInertia, or CenterOfMass components, they will be used instead when updating the associated rigid body’s ComputedMass, ComputedAngularInertia, and ComputedCenterOfMass components respectively.

Example

use avian3d::prelude::*;
use bevy::prelude::*;

fn setup(mut commands: Commands) {
    commands.spawn((RigidBody::Dynamic, Collider::sphere(0.5)));
}

fn print_collider_masses(query: Query<&ColliderMassProperties>) {
    for mass_properties in &query {
        println!("{}", mass_properties.mass);
    }
}

Implementations

impl ColliderMassProperties

pub const ZERO: Self = _

The collider has no mass.

pub fn from_shape<T: ComputeMassProperties>(shape: &T, density: f32) -> Self

Computes mass properties from a given shape and density.

Because ColliderMassProperties is intended to be read-only, adding this as a component manually has no effect. The mass properties will be recomputed using the ColliderDensity.

pub fn from_collider<C: AnyCollider>(collider: &C, density: f32) -> Self

👎Deprecated since 0.2.0: Use from_shape instead

Computes mass properties from a given collider and density.

Because ColliderMassProperties is intended to be read-only, adding this as a component manually has no effect. The mass properties will be recomputed using the ColliderDensity.

Methods from Deref<Target = MassProperties>

pub const ZERO: MassProperties3d = _

pub fn global_center_of_mass(&self, isometry: impl Into<Isometry3d>) -> Vec3

Returns the center of mass transformed into global space using the given isometry.

pub fn unit_principal_angular_inertia(&self) -> Vec3

Computes the principal angular inertia corresponding to a mass of 1.0.

If the mass is zero, a zero vector is returned.

pub fn unit_angular_inertia_tensor(&self) -> AngularInertiaTensor

Computes the world-space angular inertia tensor corresponding to a mass of 1.0.

If the mass is zero, a zero tensor is returned.

pub fn angular_inertia_tensor(&self) -> AngularInertiaTensor

Computes the world-space angular inertia tensor from the principal inertia.

pub fn shifted_angular_inertia_tensor( &self, offset: Vec3, ) -> AngularInertiaTensor

Computes the angular inertia tensor at a given offset.

pub fn global_angular_inertia_tensor( &self, rotation: Quat, ) -> AngularInertiaTensor

Computes the world-space inverse angular inertia tensor with the square root of each element.

pub fn inverse(&self) -> MassProperties3d

Returns the mass propeorties with the inverse of mass and principal angular inertia.

The center of mass and local inertial frame are left unchanged.

Trait Implementations

impl Clone for ColliderMassProperties

fn clone(&self) -> ColliderMassProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ColliderMassProperties

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 ColliderMassProperties

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

Formats the value using the given formatter.

impl Default for ColliderMassProperties

fn default() -> ColliderMassProperties

Returns the “default value” for a type.

impl Deref for ColliderMassProperties

type Target = MassProperties3d

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<MassProperties3d> for ColliderMassProperties

fn from(value: MassProperties) -> Self

Converts to this type from the input type.

impl FromReflect for ColliderMassProperties

where ColliderMassProperties: Any + Send + Sync, MassProperties: 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 ColliderMassProperties

where ColliderMassProperties: Any + Send + Sync, MassProperties: 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 ColliderMassProperties

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

where ColliderMassProperties: Any + Send + Sync, MassProperties: 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 ColliderMassProperties

where ColliderMassProperties: Any + Send + Sync, MassProperties: 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 TupleStruct for ColliderMassProperties

where ColliderMassProperties: Any + Send + Sync, MassProperties: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

fn field_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 Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

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

Returns an iterator over the values of the tuple struct’s fields.

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for ColliderMassProperties

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

where ColliderMassProperties: Any + Send + Sync, MassProperties: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ColliderMassProperties

impl StructuralPartialEq for ColliderMassProperties