Struct avian3d::position::Rotation

pub struct Rotation(pub Quaternion);

The global physics rotation of a rigid body or a collider.

Relation to Transform and GlobalTransform

Rotation is used for physics internally and kept in sync with Transform by the SyncPlugin. It rarely needs to be used directly in your own code, as Transform can still be used for almost everything. Using Rotation should only be required for managing rotations in systems running in the SubstepSchedule, but if you prefer, you can also use Rotation for everything.

The reasons why the engine uses a separate Rotation component can be found here.

Example

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

fn setup(mut commands: Commands) {
    // Spawn a dynamic rigid body rotated by 1.5 radians around the x axis
    commands.spawn((RigidBody::Dynamic, Rotation(Quat::from_rotation_x(1.5))));
}

Tuple Fields

0: Quaternion

Implementations

impl Rotation

pub fn inverse(&self) -> Self

Inverts the rotation.

pub fn nlerp(self, end: Self, t: Scalar) -> Self

Performs a linear interpolation between self and end based on the value s, and normalizes the rotation afterwards.

When s == 0.0, the result will be equal to self. When s == 1.0, the result will be equal to end.

This is slightly more efficient than slerp, and produces a similar result when the difference between the two rotations is small. At larger differences, the result resembles a kind of ease-in-out effect.

If you would like the angular velocity to remain constant, consider using slerp instead.

pub fn slerp(self, end: Self, t: Scalar) -> Self

Performs a spherical linear interpolation between self and end based on the value s.

This corresponds to interpolating between the two angles at a constant angular velocity.

When s == 0.0, the result will be equal to self. When s == 1.0, the result will be equal to end.

If you would like the rotation to have a kind of ease-in-out effect, consider using the slightly more efficient nlerp instead.

Methods from Deref<Target = Quaternion>

pub const IDENTITY: Quat = _

pub const NAN: Quat = _

pub fn to_array(&self) -> [f32; 4]

[x, y, z, w]

Trait Implementations

impl Clone for Rotation

fn clone(&self) -> Rotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Rotation

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 Rotation

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

Formats the value using the given formatter.

impl Default for Rotation

fn default() -> Rotation

Returns the “default value” for a type.

impl Deref for Rotation

type Target = Quat

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Rotation

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<&GlobalTransform> for Rotation

fn from(value: &GlobalTransform) -> Self

Converts to this type from the input type.

impl From<DQuat> for Rotation

fn from(quat: DQuat) -> Self

Converts to this type from the input type.

impl From<GlobalTransform> for Rotation

fn from(value: GlobalTransform) -> Self

Converts to this type from the input type.

impl From<Quat> for Rotation

fn from(quat: Quat) -> Self

Converts to this type from the input type.

impl From<Rotation> for PreSolveRotation

fn from(original: Rotation) -> PreSolveRotation

Converts to this type from the input type.

impl From<Rotation> for Quaternion

fn from(rot: Rotation) -> Self

Converts to this type from the input type.

impl From<Transform> for Rotation

fn from(value: Transform) -> Self

Converts to this type from the input type.

impl FromReflect for Rotation

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

where Self: Any + Send + Sync, Quaternion: 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 Mul<&Dir3> for &Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: &Dir3) -> Self::Output

Performs the * operation.

impl Mul<&Dir3> for &mut Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: &Dir3) -> Self::Output

Performs the * operation.

impl Mul<&Dir3> for Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: &Dir3) -> Self::Output

Performs the * operation.

impl Mul<&Vec3> for &Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: &Vector) -> Self::Output

Performs the * operation.

impl Mul<&Vec3> for &mut Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: &Vector) -> Self::Output

Performs the * operation.

impl Mul<&Vec3> for Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: &Vector) -> Self::Output

Performs the * operation.

impl Mul<&mut Dir3> for &Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: &mut Dir3) -> Self::Output

Performs the * operation.

impl Mul<&mut Dir3> for &mut Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: &mut Dir3) -> Self::Output

Performs the * operation.

impl Mul<&mut Dir3> for Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: &mut Dir3) -> Self::Output

Performs the * operation.

impl Mul<&mut Vec3> for &Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: &mut Vector) -> Self::Output

Performs the * operation.

impl Mul<&mut Vec3> for &mut Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: &mut Vector) -> Self::Output

Performs the * operation.

impl Mul<&mut Vec3> for Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: &mut Vector) -> Self::Output

Performs the * operation.

impl Mul<Dir3> for &Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: Dir3) -> Self::Output

Performs the * operation.

impl Mul<Dir3> for &mut Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: Dir3) -> Self::Output

Performs the * operation.

impl Mul<Dir3> for Rotation

type Output = Dir3

The resulting type after applying the * operator.

fn mul(self, direction: Dir3) -> Self::Output

Performs the * operation.

impl Mul<Vec3> for &Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: Vector) -> Self::Output

Performs the * operation.

impl Mul<Vec3> for &mut Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: Vector) -> Self::Output

Performs the * operation.

impl Mul<Vec3> for Rotation

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vector: Vector) -> Self::Output

Performs the * operation.

impl PartialEq for Rotation

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

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

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

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 Rotation

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

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Rotation

impl StructuralPartialEq for Rotation