Struct GlobalAngularInertia

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

The total world-space angular inertia computed for a dynamic rigid body, taking into account colliders and descendants.

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

This component is updated automatically whenever the local ComputedAngularInertia or rotation is changed. To manually update it, use the associated update method.

Implementations

impl GlobalAngularInertia

pub fn new( local_angular_inertia: impl Into<ComputedAngularInertia>, rotation: impl Into<Quaternion>, ) -> Self

Creates a new GlobalAngularInertia from the given local angular inertia and rotation.

pub fn update( &mut self, local_angular_inertia: impl Into<ComputedAngularInertia>, rotation: impl Into<Quaternion>, )

Updates the global angular inertia with the given local angular inertia and rotation.

Methods from Deref<Target = ComputedAngularInertia>

pub const INFINITY: Self = _

pub fn principal_angular_inertia_with_local_frame(&self) -> (Vector, Quaternion)

Computes the principal angular inertia and local inertial frame by diagonalizing the 3x3 tensor matrix.

The principal angular inertia represents the torque needed for a desired angular acceleration about the local coordinate axes defined by the local inertial frame.

pub fn shifted_tensor(&self, mass: Scalar, offset: Vector) -> Matrix3

Computes the angular inertia tensor shifted by the given offset, taking into account the given mass.

pub fn shifted_inverse_tensor(&self, mass: Scalar, offset: Vector) -> Matrix3

Computes the inverse angular inertia tensor shifted by the given offset, taking into account the given mass.

Trait Implementations

impl Clone for GlobalAngularInertia

fn clone(&self) -> GlobalAngularInertia

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for GlobalAngularInertia

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 GlobalAngularInertia

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

Formats the value using the given formatter.

impl Default for GlobalAngularInertia

fn default() -> GlobalAngularInertia

Returns the “default value” for a type.

impl Deref for GlobalAngularInertia

type Target = ComputedAngularInertia

The resulting type after dereferencing.

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

Dereferences the value.

impl From<ComputedAngularInertia> for GlobalAngularInertia

fn from(value: ComputedAngularInertia) -> Self

Converts to this type from the input type.

impl From<GlobalAngularInertia> for ComputedAngularInertia

fn from(inertia: GlobalAngularInertia) -> Self

Converts to this type from the input type.

impl From<Mat3> for GlobalAngularInertia

fn from(tensor: Matrix) -> Self

Converts to this type from the input type.

impl FromReflect for GlobalAngularInertia

where GlobalAngularInertia: Any + Send + Sync, ComputedAngularInertia: 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 GlobalAngularInertia

where GlobalAngularInertia: Any + Send + Sync, ComputedAngularInertia: 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 GlobalAngularInertia

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

where GlobalAngularInertia: Any + Send + Sync, ComputedAngularInertia: 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 GlobalAngularInertia

where GlobalAngularInertia: Any + Send + Sync, ComputedAngularInertia: 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 GlobalAngularInertia

where GlobalAngularInertia: Any + Send + Sync, ComputedAngularInertia: 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 GlobalAngularInertia

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

where GlobalAngularInertia: Any + Send + Sync, ComputedAngularInertia: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for GlobalAngularInertia

impl StructuralPartialEq for GlobalAngularInertia