#[repr(C)]pub struct Mat3A {
pub x_axis: Vec3A,
pub y_axis: Vec3A,
pub z_axis: Vec3A,
}
Expand description
A 3x3 column major matrix.
This 3x3 matrix type features convenience methods for creating and using linear and
affine transformations. If you are primarily dealing with 2D affine transformations the
Affine2
type is much faster and more space efficient than
using a 3x3 matrix.
Linear transformations including 3D rotation and scale can be created using methods
such as Self::from_diagonal()
, Self::from_quat()
, Self::from_axis_angle()
,
Self::from_rotation_x()
, Self::from_rotation_y()
, or
Self::from_rotation_z()
.
The resulting matrices can be use to transform 3D vectors using regular vector multiplication.
Affine transformations including 2D translation, rotation and scale can be created
using methods such as Self::from_translation()
, Self::from_angle()
,
Self::from_scale()
and Self::from_scale_angle_translation()
.
The Self::transform_point2()
and Self::transform_vector2()
convenience methods
are provided for performing affine transforms on 2D vectors and points. These multiply
2D inputs as 3D vectors with an implicit z
value of 1
for points and 0
for
vectors respectively. These methods assume that Self
contains a valid affine
transform.
Fields§
§x_axis: Vec3A
§y_axis: Vec3A
§z_axis: Vec3A
Implementations§
source§impl Mat3A
impl Mat3A
sourcepub const IDENTITY: Mat3A = _
pub const IDENTITY: Mat3A = _
A 3x3 identity matrix, where all diagonal elements are 1
, and all off-diagonal elements are 0
.
sourcepub const fn from_cols(x_axis: Vec3A, y_axis: Vec3A, z_axis: Vec3A) -> Mat3A
pub const fn from_cols(x_axis: Vec3A, y_axis: Vec3A, z_axis: Vec3A) -> Mat3A
Creates a 3x3 matrix from three column vectors.
sourcepub const fn from_cols_array(m: &[f32; 9]) -> Mat3A
pub const fn from_cols_array(m: &[f32; 9]) -> Mat3A
Creates a 3x3 matrix from a [f32; 9]
array stored in column major order.
If your data is stored in row major you will need to transpose
the returned
matrix.
sourcepub const fn to_cols_array(&self) -> [f32; 9]
pub const fn to_cols_array(&self) -> [f32; 9]
Creates a [f32; 9]
array storing data in column major order.
If you require data in row major order transpose
the matrix first.
sourcepub const fn from_cols_array_2d(m: &[[f32; 3]; 3]) -> Mat3A
pub const fn from_cols_array_2d(m: &[[f32; 3]; 3]) -> Mat3A
Creates a 3x3 matrix from a [[f32; 3]; 3]
3D array stored in column major order.
If your data is in row major order you will need to transpose
the returned
matrix.
sourcepub const fn to_cols_array_2d(&self) -> [[f32; 3]; 3]
pub const fn to_cols_array_2d(&self) -> [[f32; 3]; 3]
Creates a [[f32; 3]; 3]
3D array storing data in column major order.
If you require data in row major order transpose
the matrix first.
sourcepub const fn from_diagonal(diagonal: Vec3) -> Mat3A
pub const fn from_diagonal(diagonal: Vec3) -> Mat3A
Creates a 3x3 matrix with its diagonal set to diagonal
and all other entries set to 0.
sourcepub fn from_mat4(m: Mat4) -> Mat3A
pub fn from_mat4(m: Mat4) -> Mat3A
Creates a 3x3 matrix from a 4x4 matrix, discarding the 4th row and column.
sourcepub fn from_quat(rotation: Quat) -> Mat3A
pub fn from_quat(rotation: Quat) -> Mat3A
Creates a 3D rotation matrix from the given quaternion.
§Panics
Will panic if rotation
is not normalized when glam_assert
is enabled.
sourcepub fn from_axis_angle(axis: Vec3, angle: f32) -> Mat3A
pub fn from_axis_angle(axis: Vec3, angle: f32) -> Mat3A
Creates a 3D rotation matrix from a normalized rotation axis
and angle
(in
radians).
§Panics
Will panic if axis
is not normalized when glam_assert
is enabled.
sourcepub fn from_euler(order: EulerRot, a: f32, b: f32, c: f32) -> Mat3A
pub fn from_euler(order: EulerRot, a: f32, b: f32, c: f32) -> Mat3A
Creates a 3D rotation matrix from the given euler rotation sequence and the angles (in radians).
sourcepub fn from_rotation_x(angle: f32) -> Mat3A
pub fn from_rotation_x(angle: f32) -> Mat3A
Creates a 3D rotation matrix from angle
(in radians) around the x axis.
sourcepub fn from_rotation_y(angle: f32) -> Mat3A
pub fn from_rotation_y(angle: f32) -> Mat3A
Creates a 3D rotation matrix from angle
(in radians) around the y axis.
sourcepub fn from_rotation_z(angle: f32) -> Mat3A
pub fn from_rotation_z(angle: f32) -> Mat3A
Creates a 3D rotation matrix from angle
(in radians) around the z axis.
sourcepub fn from_translation(translation: Vec2) -> Mat3A
pub fn from_translation(translation: Vec2) -> Mat3A
Creates an affine transformation matrix from the given 2D translation
.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub fn from_angle(angle: f32) -> Mat3A
pub fn from_angle(angle: f32) -> Mat3A
Creates an affine transformation matrix from the given 2D rotation angle
(in
radians).
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub fn from_scale_angle_translation(
scale: Vec2,
angle: f32,
translation: Vec2
) -> Mat3A
pub fn from_scale_angle_translation( scale: Vec2, angle: f32, translation: Vec2 ) -> Mat3A
Creates an affine transformation matrix from the given 2D scale
, rotation angle
(in
radians) and translation
.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub fn from_scale(scale: Vec2) -> Mat3A
pub fn from_scale(scale: Vec2) -> Mat3A
Creates an affine transformation matrix from the given non-uniform 2D scale
.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
§Panics
Will panic if all elements of scale
are zero when glam_assert
is enabled.
sourcepub fn from_mat2(m: Mat2) -> Mat3A
pub fn from_mat2(m: Mat2) -> Mat3A
Creates an affine transformation matrix from the given 2x2 matrix.
The resulting matrix can be used to transform 2D points and vectors. See
Self::transform_point2()
and Self::transform_vector2()
.
sourcepub const fn from_cols_slice(slice: &[f32]) -> Mat3A
pub const fn from_cols_slice(slice: &[f32]) -> Mat3A
Creates a 3x3 matrix from the first 9 values in slice
.
§Panics
Panics if slice
is less than 9 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 9 elements in slice
.
§Panics
Panics if slice
is less than 9 elements long.
sourcepub fn col_mut(&mut self, index: usize) -> &mut Vec3A
pub fn col_mut(&mut self, index: usize) -> &mut Vec3A
Returns a mutable reference to the matrix column for the given index
.
§Panics
Panics if index
is greater than 2.
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 determinant(&self) -> f32
pub fn determinant(&self) -> f32
Returns the determinant of self
.
sourcepub fn inverse(&self) -> Mat3A
pub fn inverse(&self) -> Mat3A
Returns the inverse of self
.
If the matrix is not invertible the returned matrix will be invalid.
§Panics
Will panic if the determinant of self
is zero 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 vector as a point.
This is the equivalent of multiplying rhs
as a 3D vector where z
is 1
.
This method assumes that self
contains a valid affine transform.
§Panics
Will panic if the 2nd row of self
is not (0, 0, 1)
when glam_assert
is enabled.
sourcepub fn transform_vector2(&self, rhs: Vec2) -> Vec2
pub fn transform_vector2(&self, rhs: Vec2) -> Vec2
Rotates the given 2D vector.
This is the equivalent of multiplying rhs
as a 3D vector where z
is 0
.
This method assumes that self
contains a valid affine transform.
§Panics
Will panic if the 2nd row of self
is not (0, 0, 1)
when glam_assert
is enabled.
sourcepub fn mul_scalar(&self, rhs: f32) -> Mat3A
pub fn mul_scalar(&self, rhs: f32) -> Mat3A
Multiplies a 3x3 matrix by a scalar.
sourcepub fn div_scalar(&self, rhs: f32) -> Mat3A
pub fn div_scalar(&self, rhs: f32) -> Mat3A
Divides a 3x3 matrix by a scalar.
sourcepub fn abs_diff_eq(&self, rhs: Mat3A, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(&self, rhs: Mat3A, 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 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 as_dmat3(&self) -> DMat3
Trait Implementations§
source§impl AddAssign for Mat3A
impl AddAssign for Mat3A
source§fn add_assign(&mut self, rhs: Mat3A)
fn add_assign(&mut self, rhs: Mat3A)
+=
operation. Read moresource§impl<'de> Deserialize<'de> for Mat3A
impl<'de> Deserialize<'de> for Mat3A
source§fn deserialize<D>(
deserializer: D
) -> Result<Mat3A, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Mat3A, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
source§impl DivAssign<f32> for Mat3A
impl DivAssign<f32> for Mat3A
source§fn div_assign(&mut self, rhs: f32)
fn div_assign(&mut self, rhs: f32)
/=
operation. Read moresource§impl FromReflect for Mat3A
impl FromReflect for Mat3A
source§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Mat3A>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<Mat3A>
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 Mat3A
impl GetTypeRegistration for Mat3A
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<f32> for Mat3A
impl MulAssign<f32> for Mat3A
source§fn mul_assign(&mut self, rhs: f32)
fn mul_assign(&mut self, rhs: f32)
*=
operation. Read moresource§impl MulAssign for Mat3A
impl MulAssign for Mat3A
source§fn mul_assign(&mut self, rhs: Mat3A)
fn mul_assign(&mut self, rhs: Mat3A)
*=
operation. Read moresource§impl Reflect for Mat3A
impl Reflect for Mat3A
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<Mat3A>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Mat3A>) -> 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<Mat3A>) -> ReflectOwned
fn reflect_owned(self: Box<Mat3A>) -> 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 Mat3A
impl Serialize for Mat3A
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 Mat3A
impl Struct for Mat3A
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 SubAssign for Mat3A
impl SubAssign for Mat3A
source§fn sub_assign(&mut self, rhs: Mat3A)
fn sub_assign(&mut self, rhs: Mat3A)
-=
operation. Read moresource§impl TypePath for Mat3A
impl TypePath for Mat3A
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>
impl AnyBitPattern for Mat3A
impl Copy for Mat3A
Auto Trait Implementations§
impl Freeze for Mat3A
impl RefUnwindSafe for Mat3A
impl Send for Mat3A
impl Sync for Mat3A
impl Unpin for Mat3A
impl UnwindSafe for Mat3A
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