Struct euclid::Transform2D

#[repr(C)]
pub struct Transform2D<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 3 by 2 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, Transform2D<f32, WorldSpace, ScreenSpace>::transform_point4d takes a Point2D<f32, WorldSpace> and returns a Point2D<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.

These transforms are for working with row vectors, so the matrix math for transforming a vector is v * T. If your library is using column vectors, use row_major functions when you are asked for column_major representations and vice versa.

Fields

m11: T

m12: T

m21: T

m22: T

m31: T

m32: T

Methods

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

pub fn row_major(m11: T, m12: T, m21: T, m22: T, m31: T, m32: T) -> Self

Create a transform specifying its matrix elements in row-major order.

Beware: This library is written with the assumption that row vectors are being used. If your matrices use column vectors (i.e. transforming a vector is T * v), then please use column_major

pub fn column_major(m11: T, m21: T, m31: T, m12: T, m22: T, m32: T) -> Self

Create a transform specifying its matrix elements in column-major order.

Beware: This library is written with the assumption that row vectors are being used. If your matrices use column vectors (i.e. transforming a vector is T * v), then please use row_major

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

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

Beware: This library is written with the assumption that row vectors are being used. If your matrices use column vectors (i.e. transforming a vector is T * v), then please use to_column_major_array

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

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

Beware: This library is written with the assumption that row vectors are being used. If your matrices use column vectors (i.e. transforming a vector is T * v), then please use to_row_major_array

pub fn to_row_arrays(&self) -> [[T; 2]; 3]

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

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

Beware: This library is written with the assumption that row vectors are being used. If your matrices use column vectors (i.e. transforming a vector is T * v), this will return column major arrays.

pub fn from_row_major_array(array: [T; 6]) -> Self

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

Beware: This library is written with the assumption that row vectors are being used. If your matrices use column vectors (i.e. transforming a vector is T * v), please provide a column major array.

pub fn from_row_arrays(array: [[T; 2]; 3]) -> Self

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

Beware: This library is written with the assumption that row vectors are being used. If your matrices use column vectors (i.e. transforming a vector is T * v), please provide a column major array.

pub fn to_untyped(&self) -> Transform2D<T, UnknownUnit, UnknownUnit>

Drop the units, preserving only the numeric value.

pub fn from_untyped(p: &Transform2D<T, UnknownUnit, UnknownUnit>) -> Self

Tag a unitless value with units.

impl<T0: NumCast + Copy, Src, Dst> Transform2D<T0, Src, Dst>

pub fn cast<T1: NumCast + Copy>(&self) -> Transform2D<T1, Src, Dst>

Cast from one numeric representation to another, preserving the units.

pub fn try_cast<T1: NumCast + Copy>(&self) -> Option<Transform2D<T1, Src, Dst>>

Fallible cast from one numeric representation to another, preserving the units.

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

pub fn identity() -> Self

impl<T, Src, Dst> Transform2D<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, 

#[must_use] pub fn post_transform<NewDst>(
    &self,
    mat: &Transform2D<T, Dst, NewDst>
) -> Transform2D<T, Src, NewDst>

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

Assuming row vectors, this is equivalent to self * mat

#[must_use] pub fn pre_transform<NewSrc>(
    &self,
    mat: &Transform2D<T, NewSrc, Src>
) -> Transform2D<T, NewSrc, Dst>

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

Assuming row vectors, this is equivalent to mat * self

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

Returns a translation transform.

#[must_use] pub fn post_translate(&self, v: Vector2D<T, Dst>) -> Self

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

#[must_use] pub fn pre_translate(&self, v: Vector2D<T, Src>) -> Self

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

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

Returns a scale transform.

#[must_use] pub fn post_scale(&self, x: T, y: T) -> Self

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

#[must_use] pub fn pre_scale(&self, x: T, y: T) -> Self

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

pub fn create_rotation(theta: Angle<T>) -> Self

Returns a rotation transform.

#[must_use] pub fn post_rotate(&self, theta: Angle<T>) -> Self

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

#[must_use] pub fn pre_rotate(&self, theta: Angle<T>) -> Self

Applies a rotation before self's transformation and returns the resulting transform.

#[must_use] pub fn transform_point(&self, point: Point2D<T, Src>) -> Point2D<T, Dst>

Returns the given point transformed by this transform.

Assuming row vectors, this is equivalent to p * self

#[must_use] pub fn transform_vector(&self, vec: Vector2D<T, Src>) -> Vector2D<T, Dst>

Returns the given vector transformed by this matrix.

Assuming row vectors, this is equivalent to v * self

#[must_use] pub fn transform_rect(&self, rect: &Rect<T, Src>) -> Rect<T, Dst>

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

pub fn determinant(&self) -> T

Computes and returns the determinant of this transform.

#[must_use] pub fn inverse(&self) -> Option<Transform2D<T, Dst, Src>>

Returns the inverse transform if possible.

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

Returns the same transform with a different destination unit.

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

Returns the same transform with a different source unit.

impl<T, Src, Dst> Transform2D<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> + PartialOrd + Trig + One + Zero, 

pub fn to_3d(&self) -> Transform3D<T, Src, Dst>

Create a 3D transform from the current transform

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

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

Trait Implementations

impl<T: Copy + Debug, Src, Dst> Debug for Transform2D<T, Src, Dst> where
    T: Copy + Debug + PartialEq + One + Zero, 

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

Formats the value using the given formatter.

impl<T, Src, Dst> PartialEq<Transform2D<T, Src, Dst>> for Transform2D<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 ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

impl<T, Src, Dst> Hash for Transform2D<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: Copy, Src, Dst> Copy for Transform2D<T, Src, Dst>

impl<T, Src, Dst> Into<Transform2D<T, Src, Dst>> for Translation2D<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 into(self) -> Transform2D<T, Src, Dst>

Performs the conversion.

impl<T: Clone, Src, Dst> Clone for Transform2D<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, Src, Dst> Default for Transform2D<T, Src, Dst> where
    T: Copy + PartialEq + One + Zero, 

fn default() -> Self

Returns the "default value" for a type.