Struct DAffine2

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

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

Fields

matrix2: DMat2

translation: DVec2

Implementations

impl DAffine2

pub const ZERO: DAffine2 = _

The degenerate zero transform.

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

pub const IDENTITY: DAffine2 = _

The identity transform.

Multiplying a vector with this returns the same vector.

pub const NAN: DAffine2 = _

All NAN:s.

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

Creates an affine transform from three column vectors.

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

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

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

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

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.

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.

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.

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.

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.

pub fn from_angle(angle: f64) -> DAffine2

Creates an affine transform from the given rotation angle.

pub fn from_translation(translation: DVec2) -> DAffine2

Creates an affine transformation from the given 2D translation.

pub fn from_mat2(matrix2: DMat2) -> DAffine2

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

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)

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)

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)

pub fn from_mat3(m: DMat3) -> DAffine2

The given DMat3 must be an affine transform,

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.

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

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

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.

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, 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.

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

impl AbsDiffEq for DAffine2

type Epsilon = <f64 as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <DAffine2 as AbsDiffEq>::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq( &self, other: &DAffine2, epsilon: <DAffine2 as AbsDiffEq>::Epsilon, ) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Clone for DAffine2

fn clone(&self) -> DAffine2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DAffine2

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

Formats the value using the given formatter.

impl Default for DAffine2

fn default() -> DAffine2

Returns the “default value” for a type.

impl Deref for DAffine2

type Target = Cols3<DVec2>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for DAffine2

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

Mutably dereferences the value.

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

Deserialize expects a sequence of 6 values.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DAffine2

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

Formats the value using the given formatter.

impl From<DAffine2> for DMat3

fn from(m: DAffine2) -> DMat3

Converts to this type from the input type.

impl FromReflect for DAffine2

where DAffine2: Any + Send + Sync, DMat2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, DVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<DAffine2>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for DAffine2

where DAffine2: Any + Send + Sync, DMat2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, DVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Mul<DAffine2> for DMat3

type Output = DMat3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<DMat3> for DAffine2

type Output = DMat3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for DAffine2

type Output = DAffine2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for DAffine2

fn mul_assign(&mut self, rhs: DAffine2)

Performs the *= operation.

impl PartialEq for DAffine2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for DAffine2

where DAffine2: Any + Send + Sync, DMat2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, DVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<DAffine2>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<DAffine2>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<DAffine2>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

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

fn product<I>(iter: I) -> DAffine2

where I: Iterator<Item = &'a DAffine2>,

Takes an iterator and generates Self from the elements by multiplying the items.

impl Reflect for DAffine2

where DAffine2: Any + Send + Sync, DMat2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, DVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<DAffine2>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<DAffine2>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl RelativeEq for DAffine2

fn default_max_relative() -> <DAffine2 as AbsDiffEq>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &DAffine2, epsilon: <DAffine2 as AbsDiffEq>::Epsilon, max_relative: <DAffine2 as AbsDiffEq>::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Serialize for DAffine2

Serialize as a sequence of 6 values.

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 Struct for DAffine2

where DAffine2: Any + Send + Sync, DMat2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, DVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for DAffine2

where DAffine2: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for DAffine2

where DAffine2: Any + Send + Sync, DMat2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, DVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UlpsEq for DAffine2

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq( &self, other: &DAffine2, epsilon: <DAffine2 as AbsDiffEq>::Epsilon, max_ulps: u32, ) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl Zeroable for DAffine2

fn zeroed() -> Self

Calls zeroed.

impl Copy for DAffine2

impl Pod for DAffine2