Struct euclid::matrix2d::TypedMatrix2D

pub struct TypedMatrix2D<T, Src, Dst> {
    pub m11: T,
    pub m12: T,
    pub m21: T,
    pub m22: T,
    pub m31: T,
    pub m32: T,
    // some fields omitted
}

A 2d transform stored as a 2 by 3 matrix in row-major order in memory, useful to represent 2d transformations.

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

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

m21: T

m22: T

m31: T

m32: T

Methods

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

fn row_major(m11: T,
             m12: T,
             m21: T,
             m22: T,
             m31: T,
             m32: T)
             -> TypedMatrix2D<T, Src, Dst>

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

fn column_major(m11: T,
                m21: T,
                m31: T,
                m12: T,
                m22: T,
                m32: T)
                -> TypedMatrix2D<T, Src, Dst>

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

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

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; 6]

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

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

Drop the units, preserving only the numeric value.

fn from_untyped(p: &Matrix2D<T>) -> TypedMatrix2D<T, Src, Dst>

Tag a unitless value with units.

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

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

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

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

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

Returns a translation matrix.

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

Applies a translation after self's transformation and returns the resulting matrix.

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

Applies a translation before self's transformation and returns the resulting matrix.

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

Returns a scale matrix.

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

Applies a scale after self's transformation and returns the resulting matrix.

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

Applies a scale before self's transformation and returns the resulting matrix.

fn create_rotation(theta: Radians<T>) -> TypedMatrix2D<T, Src, Dst>

Returns a rotation matrix.

fn post_rotated(&self, theta: Radians<T>) -> TypedMatrix2D<T, Src, Dst>

Applies a rotation after self's transformation and returns the resulting matrix.

fn pre_rotated(&self, theta: Radians<T>) -> TypedMatrix2D<T, Src, Dst>

Applies a rotation after self's transformation and returns the resulting matrix.

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

Returns the given point transformed by this matrix.

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 determinant(&self) -> T

Computes and returns the determinant of this matrix.

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

Returns the inverse matrix if possible.

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

Returns the same matrix with a different destination unit.

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

Returns the same matrix with a different source unit.

impl<T: ApproxEq<T>, Src, Dst> TypedMatrix2D<T, Src, Dst>

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

Trait Implementations

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

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

impl<T, Src, Dst> PartialEq for TypedMatrix2D<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 TypedMatrix2D<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 TypedMatrix2D<T, Src, Dst>

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

Formats the value using the given formatter.