Expand description
A 3D affine transform, which can represent translation, rotation, scaling and shear.
The type is composed of a 3x3 matrix containing a linear transformation (e.g. scale, rotation, shear, reflection) and a 3D vector translation.
Fields
matrix3: Mat3A
translation: Vec3A
Implementations
sourceimpl Affine3A
impl Affine3A
sourcepub fn transform_point3a(&self, other: Vec3A) -> Vec3A
pub fn transform_point3a(&self, other: Vec3A) -> Vec3A
Transforms the given Vec3A
, applying shear, scale, rotation and translation.
sourcepub fn transform_vector3a(&self, other: Vec3A) -> Vec3A
pub fn transform_vector3a(&self, other: Vec3A) -> Vec3A
Transforms the given Vec3A
, applying shear, scale and rotation (but NOT
translation).
To also apply translation, use Self::transform_point3
instead.
sourceimpl Affine3A
impl Affine3A
sourcepub const ZERO: Affine3A
pub const ZERO: Affine3A
The degenerate zero transform.
This transforms any finite vector and point to zero. The zero transform is non-invertible.
sourcepub const IDENTITY: Affine3A
pub const IDENTITY: Affine3A
The identity transform.
Multiplying a vector with this returns the same vector.
sourcepub fn from_cols(
x_axis: Vec3A,
y_axis: Vec3A,
z_axis: Vec3A,
w_axis: Vec3A
) -> Affine3A
pub fn from_cols(
x_axis: Vec3A,
y_axis: Vec3A,
z_axis: Vec3A,
w_axis: Vec3A
) -> Affine3A
Creates an affine transform from four 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 [S; 12]
array stored in column major order.
If your data is stored in row major you will need to transpose
the returned
matrix.
sourcepub fn to_cols_array(&self) -> [f32; 12]
pub fn to_cols_array(&self) -> [f32; 12]
Creates a [S; 12]
array storing data in column major order.
If you require data in row major order transpose
the matrix first.
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 [[S; 3]; 4]
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; 3]; 4]
pub fn to_cols_array_2d(&self) -> [[f32; 3]; 4]
Creates a [[S; 3]; 4]
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]) -> 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 Affine3::from_translation(translation) * Affine3::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 Affine3::from_translation(translation) * Affine3::from_quat(rotation) * Affine3::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 Affine3::from_translation(translation) * Affine3::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, other: Vec3) -> Vec3
pub fn transform_point3(&self, other: Vec3) -> Vec3
Transforms the given 3D points, applying shear, scale, rotation and translation.
sourcepub fn transform_vector3(&self, other: Vec3) -> Vec3
pub fn transform_vector3(&self, other: 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 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, other: Affine3A, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(&self, other: Affine3A, max_abs_diff: f32) -> bool
Returns true if the absolute difference of all elements between self
and other
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
sourcepub fn deserialize<D>(
deserializer: D
) -> Result<Affine3A, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub 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
sourceimpl Serialize for Affine3A
impl Serialize for Affine3A
sourcepub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub 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 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub 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,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
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
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub 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
pub fn as_any(&self) -> &(dyn Any + 'static)
pub 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
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub 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,
pub fn from_world(_world: &mut World) -> T
pub fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
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,
pub fn erased_serialize(
&self,
serializer: &mut dyn Serializer
) -> Result<Ok, Error>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>ⓘNotable traits for Box<F, A>impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
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