Skip to main content

Pose3

Struct Pose3 

Source
#[repr(C)]
pub struct Pose3 { pub rotation: Rot3, pub translation: Vec3, pub padding: u32, }
Expand description

A 3D pose (rotation + translation), representing a rigid body transformation (f32 precision).

Fields§

§rotation: Rot3

The rotational part of the pose.

§translation: Vec3

The translational part of the pose.

§padding: u32

Explicit padding for compatibility with bytemuck and targets like spirv.

Can have any value as it is never read from or written to.

Implementations§

Source§

impl Pose3

Source

pub const IDENTITY: Self

The identity pose (no rotation, no translation).

Source

pub fn identity() -> Self

Creates the identity pose.

Source

pub fn from_translation(translation: Vec3) -> Self

Creates a pose from a translation vector.

Source

pub fn translation(x: f32, y: f32, z: f32) -> Self

Creates a pose from translation components.

Source

pub fn from_rotation(rotation: Rot3) -> Self

Creates a pose from a rotation.

Source

pub fn from_parts(translation: Vec3, rotation: Rot3) -> Self

Creates a pose from translation and rotation parts.

Source

pub fn new(translation: Vec3, axisangle: Vec3) -> Self

Creates a pose from translation and axis-angle rotation.

Source

pub fn rotation(axisangle: Vec3) -> Self

Creates a pose from axis-angle rotation only (no translation).

Source

pub fn prepend_translation(self, translation: Vec3) -> Self

Prepends a translation to this pose (applies translation in local frame).

Source

pub fn append_translation(self, translation: Vec3) -> Self

Appends a translation to this pose (applies translation in world frame).

Source

pub fn inverse(&self) -> Self

Returns the inverse of this pose.

Source

pub fn inv_mul(&self, rhs: &Self) -> Self

Computes self.inverse() * rhs.

Source

pub fn transform_point(&self, p: Vec3) -> Vec3

Transforms a 3D point by this pose.

This applies both the rotation and translation.

Source

pub fn transform_vector(&self, v: Vec3) -> Vec3

Transforms a 3D vector by this pose.

This applies only the rotation (ignores translation).

Source

pub fn inverse_transform_point(&self, p: Vec3) -> Vec3

Transforms a point by the inverse of this pose.

Source

pub fn inverse_transform_vector(&self, v: Vec3) -> Vec3

Transforms a vector by the inverse of this pose.

Source

pub fn lerp(&self, other: &Self, t: f32) -> Self

Linearly interpolates between two poses.

Uses spherical linear interpolation for the rotation part.

Source

pub fn is_finite(&self) -> bool

Returns true if, and only if, all elements are finite.

Source

pub fn is_nan(&self) -> bool

Returns true if any element is NaN.

Source

pub fn to_mat4(&self) -> Mat4

Converts this pose to a homogeneous 4x4 matrix.

Source

pub fn from_mat4(mat: Mat4) -> Self

Creates a pose from a homogeneous 4x4 matrix.

The matrix is assumed to represent a rigid body transformation (rotation + translation only, no scaling or shearing).

Source

pub fn look_at_rh(eye: Vec3, target: Vec3, up: Vec3) -> Pose3

Builds a right-handed look-at view matrix.

It maps the view direction target - eye to the negative z axis to and the eye to the origin. This conforms to the common notion of right-handed camera look-at view matrix from the computer graphics community, i.e. the camera is assumed to look toward its local -z axis.

§Arguments
  • eye: The eye position.
  • target: The target position.
  • up: A vector approximately aligned with required the vertical axis. The only requirement of this parameter is to not be collinear to target - eye.
Source

pub fn face_towards(eye: Vec3, target: Vec3, up: Vec3) -> Pose3

Creates a pose that corresponds to the local frame of an observer standing at the point eye and looking toward target.

It maps the z axis to the view direction target - eye and the origin to the eye.

§Arguments
  • eye: The observer position.
  • target: The target position.
  • up: Vertical direction. The only requirement of this parameter is to not be collinear to eye - at. Non-collinearity is not checked.

Trait Implementations§

Source§

impl AbsDiffEq for Pose3

Available on crate feature approx only.
Source§

type Epsilon = f32

Used for specifying relative comparisons.
Source§

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together. Read more
Source§

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.
Source§

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.
Source§

impl Clone for Pose3

Source§

fn clone(&self) -> Pose3

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Pose3

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Pose3

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<DPose3> for Pose3

Source§

fn from(p: DPose3) -> Self

Converts to this type from the input type.
Source§

impl From<Pose3> for DPose3

Source§

fn from(p: Pose3) -> Self

Converts to this type from the input type.
Source§

impl From<Pose3> for Pose3A

Source§

fn from(p: Pose3) -> Self

Converts to this type from the input type.
Source§

impl From<Pose3A> for Pose3

Source§

fn from(p: Pose3A) -> Self

Converts to this type from the input type.
Source§

impl From<Quat> for Pose3

Source§

fn from(rotation: Rot3) -> Self

Converts to this type from the input type.
Source§

impl Mul<&Pose3> for &Pose3

Source§

type Output = Pose3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &Pose3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul<&Pose3> for Pose3

Source§

type Output = Pose3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &Pose3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul<&Vec3> for Pose3

Source§

type Output = Vec3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &Vec3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul<Pose3> for &Pose3

Source§

type Output = Pose3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Pose3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul<Pose3> for Rot3

Source§

type Output = Pose3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Pose3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul<Quat> for Pose3

Source§

type Output = Pose3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Rot3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul<Vec3> for &Pose3

Source§

type Output = Vec3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Vec3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul<Vec3> for Pose3

Source§

type Output = Vec3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Vec3) -> Self::Output

Performs the * operation. Read more
Source§

impl Mul for Pose3

Source§

type Output = Pose3

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation. Read more
Source§

impl MulAssign<Quat> for Pose3

Source§

fn mul_assign(&mut self, rhs: Rot3)

Performs the *= operation. Read more
Source§

impl MulAssign for Pose3

Source§

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation. Read more
Source§

impl PartialEq for Pose3

Source§

fn eq(&self, other: &Pose3) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RelativeEq for Pose3

Available on crate feature approx only.
Source§

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart. Read more
Source§

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.
Source§

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.
Source§

impl Copy for Pose3

Source§

impl StructuralPartialEq for Pose3

Auto Trait Implementations§

§

impl Freeze for Pose3

§

impl RefUnwindSafe for Pose3

§

impl Send for Pose3

§

impl Sync for Pose3

§

impl Unpin for Pose3

§

impl UnsafeUnpin for Pose3

§

impl UnwindSafe for Pose3

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, Right> ClosedMul<Right> for T
where T: Mul<Right, Output = T> + MulAssign<Right>,

Source§

impl<T, Right> ClosedMulAssign<Right> for T
where T: ClosedMul<Right> + MulAssign<Right>,