Struct glam::f32::Affine2[−][src]

pub struct Affine2 {
    pub matrix2: Mat2,
    pub translation: Vec2,
}

Expand description

A 2D affine transform, which can represent translation, rotation, scaling and shear.

Fields

matrix2: Mat2translation: Vec2

Implementations

`impl Affine2`[src]

`pub const ZERO: Self`[src]

The degenerate zero transform.

This transforms any finite vector and point to zero. The zero transform is non-invertible.

`pub const IDENTITY: Self`[src]

The identity transform.

Multiplying a vector with this returns the same vector.

`pub fn from_cols(x_axis: Vec2, y_axis: Vec2, z_axis: Vec2) -> Self`[src]

Creates an affine transform from three column vectors.

`pub fn from_cols_array(m: &[f32; 6]) -> Self`[src]

Creates an affine transform from a [S; 6] array stored in column major order. If your data is stored in row major you will need to transpose the returned matrix.

`pub fn to_cols_array(&self) -> [f32; 6]`[src]

Creates a [S; 6] array storing data in column major order. If you require data in row major order transpose the matrix first.

`pub fn from_cols_array_2d(m: &[[f32; 2]; 3]) -> Self`[src]

Creates an affine transform from a [[S; 2]; 3] 2D array stored in column major order. If your data is in row major order you will need to transpose the returned matrix.

`pub fn to_cols_array_2d(&self) -> [[f32; 2]; 3]`[src]

Creates a [[S; 2]; 3] 2D array storing data in column major order. If you require data in row major order transpose the matrix first.

`pub fn from_cols_slice(slice: &[f32]) -> Self`[src]

Creates an affine transform from the first 6 values in slice.

Panics

Panics if slice is less than 6 elements long.

`pub fn write_cols_to_slice(self, slice: &mut [f32])`[src]

Writes the columns of self to the first 12 elements in slice.

Panics

Panics if slice is less than 12 elements long.

`pub fn from_scale(scale: Vec2) -> Self`[src]

Creates an affine transform that changes scale. Note that if any scale is zero the transform will be non-invertible.

`pub fn from_angle(angle: f32) -> Self`[src]

Creates an affine transform from the given rotation angle.

`pub fn from_translation(translation: Vec2) -> Self`[src]

Creates an affine transformation from the given 2D translation.

`pub fn from_mat2(matrix2: Mat2) -> Self`[src]

Creates an affine transform from a 2x2 matrix (expressing scale, shear and rotation)

`pub fn from_mat2_translation(matrix2: Mat2, translation: Vec2) -> Self`[src]

Creates an affine transform from a 2x2 matrix (expressing scale, shear and rotation) and a translation vector.

Equivalent to Affine2::from_translation(translation) * Affine2::from_mat2(mat2)

`pub fn from_scale_angle_translation( scale: Vec2, angle: f32, translation: Vec2 ) -> Self`[src]

Creates an affine transform from the given 2D scale, rotation angle (in radians) and translation.

Equivalent to Affine2::from_translation(translation) * Affine2::from_angle(angle) * Affine2::from_scale(scale)

`pub fn from_angle_translation(angle: f32, translation: Vec2) -> Self`[src]

Creates an affine transform from the given 2D rotation angle (in radians) and translation.

Equivalent to Affine2::from_translation(translation) * Affine2::from_angle(angle)

`pub fn from_mat3(m: Mat3) -> Self`[src]

The given Mat3 must be an affine transform,

`pub fn transform_point2(&self, other: Vec2) -> Vec2`[src]

Transforms the given 2D point, applying shear, scale, rotation and translation.

`pub fn transform_vector2(&self, other: Vec2) -> Vec2`[src]

Transforms the given 2D vector, applying shear, scale and rotation (but NOT translation).

To also apply translation, use Self::transform_point2 instead.

`pub fn is_finite(&self) -> bool`[src]

Returns true if, and only if, all elements are finite.

If any element is either NaN, positive or negative infinity, this will return false.

`pub fn is_nan(&self) -> bool`[src]

Returns true if any elements are NaN.

`pub fn abs_diff_eq(&self, other: Self, max_abs_diff: f32) -> bool`[src]

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two 3x4 matrices contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

`pub fn inverse(&self) -> Self`[src]

Return the inverse of this transform.

Note that if the transform is not invertible the result will be invalid.

Trait Implementations

`impl Add<Affine2> for Affine2`[src]

`type Output = Self`

The resulting type after applying the + operator.

`fn add(self, other: Self) -> Self::Output`[src]

Performs the + operation. Read more

`impl Clone for Affine2`[src]

`fn clone(&self) -> Affine2`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for Affine2`[src]

`fn fmt(&self, fmt: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

`impl Default for Affine2`[src]

`fn default() -> Self`[src]

Returns the “default value” for a type. Read more

`impl Deref for Affine2`[src]

`type Target = Columns3<Vec2>`

The resulting type after dereferencing.

`fn deref(&self) -> &Self::Target`[src]

Dereferences the value.

`impl DerefMut for Affine2`[src]

`fn deref_mut(&mut self) -> &mut Self::Target`[src]

Mutably dereferences the value.

`impl Display for Affine2`[src]

`fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

`impl From<Affine2> for Mat3`[src]

`fn from(m: Affine2) -> Mat3`[src]

Performs the conversion.

`impl From<Affine2> for Mat3A`[src]

`fn from(m: Affine2) -> Mat3A`[src]

Performs the conversion.