Struct bevy_math::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: DAffine2 = _

The degenerate zero transform.

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

source

pub const IDENTITY: DAffine2 = _

The identity transform.

Multiplying a vector with this returns the same vector.

source

pub const NAN: DAffine2 = _

All NAN:s.

source

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

Creates an affine transform from three column vectors.

source

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

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

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

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

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

Creates an affine transform from the given rotation angle.

source

pub fn from_translation(translation: DVec2) -> DAffine2

Creates an affine transformation from the given 2D translation.

source

pub fn from_mat2(matrix2: DMat2) -> DAffine2

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

source

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

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

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

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

The given DMat3 must be an affine transform,

source

pub fn to_scale_angle_translation(self) -> (DVec2, f64, DVec2)

Extracts scale, angle and translation from self.

The transform is expected to be non-degenerate and without shearing, or the output will be invalid.

Panics

Will panic if the determinant self.matrix2 is zero or if the resulting scale vector contains any zero elements when glam_assert is enabled.

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: DAffine2, 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) -> DAffine2

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<(), Error>

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

impl Default for DAffine2

source§

fn default() -> DAffine2

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) -> &<DAffine2 as Deref>::Target

Dereferences the value.
source§

impl DerefMut for DAffine2

source§

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

Mutably dereferences the value.
source§

impl<'de> Deserialize<'de> for DAffine2

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for DAffine2

source§

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

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 DMat3

§

type Output = DMat3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: DAffine2) -> <DMat3 as Mul<DAffine2>>::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) -> <DAffine2 as Mul<DMat3>>::Output

Performs the * operation. Read more
source§

impl Mul for DAffine2

§

type Output = DAffine2

The resulting type after applying the * operator.
source§

fn mul(self, rhs: DAffine2) -> <DAffine2 as Mul>::Output

Performs the * operation. Read more
source§

impl MulAssign for DAffine2

source§

fn mul_assign(&mut self, rhs: DAffine2)

Performs the *= operation. Read more
source§

impl PartialEq for DAffine2

source§

fn eq(&self, rhs: &DAffine2) -> 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) -> DAffine2
where I: Iterator<Item = &'a DAffine2>,

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

impl Serialize for DAffine2

source§

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. Read more
source§

impl Zeroable for DAffine2

source§

fn zeroed() -> Self

source§

impl Copy for DAffine2

source§

impl Pod for DAffine2

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.
source§

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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 T
where 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 T
where 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 T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> AnyBitPattern for T
where T: Pod,

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> NoUninit for T
where T: Pod,