Struct euclid::TypedTransform2D
[−]
[src]
#[repr(C)]pub struct TypedTransform2D<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.
Transforms can be parametrized over the source and destination units, to describe a
transformation from a space to another.
For example, TypedTransform2D<f32, WordSpace, ScreenSpace>::transform_point4d
takes a TypedPoint2D<f32, WordSpace>
and returns a TypedPoint2D<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
m21: T
m22: T
m31: T
m32: T
Methods
impl<T: Copy, Src, Dst> TypedTransform2D<T, Src, Dst>
[src]
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.
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.
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).
fn to_column_major_array(&self) -> [T; 6]
Returns an array containing this transform's terms in column-major order.
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.
fn from_row_major_array(array: [T; 6]) -> Self
Creates a transform from an array of 6 elements in row-major order.
fn from_row_arrays(array: [[T; 2]; 3]) -> Self
Creates a transform from 3 rows of 2 elements (row-major order).
fn to_untyped(&self) -> Transform2D<T>
Drop the units, preserving only the numeric value.
fn from_untyped(p: &Transform2D<T>) -> Self
Tag a unitless value with units.
impl<T, Src, Dst> TypedTransform2D<T, Src, Dst> where
T: Copy + PartialEq + One + Zero,
[src]
T: Copy + PartialEq + One + Zero,
fn identity() -> Self
impl<T, Src, Dst> TypedTransform2D<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,
[src]
T: Copy + Clone + Add<T, Output = T> + Mul<T, Output = T> + Div<T, Output = T> + Sub<T, Output = T> + Trig + PartialOrd + One + Zero,
fn post_mul<NewDst>(
&self,
mat: &TypedTransform2D<T, Dst, NewDst>
) -> TypedTransform2D<T, Src, NewDst>
&self,
mat: &TypedTransform2D<T, Dst, NewDst>
) -> TypedTransform2D<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: &TypedTransform2D<T, NewSrc, Src>
) -> TypedTransform2D<T, NewSrc, Dst>
&self,
mat: &TypedTransform2D<T, NewSrc, Src>
) -> TypedTransform2D<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) -> Self
Returns a translation transform.
fn post_translate(&self, v: TypedVector2D<T, Dst>) -> Self
Applies a translation after self's transformation and returns the resulting transform.
fn pre_translate(&self, v: TypedVector2D<T, Src>) -> Self
Applies a translation before self's transformation and returns the resulting transform.
fn create_scale(x: T, y: T) -> Self
Returns a scale transform.
fn post_scale(&self, x: T, y: T) -> Self
Applies a scale after self's transformation and returns the resulting transform.
fn pre_scale(&self, x: T, y: T) -> Self
Applies a scale before self's transformation and returns the resulting transform.
fn create_rotation(theta: Radians<T>) -> Self
Returns a rotation transform.
fn post_rotate(&self, theta: Radians<T>) -> Self
Applies a rotation after self's transformation and returns the resulting transform.
fn pre_rotate(&self, theta: Radians<T>) -> Self
Applies a rotation after self's transformation and returns the resulting transform.
fn transform_point(&self, point: &TypedPoint2D<T, Src>) -> TypedPoint2D<T, Dst>
Returns the given point transformed by this transform.
fn transform_vector(&self, vec: &TypedVector2D<T, Src>) -> TypedVector2D<T, Dst>
Returns the given vector 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 transform.
fn determinant(&self) -> T
Computes and returns the determinant of this transform.
fn inverse(&self) -> Option<TypedTransform2D<T, Dst, Src>>
Returns the inverse transform if possible.
fn with_destination<NewDst>(&self) -> TypedTransform2D<T, Src, NewDst>
Returns the same transform with a different destination unit.
fn with_source<NewSrc>(&self) -> TypedTransform2D<T, NewSrc, Dst>
Returns the same transform with a different source unit.
impl<T: ApproxEq<T>, Src, Dst> TypedTransform2D<T, Src, Dst>
[src]
Trait Implementations
impl<T: Clone, Src, Dst> Clone for TypedTransform2D<T, Src, Dst>
[src]
fn clone(&self) -> Self
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl<T: Copy, Src, Dst> Copy for TypedTransform2D<T, Src, Dst>
[src]
impl<T, Src, Dst> HeapSizeOf for TypedTransform2D<T, Src, Dst> where
T: HeapSizeOf,
[src]
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. Read more
impl<T, Src, Dst> Deserialize for TypedTransform2D<T, Src, Dst> where
T: Deserialize,
[src]
T: Deserialize,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer,
D: Deserializer,
Deserialize this value from the given Serde deserializer. Read more
impl<T, Src, Dst> Serialize for TypedTransform2D<T, Src, Dst> where
T: Serialize,
[src]
T: Serialize,
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<T, Src, Dst> Eq for TypedTransform2D<T, Src, Dst> where
T: Eq,
[src]
T: Eq,
impl<T, Src, Dst> PartialEq for TypedTransform2D<T, Src, Dst> where
T: PartialEq,
[src]
T: PartialEq,
fn eq(&self, other: &Self) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0
This method tests for !=
.
impl<T, Src, Dst> Hash for TypedTransform2D<T, Src, Dst> where
T: Hash,
[src]
T: Hash,
fn hash<H: Hasher>(&self, h: &mut H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl<T: Copy + Debug, Src, Dst> Debug for TypedTransform2D<T, Src, Dst> where
T: Copy + Debug + PartialEq + One + Zero,
[src]
T: Copy + Debug + PartialEq + One + Zero,