Struct vek::transform::repr_c::Transform

pub struct Transform<P, O, S> {
    pub position: Vec3<P>,
    pub orientation: Quaternion<O>,
    pub scale: Vec3<S>,
}

A convenient position + orientation + scale container, backed by two Vec3 and a Quaternion.

It can be easily interpolated and converted to a Mat4 of any layout.

let (p, rz, s) = (Vec3::unit_x(), 3.0_f32, 5.0_f32);
let a = Mat4::scaling_3d(s).rotated_z(rz).translated_3d(p);
let b = Mat4::from(Transform {
    position: p, 
    orientation: Quaternion::rotation_z(rz),
    scale: Vec3::broadcast(s),
});
assert_relative_eq!(a, b);

Fields

position: Vec3<P>

Local position.

orientation: Quaternion<O>

Local orientation; It is not named rotation because rotation denotes an operation, but not a current state.

scale: Vec3<S>

Local scale.

Trait Implementations

impl<P: Clone, O: Clone, S: Clone> Clone for Transform<P, O, S>

fn clone(&self) -> Transform<P, O, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Copy, O: Copy, S: Copy> Copy for Transform<P, O, S>

impl<P: Debug, O: Debug, S: Debug> Debug for Transform<P, O, S>

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

Formats the value using the given formatter.

impl<P: Zero, O: Zero + One, S: One> Default for Transform<P, O, S>

The default Transform has a zero position, identity orientation and unit scale.

let a = Transform {
    position: Vec3::<f32>::zero(),
    orientation: Quaternion::<f32>::identity(),
    scale: Vec3::<f32>::one(),
};
assert_eq!(a, Transform::default());

fn default() -> Self

Returns the "default value" for a type.

impl<'de, P, O, S> Deserialize<'de> for Transform<P, O, S> where
    P: Deserialize<'de>,
    O: Deserialize<'de>,
    S: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<P: Eq, O: Eq, S: Eq> Eq for Transform<P, O, S>

impl<T> From<Transform<T, T, T>> for Mat4<T> where
    T: Real + MulAdd<T, T, Output = T>, 

A Mat4 can be obtained from a Transform, by rotating, then scaling, then translating.

fn from(xform: Transform<T, T, T>) -> Self

Performs the conversion.

impl<T> From<Transform<T, T, T>> for Mat4<T> where
    T: Real + MulAdd<T, T, Output = T>, 

A Mat4 can be obtained from a Transform, by rotating, then scaling, then translating.

fn from(xform: Transform<T, T, T>) -> Self

Performs the conversion.

impl<P: Hash, O: Hash, S: Hash> Hash for Transform<P, O, S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<P, O, S, Factor> Lerp<Factor> for Transform<P, O, S> where
    Factor: Copy + Into<O>,
    P: Lerp<Factor, Output = P>,
    S: Lerp<Factor, Output = S>,
    O: Lerp<O, Output = O> + Real + Add<Output = O>, 

LERP on a Transform is defined as LERP-ing between the positions and scales, and performing SLERP between the orientations.

type Output = Self

The resulting type after performing the LERP operation.

fn lerp_unclamped(a: Self, b: Self, t: Factor) -> Self

Returns the linear interpolation of from to to with factor unconstrained, using the supposedly fastest but less precise implementation.

fn lerp_unclamped_precise(a: Self, b: Self, t: Factor) -> Self

Returns the linear interpolation of from to to with factor unconstrained, using a possibly slower but more precise operation.

fn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped which constrains factor to be between 0 and 1 (inclusive).

fn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped_precise which constrains factor to be between 0 and 1 (inclusive).

impl<'a, P, O, S, Factor> Lerp<Factor> for &'a Transform<P, O, S> where
    Factor: Copy + Into<O>,
    &'a P: Lerp<Factor, Output = P>,
    &'a S: Lerp<Factor, Output = S>,
    O: Lerp<O, Output = O> + Real + Add<Output = O>, 

LERP on a Transform is defined as LERP-ing between the positions and scales, and performing SLERP between the orientations.

type Output = Transform<P, O, S>

The resulting type after performing the LERP operation.

fn lerp_unclamped(a: Self, b: Self, t: Factor) -> Self::Output

Returns the linear interpolation of from to to with factor unconstrained, using the supposedly fastest but less precise implementation.

fn lerp_unclamped_precise(a: Self, b: Self, t: Factor) -> Self::Output

Returns the linear interpolation of from to to with factor unconstrained, using a possibly slower but more precise operation.

fn lerp(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped which constrains factor to be between 0 and 1 (inclusive).

fn lerp_precise(from: Self, to: Self, factor: Factor) -> Self::Output where
    Factor: Clamp + Zero + One, 

Alias to lerp_unclamped_precise which constrains factor to be between 0 and 1 (inclusive).

impl<P: PartialEq, O: PartialEq, S: PartialEq> PartialEq<Transform<P, O, S>> for Transform<P, O, S>

fn eq(&self, other: &Transform<P, O, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Transform<P, O, S>) -> bool

This method tests for !=.

impl<P, O, S> Serialize for Transform<P, O, S> where
    P: Serialize,
    O: Serialize,
    S: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<P, O, S> StructuralEq for Transform<P, O, S>

impl<P, O, S> StructuralPartialEq for Transform<P, O, S>