Struct euclid::TypedTransform2D
source · #[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,
/* private fields */
}
Expand description
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, TypedTransform2D<f32, WorldSpace, ScreenSpace>::transform_point4d
takes a TypedPoint2D<f32, WorldSpace>
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
Implementations
sourceimpl<T: Copy, Src, Dst> TypedTransform2D<T, Src, Dst>
impl<T: Copy, Src, Dst> TypedTransform2D<T, Src, Dst>
sourcepub fn row_major(m11: T, m12: T, m21: T, m22: T, m31: T, m32: T) -> Self
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.
sourcepub fn column_major(m11: T, m21: T, m31: T, m12: T, m22: T, m32: T) -> Self
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.
sourcepub fn to_row_major_array(&self) -> [T; 6]
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).
sourcepub fn to_column_major_array(&self) -> [T; 6]
pub fn to_column_major_array(&self) -> [T; 6]
Returns an array containing this transform’s terms in column-major order.
sourcepub fn to_row_arrays(&self) -> [[T; 2]; 3]
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.
sourcepub fn from_row_major_array(array: [T; 6]) -> Self
pub fn from_row_major_array(array: [T; 6]) -> Self
Creates a transform from an array of 6 elements in row-major order.
sourcepub fn from_row_arrays(array: [[T; 2]; 3]) -> Self
pub fn from_row_arrays(array: [[T; 2]; 3]) -> Self
Creates a transform from 3 rows of 2 elements (row-major order).
sourcepub fn to_untyped(&self) -> Transform2D<T>
pub fn to_untyped(&self) -> Transform2D<T>
Drop the units, preserving only the numeric value.
sourcepub fn from_untyped(p: &Transform2D<T>) -> Self
pub fn from_untyped(p: &Transform2D<T>) -> Self
Tag a unitless value with units.
sourceimpl<T0: NumCast + Copy, Src, Dst> TypedTransform2D<T0, Src, Dst>
impl<T0: NumCast + Copy, Src, Dst> TypedTransform2D<T0, Src, Dst>
sourcepub fn cast<T1: NumCast + Copy>(&self) -> TypedTransform2D<T1, Src, Dst>
pub fn cast<T1: NumCast + Copy>(&self) -> TypedTransform2D<T1, Src, Dst>
Cast from one numeric representation to another, preserving the units.
sourceimpl<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,
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,
sourcepub fn post_mul<NewDst>(
&self,
mat: &TypedTransform2D<T, Dst, NewDst>
) -> TypedTransform2D<T, Src, NewDst>
pub fn post_mul<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.
sourcepub fn pre_mul<NewSrc>(
&self,
mat: &TypedTransform2D<T, NewSrc, Src>
) -> TypedTransform2D<T, NewSrc, Dst>
pub fn pre_mul<NewSrc>(
&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.
sourcepub fn create_translation(x: T, y: T) -> Self
pub fn create_translation(x: T, y: T) -> Self
Returns a translation transform.
sourcepub fn post_translate(&self, v: TypedVector2D<T, Dst>) -> Self
pub fn post_translate(&self, v: TypedVector2D<T, Dst>) -> Self
Applies a translation after self’s transformation and returns the resulting transform.
sourcepub fn pre_translate(&self, v: TypedVector2D<T, Src>) -> Self
pub fn pre_translate(&self, v: TypedVector2D<T, Src>) -> Self
Applies a translation before self’s transformation and returns the resulting transform.
sourcepub fn create_scale(x: T, y: T) -> Self
pub fn create_scale(x: T, y: T) -> Self
Returns a scale transform.
sourcepub fn post_scale(&self, x: T, y: T) -> Self
pub fn post_scale(&self, x: T, y: T) -> Self
Applies a scale after self’s transformation and returns the resulting transform.
sourcepub fn pre_scale(&self, x: T, y: T) -> Self
pub fn pre_scale(&self, x: T, y: T) -> Self
Applies a scale before self’s transformation and returns the resulting transform.
sourcepub fn create_rotation(theta: Angle<T>) -> Self
pub fn create_rotation(theta: Angle<T>) -> Self
Returns a rotation transform.
sourcepub fn post_rotate(&self, theta: Angle<T>) -> Self
pub fn post_rotate(&self, theta: Angle<T>) -> Self
Applies a rotation after self’s transformation and returns the resulting transform.
sourcepub fn pre_rotate(&self, theta: Angle<T>) -> Self
pub fn pre_rotate(&self, theta: Angle<T>) -> Self
Applies a rotation after self’s transformation and returns the resulting transform.
sourcepub fn transform_point(
&self,
point: &TypedPoint2D<T, Src>
) -> TypedPoint2D<T, Dst>
pub fn transform_point(
&self,
point: &TypedPoint2D<T, Src>
) -> TypedPoint2D<T, Dst>
Returns the given point transformed by this transform.
sourcepub fn transform_vector(
&self,
vec: &TypedVector2D<T, Src>
) -> TypedVector2D<T, Dst>
pub fn transform_vector(
&self,
vec: &TypedVector2D<T, Src>
) -> TypedVector2D<T, Dst>
Returns the given vector transformed by this matrix.
sourcepub fn transform_rect(&self, rect: &TypedRect<T, Src>) -> TypedRect<T, Dst>
pub 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.
sourcepub fn determinant(&self) -> T
pub fn determinant(&self) -> T
Computes and returns the determinant of this transform.
sourcepub fn inverse(&self) -> Option<TypedTransform2D<T, Dst, Src>>
pub fn inverse(&self) -> Option<TypedTransform2D<T, Dst, Src>>
Returns the inverse transform if possible.
sourcepub fn with_destination<NewDst>(&self) -> TypedTransform2D<T, Src, NewDst>
pub fn with_destination<NewDst>(&self) -> TypedTransform2D<T, Src, NewDst>
Returns the same transform with a different destination unit.
sourcepub fn with_source<NewSrc>(&self) -> TypedTransform2D<T, NewSrc, Dst>
pub fn with_source<NewSrc>(&self) -> TypedTransform2D<T, NewSrc, Dst>
Returns the same transform with a different source unit.
sourceimpl<T, Src, Dst> TypedTransform2D<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,
impl<T, Src, Dst> TypedTransform2D<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,
sourcepub fn to_3d(&self) -> TypedTransform3D<T, Src, Dst>
pub fn to_3d(&self) -> TypedTransform3D<T, Src, Dst>
Create a 3D transform from the current transform