Expand description
A 2D affine transform, which can represent translation, rotation, scaling and shear.
Fields
matrix2: Mat2
translation: Vec2
Implementations
sourceimpl Affine2
impl Affine2
sourcepub const ZERO: Affine2 = Self{ matrix2: Mat2::ZERO, translation: Vec2::ZERO,}
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.
sourcepub const IDENTITY: Affine2 = Self{ matrix2: Mat2::IDENTITY, translation: Vec2::ZERO,}
pub const IDENTITY: Affine2 = Self{ matrix2: Mat2::IDENTITY, translation: Vec2::ZERO,}
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 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
sourceimpl<'de> Deserialize<'de> for Affine2
impl<'de> Deserialize<'de> for Affine2
sourcefn 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>,
Deserialize this value from the given Serde deserializer. Read more
impl FromReflect for Affine2 where
Mat2: FromReflect,
Vec2: FromReflect,
impl FromReflect for Affine2 where
Mat2: FromReflect,
Vec2: FromReflect,
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Affine2>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Affine2>
Constructs a concrete instance of Self
from a reflected value.
impl GetTypeRegistration for Affine2
impl GetTypeRegistration for Affine2
sourceimpl PartialEq<Affine2> for Affine2
impl PartialEq<Affine2> for Affine2
impl Reflect for Affine2
impl Reflect for Affine2
fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
fn into_any(self: Box<Affine2, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<Affine2, Global>) -> Box<dyn Any + 'static, Global>
Returns the value as a Box<dyn Any>
.
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Returns the value as a &mut dyn Any
.
fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
Casts this type to a reflected value
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
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>
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
Clones the value as a Reflect
trait object. Read more
fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
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. Read more
fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
Applies a reflected value to this value. Read more
fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
Returns an enumeration of “kinds” of type. Read more
fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
Returns a mutable enumeration of “kinds” of type. Read more
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
Returns a “partial equality” comparison result. Read more
fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
Returns a hash of the value (which includes the type). Read more
fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
Returns a serializable version of the value. Read more
sourceimpl Serialize for Affine2
impl Serialize for Affine2
sourcefn 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,
Serialize this value into the given Serde serializer. Read more
impl Struct for Affine2
impl Struct for Affine2
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
Returns a reference to the value of the field named name
as a &dyn Reflect
. Read more
fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
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
. Read more
fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
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
. Read more
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)>
Returns a mutable reference to the value of the field with index index
as a &mut dyn Reflect
. Read more
fn iter_fields(&self) -> FieldIter<'_>ⓘNotable traits for FieldIter<'a>impl<'a> Iterator for FieldIter<'a> type Item = &'a (dyn Reflect + 'static);
fn iter_fields(&self) -> FieldIter<'_>ⓘNotable traits for FieldIter<'a>impl<'a> Iterator for FieldIter<'a> type Item = &'a (dyn Reflect + 'static);
Returns an iterator over the values of the struct’s fields.
fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
Clones the struct into a DynamicStruct
.
impl Copy for Affine2
Auto Trait Implementations
impl RefUnwindSafe for Affine2
impl Send for Affine2
impl Sync for Affine2
impl Unpin for Affine2
impl UnwindSafe for Affine2
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
Return the T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert 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
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
impl<S> GetField for S where
S: Struct,
impl<S> GetField for S where
S: Struct,
impl<T> GetPath for T where
T: Reflect,
impl<T> GetPath for T where
T: Reflect,
fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
Returns a reference to the value specified by path
. Read more
fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
Returns a mutable reference to the value specified by path
. Read more
fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,
fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,
Returns a statically typed reference to the value specified by path
.
fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,
fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,
Returns a statically typed mutable reference to the value specified by
path
. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> Serialize for T where
T: Serialize + ?Sized,
impl<T> Serialize for T where
T: Serialize + ?Sized,
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more