Struct avian3d::dynamics::rigid_body::ColliderMassProperties

pub struct ColliderMassProperties {
    pub mass: Mass,
    pub inverse_mass: InverseMass,
    pub inertia: Inertia,
    pub inverse_inertia: InverseInertia,
    pub center_of_mass: CenterOfMass,
}

An automatically added component that contains the read-only mass properties of a Collider. The density used for computing the mass properties can be configured using the ColliderDensity component.

These mass properties will be added to the rigid body’s actual Mass, InverseMass, Inertia, InverseInertia and CenterOfMass components.

Example

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

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, PhysicsPlugins::default()))
        .add_systems(Startup, setup)
        .add_systems(Update, print_collider_masses)
        .run();
}

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

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

Fields

mass: Mass

Mass given by collider.

inverse_mass: InverseMass

Inverse mass given by collider.

inertia: Inertia

Inertia given by collider.

inverse_inertia: InverseInertia

Inverse inertia given by collider.

center_of_mass: CenterOfMass

Local center of mass given by collider.

Implementations

impl ColliderMassProperties

pub const ZERO: Self = _

The collider has no mass.

pub fn new<C: AnyCollider>(collider: &C, density: Scalar) -> Self

Computes mass properties from a given collider and density.

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

pub fn transformed_by(self, transform: &ColliderTransform) -> Self

Transforms the center of mass by the given ColliderTransform.

Trait Implementations

impl<'w> AddAssign<ColliderMassProperties> for MassPropertiesQueryItem<'w>

fn add_assign(&mut self, rhs: ColliderMassProperties)

Performs the += operation.

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_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() -> Self

Returns the “default value” for a type.

impl FromReflect for ColliderMassProperties

where Self: Any + Send + Sync, Mass: FromReflect + TypePath + RegisterForReflection, InverseMass: FromReflect + TypePath + RegisterForReflection, Inertia: FromReflect + TypePath + RegisterForReflection, InverseInertia: FromReflect + TypePath + RegisterForReflection, CenterOfMass: 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 ColliderMassProperties

where Self: Any + Send + Sync, Mass: FromReflect + TypePath + RegisterForReflection, InverseMass: FromReflect + TypePath + RegisterForReflection, Inertia: FromReflect + TypePath + RegisterForReflection, InverseInertia: FromReflect + TypePath + RegisterForReflection, CenterOfMass: 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 ColliderMassProperties

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

where Self: Any + Send + Sync, Mass: FromReflect + TypePath + RegisterForReflection, InverseMass: FromReflect + TypePath + RegisterForReflection, Inertia: FromReflect + TypePath + RegisterForReflection, InverseInertia: FromReflect + TypePath + RegisterForReflection, CenterOfMass: 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 ColliderMassProperties

where Self: Any + Send + Sync, Mass: FromReflect + TypePath + RegisterForReflection, InverseMass: FromReflect + TypePath + RegisterForReflection, Inertia: FromReflect + TypePath + RegisterForReflection, InverseInertia: FromReflect + TypePath + RegisterForReflection, CenterOfMass: 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<'w> SubAssign<ColliderMassProperties> for MassPropertiesQueryItem<'w>

fn sub_assign(&mut self, rhs: ColliderMassProperties)

Performs the -= operation.

impl TypePath for ColliderMassProperties

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 ColliderMassProperties

where Self: Any + Send + Sync, Mass: FromReflect + TypePath + RegisterForReflection, InverseMass: FromReflect + TypePath + RegisterForReflection, Inertia: FromReflect + TypePath + RegisterForReflection, InverseInertia: FromReflect + TypePath + RegisterForReflection, CenterOfMass: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for ColliderMassProperties

impl StructuralPartialEq for ColliderMassProperties