Struct rfw::prelude::Affine2

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

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

Fields

matrix2: Mat2

translation: Vec2

Implementations

impl Affine2

pub const ZERO: Affine2

The degenerate zero transform.

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

pub const IDENTITY: Affine2

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) -> Affine2

Creates an affine transform from three column vectors.

pub fn from_cols_array(m: &[f32; 6]) -> Affine2

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]

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]) -> Affine2

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]

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]) -> Affine2

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])

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) -> Affine2

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) -> Affine2

Creates an affine transform from the given rotation angle.

pub fn from_translation(translation: Vec2) -> Affine2

Creates an affine transformation from the given 2D translation.

pub fn from_mat2(matrix2: Mat2) -> Affine2

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

pub fn from_mat2_translation(matrix2: Mat2, translation: Vec2) -> Affine2

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
) -> Affine2

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) -> Affine2

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) -> Affine2

The given Mat3 must be an affine transform,

pub fn transform_point2(&self, other: Vec2) -> Vec2

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

pub fn transform_vector2(&self, other: Vec2) -> Vec2

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

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

Returns true if any elements are NaN.

pub fn abs_diff_eq(&self, other: Affine2, max_abs_diff: f32) -> bool

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) -> Affine2

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

type Output = Affine2

The resulting type after applying the + operator.

pub fn add(self, other: Affine2) -> <Affine2 as Add<Affine2>>::Output

Performs the + operation.

impl Clone for Affine2

pub fn clone(&self) -> Affine2

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Affine2

pub fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Affine2

pub fn default() -> Affine2

Returns the “default value” for a type.

impl Deref for Affine2

type Target = Columns3<Vec2>

The resulting type after dereferencing.

pub fn deref(&self) -> &<Affine2 as Deref>::Target

Dereferences the value.

impl DerefMut for Affine2

pub fn deref_mut(&mut self) -> &mut <Affine2 as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Affine2

pub fn deserialize<D>(
    deserializer: D
) -> Result<Affine2, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Affine2

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Affine2> for Mat3A

pub fn from(m: Affine2) -> Mat3A

Performs the conversion.

impl From<Affine2> for Mat3

pub fn from(m: Affine2) -> Mat3

Performs the conversion.

impl Mul<Affine2> for Mat3A

type Output = Mat3A

The resulting type after applying the * operator.

pub fn mul(self, other: Affine2) -> <Mat3A as Mul<Affine2>>::Output

Performs the * operation.

impl Mul<Affine2> for Mat3

type Output = Mat3

The resulting type after applying the * operator.

pub fn mul(self, other: Affine2) -> <Mat3 as Mul<Affine2>>::Output

Performs the * operation.

impl Mul<Affine2> for Affine2

type Output = Affine2

The resulting type after applying the * operator.

pub fn mul(self, other: Affine2) -> <Affine2 as Mul<Affine2>>::Output

Performs the * operation.

impl Mul<Mat3> for Affine2

type Output = Mat3

The resulting type after applying the * operator.

pub fn mul(self, other: Mat3) -> <Affine2 as Mul<Mat3>>::Output

Performs the * operation.

impl Mul<Mat3A> for Affine2

type Output = Mat3A

The resulting type after applying the * operator.

pub fn mul(self, other: Mat3A) -> <Affine2 as Mul<Mat3A>>::Output

Performs the * operation.

impl Mul<f32> for Affine2

type Output = Affine2

The resulting type after applying the * operator.

pub fn mul(self, other: f32) -> <Affine2 as Mul<f32>>::Output

Performs the * operation.

impl PartialEq<Affine2> for Affine2

pub fn eq(&self, other: &Affine2) -> 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<'a> Product<&'a Affine2> for Affine2

pub fn product<I>(iter: I) -> Affine2 where
    I: Iterator<Item = &'a Affine2>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Serialize for Affine2

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sub<Affine2> for Affine2

type Output = Affine2

The resulting type after applying the - operator.

pub fn sub(self, other: Affine2) -> <Affine2 as Sub<Affine2>>::Output

Performs the - operation.

impl Copy for Affine2