Struct euclid::TypedTransform3D

#[repr(C)]
pub struct TypedTransform3D<T, Src, Dst> {
    pub m11: T,
    pub m12: T,
    pub m13: T,
    pub m14: T,
    pub m21: T,
    pub m22: T,
    pub m23: T,
    pub m24: T,
    pub m31: T,
    pub m32: T,
    pub m33: T,
    pub m34: T,
    pub m41: T,
    pub m42: T,
    pub m43: T,
    pub m44: T,
    // some fields omitted
}

A 3d transform stored as a 4 by 4 matrix in row-major order in memory.

Transforms can be parametrized over the source and destination units, to describe a transformation from a space to another. For example, TypedTransform3D<f32, WordSpace, ScreenSpace>::transform_point3d takes a TypedPoint3D<f32, WordSpace> and returns a TypedPoint3D<f32, ScreenSpace>.

Transforms expose a set of convenience methods for pre- and post-transformations. A pre-transformation corresponds to adding an operation that is applied before the rest of the transformation, while a post-transformation adds an operation that is applied after.

Fields

m11: T

m12: T

m13: T

m14: T

m21: T

m22: T

m23: T

m24: T

m31: T

m32: T

m33: T

m34: T

m41: T

m42: T

m43: T

m44: T

Methods

impl<T, Src, Dst> TypedTransform3D<T, Src, Dst>

fn row_major(
    m11: T,
    m12: T,
    m13: T,
    m14: T,
    m21: T,
    m22: T,
    m23: T,
    m24: T,
    m31: T,
    m32: T,
    m33: T,
    m34: T,
    m41: T,
    m42: T,
    m43: T,
    m44: T
) -> Self

Create a transform specifying its components in row-major order.

For example, the translation terms m41, m42, m43 on the last row with the row-major convention) are the 13rd, 14th and 15th parameters.

fn column_major(
    m11: T,
    m21: T,
    m31: T,
    m41: T,
    m12: T,
    m22: T,
    m32: T,
    m42: T,
    m13: T,
    m23: T,
    m33: T,
    m43: T,
    m14: T,
    m24: T,
    m34: T,
    m44: T
) -> Self

Create a transform specifying its components in column-major order.

For example, the translation terms m41, m42, m43 on the last column with the column-major convention) are the 4th, 8th and 12nd parameters.

impl<T, Src, Dst> TypedTransform3D<T, Src, Dst> where
    T: Copy + Clone + PartialEq + One + Zero, 

fn identity() -> Self

impl<T, Src, Dst> TypedTransform3D<T, Src, Dst> where
    T: Copy + Clone + Add<T, Output = T> + Sub<T, Output = T> + Mul<T, Output = T> + Div<T, Output = T> + Neg<Output = T> + ApproxEq<T> + PartialOrd + Trig + One + Zero, 

fn row_major_2d(m11: T, m12: T, m21: T, m22: T, m41: T, m42: T) -> Self

Create a 4 by 4 transform representing a 2d transformation, specifying its components in row-major order.

fn ortho(left: T, right: T, bottom: T, top: T, near: T, far: T) -> Self

Create an orthogonal projection transform.

fn is_2d(&self) -> bool

Returns true if this transform can be represented with a TypedTransform2D.

See https://drafts.csswg.org/css-transforms/#2d-transform

fn to_2d(&self) -> TypedTransform2D<T, Src, Dst>

Create a 2D transform picking the relevent terms from this transform.

This method assumes that self represents a 2d transformation, callers should check that self.is_2d() returns true beforehand.

fn is_backface_visible(&self) -> bool

Check whether shapes on the XY plane with Z pointing towards the screen transformed by this matrix would be facing back.

fn approx_eq(&self, other: &Self) -> bool

fn with_destination<NewDst>(&self) -> TypedTransform3D<T, Src, NewDst>

Returns the same transform with a different destination unit.

fn with_source<NewSrc>(&self) -> TypedTransform3D<T, NewSrc, Dst>

Returns the same transform with a different source unit.

fn to_untyped(&self) -> Transform3D<T>

Drop the units, preserving only the numeric value.

fn from_untyped(m: &Transform3D<T>) -> Self

Tag a unitless value with units.

fn post_mul<NewDst>(
    &self,
    mat: &TypedTransform3D<T, Dst, NewDst>
) -> TypedTransform3D<T, Src, NewDst>

Returns the multiplication of the two matrices such that mat's transformation applies after self's transformation.

fn pre_mul<NewSrc>(
    &self,
    mat: &TypedTransform3D<T, NewSrc, Src>
) -> TypedTransform3D<T, NewSrc, Dst>

Returns the multiplication of the two matrices such that mat's transformation applies before self's transformation.

fn inverse(&self) -> Option<TypedTransform3D<T, Dst, Src>>

Returns the inverse transform if possible.

fn determinant(&self) -> T

Compute the determinant of the transform.

fn mul_s(&self, x: T) -> Self

Multiplies all of the transform's component by a scalar and returns the result.

fn from_scale_factor(scale: ScaleFactor<T, Src, Dst>) -> Self

