Struct glam::f64::DAffine2

source ·
#[repr(C)]
pub struct DAffine2 { pub matrix2: DMat2, pub translation: DVec2, }
Expand description

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

Fields§

§matrix2: DMat2§translation: DVec2

Implementations§

source§

impl DAffine2

source

pub const ZERO: Self = _

The degenerate zero transform.

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

source

pub const IDENTITY: Self = _

The identity transform.

Multiplying a vector with this returns the same vector.

source

pub const NAN: Self = _

All NAN:s.

source

pub const fn from_cols(x_axis: DVec2, y_axis: DVec2, z_axis: DVec2) -> Self

Creates an affine transform from three column vectors.

source

pub fn from_cols_array(m: &[f64; 6]) -> Self

Creates an affine transform from a [f64; 6] array stored in column major order.

source

pub fn to_cols_array(&self) -> [f64; 6]

Creates a [f64; 6] array storing data in column major order.

source

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

Creates an affine transform from a [[f64; 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.

source

pub fn to_cols_array_2d(&self) -> [[f64; 2]; 3]

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

source

pub fn from_cols_slice(slice: &[f64]) -> Self

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

Panics

Panics if slice is less than 6 elements long.

source

pub fn write_cols_to_slice(self, slice: &mut [f64])

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

Panics

Panics if slice is less than 6 elements long.

source

pub fn from_scale(scale: DVec2) -> Self

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

source

pub fn from_angle(angle: f64) -> Self

Creates an affine transform from the given rotation angle.

source

pub fn from_translation(translation: DVec2) -> Self

Creates an affine transformation from the given 2D translation.

source

pub fn from_mat2(matrix2: DMat2) -> Self

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

source

pub fn from_mat2_translation(matrix2: DMat2, translation: DVec2) -> Self

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

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

source

pub fn from_scale_angle_translation( scale: DVec2, angle: f64, translation: DVec2 ) -> Self

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

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

source

pub fn from_angle_translation(angle: f64, translation: DVec2) -> Self

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

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

source

pub fn from_mat3(m: DMat3) -> Self

The given DMat3 must be an affine transform,

source

pub fn transform_point2(&self, rhs: DVec2) -> DVec2

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

source

pub fn transform_vector2(&self, rhs: DVec2) -> DVec2

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

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

source

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.

source

pub fn is_nan(&self) -> bool

Returns true if any elements are NaN.

source

pub fn abs_diff_eq(&self, rhs: Self, max_abs_diff: f64) -> bool

Returns true if the absolute difference of all elements between self and rhs 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.

source

pub fn inverse(&self) -> Self

Return the inverse of this transform.

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

Trait Implementations§

source§

impl Clone for DAffine2

source§

fn clone(&self) -> DAffine2

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for DAffine2

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for DAffine2

source§

fn default() -> Self

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

impl Deref for DAffine2

§

type Target = Cols3<DVec2>

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for DAffine2

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl Display for DAffine2

source§

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

Formats the value using the given formatter. Read more
source§

impl From<DAffine2> for DMat3

source§

fn from(m: DAffine2) -> DMat3

Converts to this type from the input type.
source§

impl Mul<DAffine2> for DAffine2

§

type Output = DAffine2

The resulting type after applying the * operator.
source§

fn mul(self, rhs: DAffine2) -> Self::Output

Performs the * operation. Read more
source§

impl Mul<DAffine2> for DMat3

§

type Output = DMat3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: DAffine2) -> Self::Output

Performs the * operation. Read more
source§

impl Mul<DMat3> for DAffine2

§

type Output = DMat3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: DMat3) -> Self::Output

Performs the * operation. Read more
source§

impl PartialEq<DAffine2> for DAffine2

source§

fn eq(&self, rhs: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> Product<&'a DAffine2> for DAffine2

source§

fn product<I>(iter: I) -> Selfwhere I: Iterator<Item = &'a Self>,

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

impl Copy for DAffine2

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.