Struct bevy::math::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 = Self{ matrix2: Mat2::ZERO, translation: Vec2::ZERO,}

The degenerate zero transform.

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

pub const IDENTITY: Affine2 = Self{ matrix2: Mat2::IDENTITY, translation: Vec2::ZERO,}

The identity transform.

Multiplying a vector with this returns the same vector.

pub const NAN: Affine2 = Self{ matrix2: Mat2::NAN, translation: Vec2::NAN,}

All NAN:s.

pub const 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 [f32; 6] array stored in column major order.

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

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

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

Creates an affine transform from a [[f32; 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 [[f32; 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 6 elements in slice.

Panics

Panics if slice is less than 6 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 from_mat3a(m: Mat3A) -> Affine2

The given Mat3A must be an affine transform,

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

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

pub fn transform_vector2(&self, rhs: 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, rhs: Affine2, max_abs_diff: f32) -> 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) -> Affine2

Return the inverse of this transform.

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

Trait Implementations

impl Clone for Affine2

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

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

Formats the value using the given formatter.

impl Default for Affine2

fn default() -> Affine2

Returns the “default value” for a type.

impl Deref for Affine2

type Target = Cols3<Vec2>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Affine2

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

Mutably dereferences the value.

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

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

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

Formats the value using the given formatter.

impl From<Affine2> for Mat3

fn from(m: Affine2) -> Mat3

Converts to this type from the input type.

impl From<Affine2> for Mat3A

fn from(m: Affine2) -> Mat3A

Converts to this type from the input type.

impl FromReflect for Affine2where Mat2: FromReflect, Vec2: FromReflect,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Affine2>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect + 'static, Global> ) -> Result<Self, Box<dyn Reflect + 'static, Global>>

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

impl GetTypeRegistration for Affine2where Mat2: Reflect, Vec2: Reflect,

fn get_type_registration() -> TypeRegistration

impl Mul<Affine2> for Affine2

type Output = Affine2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Affine2> for Mat3

type Output = Mat3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Affine2> for Mat3A

type Output = Mat3A

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Mat3> for Affine2

type Output = Mat3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Mat3A> for Affine2

type Output = Mat3A

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq<Affine2> for Affine2

fn eq(&self, rhs: &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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

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

impl Reflect for Affine2where Mat2: Reflect, Vec2: Reflect,

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

fn into_any(self: Box<Affine2, Global>) -> Box<dyn Any + 'static, Global>

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<Affine2, Global> ) -> Box<dyn Reflect + 'static, Global>

Casts this type to a boxed reflected value.

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

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

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

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

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

Applies a reflected value to this value.

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Affine2, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

Debug formatter for the 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.

impl Serialize for Affine2

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 Affine2where Mat2: Reflect, Vec2: Reflect,

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

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

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

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

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

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

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

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

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.

impl Typed for Affine2where Mat2: Reflect, Vec2: Reflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Affine2