Convenience function to create a scale transform from a ScaleFactor.

fn transform_point2d(&self, p: &TypedPoint2D<T, Src>) -> TypedPoint2D<T, Dst>

Returns the given 2d point transformed by this transform.

The input point must be use the unit Src, and the returned point has the unit Dst.

fn transform_vector2d(&self, v: &TypedVector2D<T, Src>) -> TypedVector2D<T, Dst>

Returns the given 2d vector transformed by this matrix.

The input point must be use the unit Src, and the returned point has the unit Dst.

fn transform_point3d(&self, p: &TypedPoint3D<T, Src>) -> TypedPoint3D<T, Dst>

Returns the given 3d point transformed by this transform.

The input point must be use the unit Src, and the returned point has the unit Dst.

fn transform_vector3d(&self, v: &TypedVector3D<T, Src>) -> TypedVector3D<T, Dst>

Returns the given 3d vector transformed by this matrix.

The input point must be use the unit Src, and the returned point has the unit Dst.

fn transform_rect(&self, rect: &TypedRect<T, Src>) -> TypedRect<T, Dst>

Returns a rectangle that encompasses the result of transforming the given rectangle by this transform.

fn create_translation(x: T, y: T, z: T) -> Self

Create a 3d translation transform

fn pre_translate(&self, v: TypedVector3D<T, Src>) -> Self

Returns a transform with a translation applied before self's transformation.

fn post_translate(&self, v: TypedVector3D<T, Dst>) -> Self

Returns a transform with a translation applied after self's transformation.

fn create_scale(x: T, y: T, z: T) -> Self

Create a 3d scale transform

fn pre_scale(&self, x: T, y: T, z: T) -> Self

Returns a transform with a scale applied before self's transformation.

fn post_scale(&self, x: T, y: T, z: T) -> Self

Returns a transform with a scale applied after self's transformation.

fn create_rotation(x: T, y: T, z: T, theta: Radians<T>) -> Self

Create a 3d rotation transform from an angle / axis. The supplied axis must be normalized.

fn post_rotate(&self, x: T, y: T, z: T, theta: Radians<T>) -> Self

Returns a transform with a rotation applied after self's transformation.

fn pre_rotate(&self, x: T, y: T, z: T, theta: Radians<T>) -> Self

Returns a transform with a rotation applied before self's transformation.

fn create_skew(alpha: Radians<T>, beta: Radians<T>) -> Self

Create a 2d skew transform.

See https://drafts.csswg.org/css-transforms/#funcdef-skew

fn create_perspective(d: T) -> Self

Create a simple perspective projection transform

impl<T: Copy, Src, Dst> TypedTransform3D<T, Src, Dst>

fn to_row_major_array(&self) -> [T; 16]

Returns an array containing this transform's terms in row-major order (the order in which the transform is actually laid out in memory).

fn to_column_major_array(&self) -> [T; 16]

Returns an array containing this transform's terms in column-major order.

fn to_row_arrays(&self) -> [[T; 4]; 4]

Returns an array containing this transform's 4 rows in (in row-major order) as arrays.

This is a convenience method to interface with other libraries like glium.

fn to_column_arrays(&self) -> [[T; 4]; 4]

Returns an array containing this transform's 4 columns in (in row-major order, or 4 rows in column-major order) as arrays.

This is a convenience method to interface with other libraries like glium.

fn from_array(array: [T; 16]) -> Self

Creates a transform from an array of 16 elements in row-major order.

fn from_row_arrays(array: [[T; 4]; 4]) -> Self

Creates a transform from 4 rows of 4 elements (row-major order).

Trait Implementations

impl<T: Clone, Src, Dst> Clone for TypedTransform3D<T, Src, Dst>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, Src, Dst> Copy for TypedTransform3D<T, Src, Dst>

impl<T, Src, Dst> HeapSizeOf for TypedTransform3D<T, Src, Dst> where
    T: HeapSizeOf, 

fn heap_size_of_children(&self) -> usize

Measure the size of any heap-allocated structures that hang off this value, but not the space taken up by the value itself (i.e. what size_of:: measures, more or less); that space is handled by the implementation of HeapSizeOf for Box below.

impl<'de, T, Src, Dst> Deserialize<'de> for TypedTransform3D<T, Src, Dst> where
    T: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<T, Src, Dst> Serialize for TypedTransform3D<T, Src, Dst> where
    T: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T, Src, Dst> Eq for TypedTransform3D<T, Src, Dst> where
    T: Eq, 

impl<T, Src, Dst> PartialEq for TypedTransform3D<T, Src, Dst> where
    T: PartialEq, 

fn eq(&self, other: &Self) -> 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 !=.

impl<T, Src, Dst> Hash for TypedTransform3D<T, Src, Dst> where
    T: Hash, 

fn hash<H: Hasher>(&self, h: &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<T, Src, Dst> Debug for TypedTransform3D<T, Src, Dst> where
    T: Copy + Debug + PartialEq + One + Zero, 

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

Formats the value using the given formatter.