Struct euclid::matrix4d::TypedMatrix4D

pub struct TypedMatrix4D<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 4 by 4 matrix stored in row-major order in memory, useful to represent 3d transformations.

Matrices can be parametrized over the source and destination units, to describe a transformation from a space to another. For example, TypedMatrix4D::transform_point4d takes a TypedPoint4D and returns a TypedPoint4D.

Matrices 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 appled 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> TypedMatrix4D<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)
             -> TypedMatrix4D<T, Src, Dst>

Create a matrix 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)
                -> TypedMatrix4D<T, Src, Dst>

Create a matrix 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> TypedMatrix4D<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)
                -> TypedMatrix4D<T, Src, Dst>

Create a 4 by 4 matrix 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)
         -> TypedMatrix4D<T, Src, Dst>

Create an orthogonal projection matrix.

fn identity() -> TypedMatrix4D<T, Src, Dst>

fn is_2d(&self) -> bool

Returns true if this matrix can be represented with a TypedMatrix2D.

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

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

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

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

fn approx_eq(&self, other: &TypedMatrix4D<T, Src, Dst>) -> bool

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

Returns the same matrix with a different destination unit.

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

Returns the same matrix with a different source unit.

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

Drop the units, preserving only the numeric value.

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

Tag a unitless value with units.

fn post_mul<NewDst>(&self,
                    mat: &TypedMatrix4D<T, Dst, NewDst>)
                    -> TypedMatrix4D<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: &TypedMatrix4D<T, NewSrc, Src>)
                   -> TypedMatrix4D<T, NewSrc, Dst>

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

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

Returns the inverse matrix if possible.

fn determinant(&self) -> T

Compute the determinant of the matrix.

fn mul_s(&self, x: T) -> TypedMatrix4D<T, Src, Dst>

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

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

Convenience function to create a scale matrix from a ScaleFactor.

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

Returns the given 2d point 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 matrix.

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

fn transform_point4d(&self, p: &TypedPoint4D<T, Src>) -> TypedPoint4D<T, Dst>

Returns the given 4d point 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 matrix.

fn create_translation(x: T, y: T, z: T) -> TypedMatrix4D<T, Src, Dst>

Create a 3d translation matrix

fn pre_translated(&self, x: T, y: T, z: T) -> TypedMatrix4D<T, Src, Dst>

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

fn post_translated(&self, x: T, y: T, z: T) -> TypedMatrix4D<T, Src, Dst>

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

fn create_scale(x: T, y: T, z: T) -> TypedMatrix4D<T, Src, Dst>

Create a 3d scale matrix

fn pre_scaled(&self, x: T, y: T, z: T) -> TypedMatrix4D<T, Src, Dst>

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

fn post_scaled(&self, x: T, y: T, z: T) -> TypedMatrix4D<T, Src, Dst>

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

fn create_rotation(x: T,
                   y: T,
                   z: T,
                   theta: Radians<T>)
                   -> TypedMatrix4D<T, Src, Dst>

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

fn post_rotated(&self,
                x: T,
                y: T,
                z: T,
                theta: Radians<T>)
                -> TypedMatrix4D<T, Src, Dst>

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

fn pre_rotated(&self,
               x: T,
               y: T,
               z: T,
               theta: Radians<T>)
               -> TypedMatrix4D<T, Src, Dst>

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

fn create_skew(alpha: Radians<T>,
               beta: Radians<T>)
               -> TypedMatrix4D<T, Src, Dst>

Create a 2d skew matrix.

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

fn create_perspective(d: T) -> TypedMatrix4D<T, Src, Dst>

Create a simple perspective projection matrix

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

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

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

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

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

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

Returns an array containing this matrix'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 matrix'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.

Trait Implementations

impl<T: Clone, Src, Dst> Clone for TypedMatrix4D<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 TypedMatrix4D<T, Src, Dst>

impl<T, Src, Dst> HeapSizeOf for TypedMatrix4D<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<T, Src, Dst> Deserialize for TypedMatrix4D<T, Src, Dst> where T: Deserialize

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

Deserialize this value given this Deserializer.

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

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

Serializes this value into this serializer.

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

impl<T, Src, Dst> PartialEq for TypedMatrix4D<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 TypedMatrix4D<T, Src, Dst> where T: Hash

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

impl<T: Copy + Debug, Src, Dst> Debug for TypedMatrix4D<T, Src, Dst>

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

Formats the value using the given formatter.