Struct avian3d::dynamics::rigid_body::LockedAxes

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

A component that specifies which translational and rotational axes of a rigid body are locked.

The axes are represented using a total of six bits, one for each axis. The easiest way to lock or unlock specific axes is to use methods like lock_translation_x, but you can also use bits directly with the from_bits and to_bits methods.

Example

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

fn spawn(mut commands: Commands) {
    commands.spawn((
        RigidBody::Dynamic,
        Collider::capsule(0.5, 1.0),
        LockedAxes::new().lock_rotation_z(),
    ));
}

Implementations

impl LockedAxes

pub const TRANSLATION_LOCKED: Self = _

All translational axes are locked, but all rotational axes are unlocked.

pub const ROTATION_LOCKED: Self = _

All rotational axes are locked, but all translational axes are unlocked.

pub const ALL_LOCKED: Self = _

All translational and rotational axes are locked.

pub const fn new() -> Self

Creates a new LockedAxes configuration with all axes unlocked by default.

pub const fn from_bits(bits: u8) -> Self

Creates a new LockedAxes configuration using bits.

The first three bits correspond to translational axes, while the last three bits correspond to rotational axes. For example, 0b100_010 would lock translation along the X axis and rotation around the Y axis.

pub const fn to_bits(&self) -> u8

Returns the locked axes as bits.

The first three bits correspond to translational axes, while the last three bits correspond to rotational axes. For example, 0b100_010 would mean that translation along the X axis and rotation around the Y axis are locked.

pub const fn lock_translation_x(self) -> Self

Locks translation along the X axis.

pub const fn lock_translation_y(self) -> Self

Locks translation along the Y axis.

pub const fn lock_translation_z(self) -> Self

Locks translation along the Z axis.

pub const fn lock_rotation_x(self) -> Self

Locks rotation around the X axis.

pub const fn lock_rotation_y(self) -> Self

Locks rotation around the Y axis.

pub const fn lock_rotation_z(self) -> Self

Locks rotation around the Z axis.

pub const fn unlock_translation_x(self) -> Self

Unlocks translation along the X axis.

pub const fn unlock_translation_y(self) -> Self

Unlocks translation along the Y axis.

pub const fn unlock_translation_z(self) -> Self

Unlocks translation along the Z axis.

pub const fn unlock_rotation_x(self) -> Self

Unlocks rotation around the X axis.

pub const fn unlock_rotation_y(self) -> Self

Unlocks rotation around the Y axis.

pub const fn unlock_rotation_z(self) -> Self

Unlocks rotation around the Z axis.

pub const fn is_translation_x_locked(&self) -> bool

Returns true if translation is locked along the X axis.

pub const fn is_translation_y_locked(&self) -> bool

Returns true if translation is locked along the X axis.

pub const fn is_translation_z_locked(&self) -> bool

Returns true if translation is locked along the X axis.

pub const fn is_rotation_x_locked(&self) -> bool

Returns true if rotation is locked around the X axis.

pub const fn is_rotation_y_locked(&self) -> bool

Returns true if rotation is locked around the Y axis.

pub const fn is_rotation_z_locked(&self) -> bool

Returns true if rotation is locked around the Z axis.

Trait Implementations

impl Clone for LockedAxes

fn clone(&self) -> LockedAxes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for LockedAxes

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 LockedAxes

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

Formats the value using the given formatter.

impl Default for LockedAxes

fn default() -> LockedAxes

Returns the “default value” for a type.

impl From<u8> for LockedAxes

fn from(original: u8) -> LockedAxes

Converts to this type from the input type.

impl FromReflect for LockedAxes

where Self: Any + Send + Sync, u8: 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 LockedAxes

where Self: Any + Send + Sync, u8: 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 Reflect for LockedAxes

where Self: Any + Send + Sync, u8: 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 TupleStruct for LockedAxes

where Self: Any + Send + Sync, u8: FromReflect + TypePath + RegisterForReflection,

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

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 Reflect>

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.

impl TypePath for LockedAxes

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 LockedAxes

where Self: Any + Send + Sync, u8: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for LockedAxes