Struct bones_framework::prelude::Mat3
source · #[repr(C)]pub struct Mat3 {
pub x_axis: Vec3,
pub y_axis: Vec3,
pub z_axis: Vec3,
}
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: Vec3
§y_axis: Vec3
§z_axis: Vec3
Implementations§
source§impl Mat3
impl Mat3
sourcepub const IDENTITY: Mat3 = _
pub const IDENTITY: Mat3 = _
A 3x3 identity matrix, where all diagonal elements are 1
, and all off-diagonal elements are 0
.
sourcepub const fn from_cols(x_axis: Vec3, y_axis: Vec3, z_axis: Vec3) -> Mat3
pub const fn from_cols(x_axis: Vec3, y_axis: Vec3, z_axis: Vec3) -> Mat3
Creates a 3x3 matrix from three column vectors.
sourcepub const fn from_cols_array(m: &[f32; 9]) -> Mat3
pub const fn from_cols_array(m: &[f32; 9]) -> Mat3
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]) -> Mat3
pub const fn from_cols_array_2d(m: &[[f32; 3]; 3]) -> Mat3
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) -> Mat3
pub const fn from_diagonal(diagonal: Vec3) -> Mat3
Creates a 3x3 matrix with its diagonal set to diagonal
and all other entries set to 0.
sourcepub fn from_mat4(m: Mat4) -> Mat3
pub fn from_mat4(m: Mat4) -> Mat3
Creates a 3x3 matrix from a 4x4 matrix, discarding the 4th row and column.
sourcepub fn from_quat(rotation: Quat) -> Mat3
pub fn from_quat(rotation: Quat) -> Mat3
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) -> Mat3
pub fn from_axis_angle(axis: Vec3, angle: f32) -> Mat3
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) -> Mat3
pub fn from_euler(order: EulerRot, a: f32, b: f32, c: f32) -> Mat3
Creates a 3D rotation matrix from the given euler rotation sequence and the angles (in radians).
sourcepub fn from_rotation_x(angle: f32) -> Mat3
pub fn from_rotation_x(angle: f32) -> Mat3
Creates a 3D rotation matrix from angle
(in radians) around the x axis.
sourcepub fn from_rotation_y(angle: f32) -> Mat3
pub fn from_rotation_y(angle: f32) -> Mat3
Creates a 3D rotation matrix from angle
(in radians) around the y axis.
sourcepub fn from_rotation_z(angle: f32) -> Mat3
pub fn from_rotation_z(angle: f32) -> Mat3
Creates a 3D rotation matrix from angle
(in radians) around the z axis.
sourcepub fn from_translation(translation: Vec2) -> Mat3
pub fn from_translation(translation: Vec2) -> Mat3
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) -> Mat3
pub fn from_angle(angle: f32) -> Mat3
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,
) -> Mat3
pub fn from_scale_angle_translation( scale: Vec2, angle: f32, translation: Vec2, ) -> Mat3
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) -> Mat3
pub fn from_scale(scale: Vec2) -> Mat3
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) -> Mat3
pub fn from_mat2(m: Mat2) -> Mat3
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]) -> Mat3
pub const fn from_cols_slice(slice: &[f32]) -> Mat3
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 Vec3
pub fn col_mut(&mut self, index: usize) -> &mut Vec3
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) -> Mat3
pub fn inverse(&self) -> Mat3
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) -> Mat3
pub fn mul_scalar(&self, rhs: f32) -> Mat3
Multiplies a 3x3 matrix by a scalar.
sourcepub fn abs_diff_eq(&self, rhs: Mat3, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(&self, rhs: Mat3, 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 Mat3
impl AddAssign for Mat3
source§fn add_assign(&mut self, rhs: Mat3)
fn add_assign(&mut self, rhs: Mat3)
+=
operation. Read moresource§impl<'de> Deserialize<'de> for Mat3
impl<'de> Deserialize<'de> for Mat3
source§fn deserialize<D>(
deserializer: D,
) -> Result<Mat3, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<Mat3, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
source§impl MulAssign<f32> for Mat3
impl MulAssign<f32> for Mat3
source§fn mul_assign(&mut self, rhs: f32)
fn mul_assign(&mut self, rhs: f32)
*=
operation. Read moresource§impl MulAssign for Mat3
impl MulAssign for Mat3
source§fn mul_assign(&mut self, rhs: Mat3)
fn mul_assign(&mut self, rhs: Mat3)
*=
operation. Read moresource§impl Serialize for Mat3
impl Serialize for Mat3
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 SubAssign for Mat3
impl SubAssign for Mat3
source§fn sub_assign(&mut self, rhs: Mat3)
fn sub_assign(&mut self, rhs: Mat3)
-=
operation. Read moreimpl Copy for Mat3
impl Pod for Mat3
Auto Trait Implementations§
impl Freeze for Mat3
impl RefUnwindSafe for Mat3
impl Send for Mat3
impl Sync for Mat3
impl Unpin for Mat3
impl UnwindSafe for Mat3
Blanket Implementations§
§impl<T> AnyEq for T
impl<T> AnyEq for T
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
§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
.§fn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
bits
as &Self
.source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &World) -> T
fn from_world(_world: &World) -> T
Self
using data from the given World
.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> RawDefault for Twhere
T: Default,
impl<T> RawDefault for Twhere
T: Default,
source§impl<T> Serialize for T
impl<T> Serialize for T
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>
fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.