Struct pixel_game_lib::Transform

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

Re-export vek types. 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, O, S> Clone for Transform<P, O, S>

where P: Clone, O: Clone, S: Clone,

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, O, S> Debug for Transform<P, O, S>

where P: Debug, O: Debug, S: Debug,

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

Formats the value using the given formatter.

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

where P: Zero, O: Zero + One, S: One,

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() -> Transform<P, O, S>

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<Transform<P, O, S>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<Transform<T, T, T>> for Mat4<T>

where T: Real + MulAdd<Output = T>,

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

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

Converts to this type from the input type.

impl<T> From<Transform<T, T, T>> for Mat4<T>

where T: Real + MulAdd<Output = T>,

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

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

Converts to this type from the input type.

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

where P: Hash, O: Hash, S: Hash,

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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<Output = O> + Add,

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: &'a Transform<P, O, S>, b: &'a Transform<P, O, S>, t: Factor ) -> <&'a Transform<P, O, S> as Lerp<Factor>>::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: &'a Transform<P, O, S>, b: &'a Transform<P, O, S>, t: Factor ) -> <&'a Transform<P, O, S> as Lerp<Factor>>::Output

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

fn lerp_unclamped_inclusive_range( range: RangeInclusive<Self>, factor: Factor ) -> Self::Output

Version of lerp_unclamped() that used a single RangeInclusive parameter instead of two values.

fn lerp_unclamped_precise_inclusive_range( range: RangeInclusive<Self>, factor: Factor ) -> Self::Output

Version of lerp_unclamped_precise() that used a single RangeInclusive parameter instead of two values.

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<Output = O> + Add,

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: Transform<P, O, S>, b: Transform<P, O, S>, t: Factor ) -> Transform<P, O, S>

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

fn lerp_unclamped_precise( a: Transform<P, O, S>, b: Transform<P, O, S>, t: Factor ) -> Transform<P, O, S>

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

fn lerp_unclamped_inclusive_range( range: RangeInclusive<Self>, factor: Factor ) -> Self::Output

Version of lerp_unclamped() that used a single RangeInclusive parameter instead of two values.

fn lerp_unclamped_precise_inclusive_range( range: RangeInclusive<Self>, factor: Factor ) -> Self::Output

Version of lerp_unclamped_precise() that used a single RangeInclusive parameter instead of two values.

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

where P: PartialEq, O: PartialEq, S: PartialEq,

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

where P: Copy, O: Copy, S: Copy,

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

where P: Eq, O: Eq, S: Eq,

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

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