Struct 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.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

fn on_add() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

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(value: u8) -> Self

Converts to this type from the input type.

impl FromReflect for LockedAxes

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

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

where LockedAxes: Any + Send + Sync, u8: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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 reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

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

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for LockedAxes

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

where LockedAxes: Any + Send + Sync, u8: 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 to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

fn clone_dynamic(&self) -> DynamicTupleStruct

👎Deprecated since 0.16.0: use to_dynamic_tuple_struct instead

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 LockedAxes

where LockedAxes: 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 LockedAxes: Any + Send + Sync, u8: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for LockedAxes