#[repr(C)]pub struct Affine2 {
pub matrix2: Mat2,
pub translation: Vec2,
}
Expand description
A 2D affine transform, which can represent translation, rotation, scaling and shear.
Fields§
§matrix2: Mat2
§translation: Vec2
Implementations§
source§impl Affine2
impl Affine2
sourcepub const ZERO: Affine2 = _
pub const ZERO: Affine2 = _
The degenerate zero transform.
This transforms any finite vector and point to zero. The zero transform is non-invertible.
sourcepub const IDENTITY: Affine2 = _
pub const IDENTITY: Affine2 = _
The identity transform.
Multiplying a vector with this returns the same vector.
sourcepub const fn from_cols(x_axis: Vec2, y_axis: Vec2, z_axis: Vec2) -> Affine2
pub const fn from_cols(x_axis: Vec2, y_axis: Vec2, z_axis: Vec2) -> Affine2
Creates an affine transform from three column vectors.
sourcepub fn from_cols_array(m: &[f32; 6]) -> Affine2
pub fn from_cols_array(m: &[f32; 6]) -> Affine2
Creates an affine transform from a [f32; 6]
array stored in column major order.
sourcepub fn to_cols_array(&self) -> [f32; 6]
pub fn to_cols_array(&self) -> [f32; 6]
Creates a [f32; 6]
array storing data in column major order.
sourcepub fn from_cols_array_2d(m: &[[f32; 2]; 3]) -> Affine2
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.
sourcepub fn to_cols_array_2d(&self) -> [[f32; 2]; 3]
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.
sourcepub fn from_cols_slice(slice: &[f32]) -> Affine2
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.
sourcepub fn write_cols_to_slice(self, slice: &mut [f32])
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.
sourcepub fn from_scale(scale: Vec2) -> Affine2
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.
sourcepub fn from_angle(angle: f32) -> Affine2
pub fn from_angle(angle: f32) -> Affine2
Creates an affine transform from the given rotation angle
.
sourcepub fn from_translation(translation: Vec2) -> Affine2
pub fn from_translation(translation: Vec2) -> Affine2
Creates an affine transformation from the given 2D translation
.
sourcepub fn from_mat2(matrix2: Mat2) -> Affine2
pub fn from_mat2(matrix2: Mat2) -> Affine2
Creates an affine transform from a 2x2 matrix (expressing scale, shear and rotation)
sourcepub fn from_mat2_translation(matrix2: Mat2, translation: Vec2) -> Affine2
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)
sourcepub fn from_scale_angle_translation(
scale: Vec2,
angle: f32,
translation: Vec2
) -> Affine2
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)
sourcepub fn from_angle_translation(angle: f32, translation: Vec2) -> Affine2
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)
sourcepub fn from_mat3a(m: Mat3A) -> Affine2
pub fn from_mat3a(m: Mat3A) -> Affine2
The given Mat3A
must be an affine transform,
sourcepub fn to_scale_angle_translation(self) -> (Vec2, f32, Vec2)
pub fn to_scale_angle_translation(self) -> (Vec2, f32, Vec2)
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.
sourcepub fn transform_point2(&self, rhs: Vec2) -> Vec2
pub fn transform_point2(&self, rhs: Vec2) -> Vec2
Transforms the given 2D point, applying shear, scale, rotation and translation.
sourcepub fn transform_vector2(&self, rhs: Vec2) -> Vec2
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.
sourcepub fn is_finite(&self) -> bool
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
.
sourcepub fn abs_diff_eq(&self, rhs: Affine2, max_abs_diff: f32) -> bool
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.
Trait Implementations§
source§impl<'de> Deserialize<'de> for Affine2
impl<'de> Deserialize<'de> for Affine2
source§fn deserialize<D>(
deserializer: D
) -> Result<Affine2, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Affine2, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
source§impl FromReflect for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
impl FromReflect for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
source§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Affine2>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Affine2>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl GetTypeRegistration for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
impl GetTypeRegistration for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl MulAssign for Affine2
impl MulAssign for Affine2
source§fn mul_assign(&mut self, rhs: Affine2)
fn mul_assign(&mut self, rhs: Affine2)
*=
operation. Read moresource§impl PartialEq for Affine2
impl PartialEq for Affine2
source§impl Reflect for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
impl Reflect for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut dyn Any
.source§fn into_reflect(self: Box<Affine2>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Affine2>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
source§fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Affine2>) -> ReflectOwned
fn reflect_owned(self: Box<Affine2>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
source§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl Serialize for Affine2
impl Serialize for Affine2
source§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
source§impl Struct for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
impl Struct for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
source§fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
name
as a
&mut dyn Reflect
.source§fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
index
as a
&dyn Reflect
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl TypePath for Affine2
impl TypePath for Affine2
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
impl Typed for Affine2where
Affine2: Any + Send + Sync,
Mat2: FromReflect + TypePath + RegisterForReflection,
Vec2: FromReflect + TypePath + RegisterForReflection,
impl AnyBitPattern for Affine2
impl Copy for Affine2
Auto Trait Implementations§
impl Freeze for Affine2
impl RefUnwindSafe for Affine2
impl Send for Affine2
impl Sync for Affine2
impl Unpin for Affine2
impl UnwindSafe for Affine2
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
§type Bits = T
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
fn is_valid_bit_pattern(_bits: &T) -> bool
bits
as &Self
.source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more