Expand description
A 3D affine transform, which can represent translation, rotation, scaling and shear.
Fields
matrix3: Mat3A
translation: Vec3A
Implementations
sourceimpl Affine3A
impl Affine3A
sourcepub const ZERO: Affine3A = Self{ matrix3: Mat3A::ZERO, translation: Vec3A::ZERO,}
pub const ZERO: Affine3A = Self{ matrix3: Mat3A::ZERO, translation: Vec3A::ZERO,}
The degenerate zero transform.
This transforms any finite vector and point to zero. The zero transform is non-invertible.
sourcepub const IDENTITY: Affine3A = Self{ matrix3: Mat3A::IDENTITY, translation: Vec3A::ZERO,}
pub const IDENTITY: Affine3A = Self{ matrix3: Mat3A::IDENTITY, translation: Vec3A::ZERO,}
The identity transform.
Multiplying a vector with this returns the same vector.
sourcepub const fn from_cols(
x_axis: Vec3A,
y_axis: Vec3A,
z_axis: Vec3A,
w_axis: Vec3A
) -> Affine3A
pub const fn from_cols(
x_axis: Vec3A,
y_axis: Vec3A,
z_axis: Vec3A,
w_axis: Vec3A
) -> Affine3A
Creates an affine transform from three column vectors.
sourcepub fn from_cols_array(m: &[f32; 12]) -> Affine3A
pub fn from_cols_array(m: &[f32; 12]) -> Affine3A
Creates an affine transform from a [f32; 12]
array stored in column major order.
sourcepub fn to_cols_array(&self) -> [f32; 12]
pub fn to_cols_array(&self) -> [f32; 12]
Creates a [f32; 12]
array storing data in column major order.
sourcepub fn from_cols_array_2d(m: &[[f32; 3]; 4]) -> Affine3A
pub fn from_cols_array_2d(m: &[[f32; 3]; 4]) -> Affine3A
Creates an affine transform from a [[f32; 3]; 4]
3D 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; 3]; 4]
pub fn to_cols_array_2d(&self) -> [[f32; 3]; 4]
Creates a [[f32; 3]; 4]
3D 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]) -> Affine3A
pub fn from_cols_slice(slice: &[f32]) -> Affine3A
Creates an affine transform from the first 12 values in slice
.
Panics
Panics if slice
is less than 12 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 12 elements in slice
.
Panics
Panics if slice
is less than 12 elements long.
sourcepub fn from_scale(scale: Vec3) -> Affine3A
pub fn from_scale(scale: Vec3) -> Affine3A
Creates an affine transform that changes scale. Note that if any scale is zero the transform will be non-invertible.
sourcepub fn from_quat(rotation: Quat) -> Affine3A
pub fn from_quat(rotation: Quat) -> Affine3A
Creates an affine transform from the given rotation
quaternion.
sourcepub fn from_axis_angle(axis: Vec3, angle: f32) -> Affine3A
pub fn from_axis_angle(axis: Vec3, angle: f32) -> Affine3A
Creates an affine transform containing a 3D rotation around a normalized
rotation axis
of angle
(in radians).
sourcepub fn from_rotation_x(angle: f32) -> Affine3A
pub fn from_rotation_x(angle: f32) -> Affine3A
Creates an affine transform containing a 3D rotation around the x axis of
angle
(in radians).
sourcepub fn from_rotation_y(angle: f32) -> Affine3A
pub fn from_rotation_y(angle: f32) -> Affine3A
Creates an affine transform containing a 3D rotation around the y axis of
angle
(in radians).
sourcepub fn from_rotation_z(angle: f32) -> Affine3A
pub fn from_rotation_z(angle: f32) -> Affine3A
Creates an affine transform containing a 3D rotation around the z axis of
angle
(in radians).
sourcepub fn from_translation(translation: Vec3) -> Affine3A
pub fn from_translation(translation: Vec3) -> Affine3A
Creates an affine transformation from the given 3D translation
.
sourcepub fn from_mat3(mat3: Mat3) -> Affine3A
pub fn from_mat3(mat3: Mat3) -> Affine3A
Creates an affine transform from a 3x3 matrix (expressing scale, shear and rotation)
sourcepub fn from_mat3_translation(mat3: Mat3, translation: Vec3) -> Affine3A
pub fn from_mat3_translation(mat3: Mat3, translation: Vec3) -> Affine3A
Creates an affine transform from a 3x3 matrix (expressing scale, shear and rotation) and a translation vector.
Equivalent to Affine3A::from_translation(translation) * Affine3A::from_mat3(mat3)
sourcepub fn from_scale_rotation_translation(
scale: Vec3,
rotation: Quat,
translation: Vec3
) -> Affine3A
pub fn from_scale_rotation_translation(
scale: Vec3,
rotation: Quat,
translation: Vec3
) -> Affine3A
Creates an affine transform from the given 3D scale
, rotation
and
translation
.
Equivalent to Affine3A::from_translation(translation) * Affine3A::from_quat(rotation) * Affine3A::from_scale(scale)
sourcepub fn from_rotation_translation(rotation: Quat, translation: Vec3) -> Affine3A
pub fn from_rotation_translation(rotation: Quat, translation: Vec3) -> Affine3A
Creates an affine transform from the given 3D rotation
and translation
.
Equivalent to Affine3A::from_translation(translation) * Affine3A::from_quat(rotation)
sourcepub fn from_mat4(m: Mat4) -> Affine3A
pub fn from_mat4(m: Mat4) -> Affine3A
The given Mat4
must be an affine transform,
i.e. contain no perspective transform.
sourcepub fn to_scale_rotation_translation(&self) -> (Vec3, Quat, Vec3)
pub fn to_scale_rotation_translation(&self) -> (Vec3, Quat, Vec3)
Extracts scale
, rotation
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.matrix3
is zero or if the resulting scale
vector contains any zero elements when glam_assert
is enabled.
sourcepub fn look_at_lh(eye: Vec3, center: Vec3, up: Vec3) -> Affine3A
pub fn look_at_lh(eye: Vec3, center: Vec3, up: Vec3) -> Affine3A
Creates a left-handed view transform using a camera position, an up direction, and a focal point.
For a view coordinate system with +X=right
, +Y=up
and +Z=forward
.
Panics
Will panic if up
is not normalized when glam_assert
is enabled.
sourcepub fn look_at_rh(eye: Vec3, center: Vec3, up: Vec3) -> Affine3A
pub fn look_at_rh(eye: Vec3, center: Vec3, up: Vec3) -> Affine3A
Creates a right-handed view transform using a camera position, an up direction, and a focal point.
For a view coordinate system with +X=right
, +Y=up
and +Z=back
.
Panics
Will panic if up
is not normalized when glam_assert
is enabled.
sourcepub fn transform_point3(&self, rhs: Vec3) -> Vec3
pub fn transform_point3(&self, rhs: Vec3) -> Vec3
Transforms the given 3D points, applying shear, scale, rotation and translation.
sourcepub fn transform_vector3(&self, rhs: Vec3) -> Vec3
pub fn transform_vector3(&self, rhs: Vec3) -> Vec3
Transforms the given 3D vector, applying shear, scale and rotation (but NOT translation).
To also apply translation, use Self::transform_point3
instead.
sourcepub fn transform_point3a(&self, rhs: Vec3A) -> Vec3A
pub fn transform_point3a(&self, rhs: Vec3A) -> Vec3A
Transforms the given Vec3A
, applying shear, scale, rotation and translation.
sourcepub fn transform_vector3a(&self, rhs: Vec3A) -> Vec3A
pub fn transform_vector3a(&self, rhs: Vec3A) -> Vec3A
Transforms the given Vec3A
, applying shear, scale and rotation (but NOT
translation).
To also apply translation, use Self::transform_point3
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: Affine3A, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(&self, rhs: Affine3A, 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 Affine3A
impl<'de> Deserialize<'de> for Affine3A
sourcefn deserialize<D>(
deserializer: D
) -> Result<Affine3A, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Affine3A, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl From<Affine3A> for GlobalTransform
impl From<Affine3A> for GlobalTransform
fn from(affine: Affine3A) -> GlobalTransform
fn from(affine: Affine3A) -> GlobalTransform
Converts to this type from the input type.
impl FromReflect for Affine3A where
Mat3A: FromReflect,
Vec3A: FromReflect,
impl FromReflect for Affine3A where
Mat3A: FromReflect,
Vec3A: FromReflect,
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Affine3A>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Affine3A>
Constructs a concrete instance of Self
from a reflected value.
impl GetTypeRegistration for Affine3A
impl GetTypeRegistration for Affine3A
sourceimpl PartialEq<Affine3A> for Affine3A
impl PartialEq<Affine3A> for Affine3A
impl Reflect for Affine3A
impl Reflect for Affine3A
fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
fn into_any(self: Box<Affine3A, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<Affine3A, 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 Affine3A
impl Serialize for Affine3A
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 Affine3A
impl Struct for Affine3A
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 Affine3A
Auto Trait Implementations
impl RefUnwindSafe for Affine3A
impl Send for Affine3A
impl Sync for Affine3A
impl Unpin for Affine3A
impl UnwindSafe for Affine3A
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