Struct valence_math::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

source

pub const ZERO: Mat3 = _

A 3x3 matrix with all elements set to 0.0.

source

pub const IDENTITY: Mat3 = _

A 3x3 identity matrix, where all diagonal elements are 1, and all off-diagonal elements are 0.

source

pub const NAN: Mat3 = _

All NAN:s.

source

pub const fn from_cols(x_axis: Vec3, y_axis: Vec3, z_axis: Vec3) -> Mat3

Creates a 3x3 matrix from three column vectors.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn from_mat4(m: Mat4) -> Mat3

Creates a 3x3 matrix from a 4x4 matrix, discarding the 4th row and column.

source

pub fn from_mat4_minor(m: Mat4, i: usize, j: usize) -> Mat3

Creates a 3x3 matrix from the minor of the given 4x4 matrix, discarding the ith column and jth row.

§Panics

Panics if i or j is greater than 3.

source

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.

source

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.

source

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).

source

pub fn to_euler(&self, order: EulerRot) -> (f32, f32, f32)

Extract Euler angles with the given Euler rotation order.

Note if the input matrix contains scales, shears, or other non-rotation transformations then the resulting Euler angles will be ill-defined.

§Panics

Will panic if any input matrix column is not normalized when glam_assert is enabled.

source

pub fn from_rotation_x(angle: f32) -> Mat3

Creates a 3D rotation matrix from angle (in radians) around the x axis.

source

pub fn from_rotation_y(angle: f32) -> Mat3

Creates a 3D rotation matrix from angle (in radians) around the y axis.

source

pub fn from_rotation_z(angle: f32) -> Mat3

Creates a 3D rotation matrix from angle (in radians) around the z axis.

source

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().

source

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().

source

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().

source

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.

source

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().

source

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.

source

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.

source

pub fn col(&self, index: usize) -> Vec3

Returns the matrix column for the given index.

§Panics

Panics if index is greater than 2.

source

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.

source

pub fn row(&self, index: usize) -> Vec3

Returns the matrix row for the given index.

§Panics

Panics if index is greater than 2.

source

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.

source

pub fn is_nan(&self) -> bool

Returns true if any elements are NaN.

source

pub fn transpose(&self) -> Mat3

Returns the transpose of self.

source

pub fn determinant(&self) -> f32

Returns the determinant of self.

source

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.

source

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.

source

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.

source

pub fn mul_vec3(&self, rhs: Vec3) -> Vec3

Transforms a 3D vector.

source

pub fn mul_vec3a(&self, rhs: Vec3A) -> Vec3A

Transforms a Vec3A.

source

pub fn mul_mat3(&self, rhs: &Mat3) -> Mat3

Multiplies two 3x3 matrices.

source

pub fn add_mat3(&self, rhs: &Mat3) -> Mat3

Adds two 3x3 matrices.

source

pub fn sub_mat3(&self, rhs: &Mat3) -> Mat3

Subtracts two 3x3 matrices.

source

pub fn mul_scalar(&self, rhs: f32) -> Mat3

Multiplies a 3x3 matrix by a scalar.

source

pub fn div_scalar(&self, rhs: f32) -> Mat3

Divides a 3x3 matrix by a scalar.

source

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.

source

pub fn abs(&self) -> Mat3

Takes the absolute value of each element in self

source

pub fn as_dmat3(&self) -> DMat3

Trait Implementations§

source§

impl Add for Mat3

source§

type Output = Mat3

The resulting type after applying the + operator.
source§

fn add(self, rhs: Mat3) -> <Mat3 as Add>::Output

Performs the + operation. Read more
source§

impl AddAssign for Mat3

source§

fn add_assign(&mut self, rhs: Mat3)

Performs the += operation. Read more
source§

impl AsMut<[f32; 9]> for Mat3

source§

fn as_mut(&mut self) -> &mut [f32; 9]

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl AsRef<[f32; 9]> for Mat3

source§

fn as_ref(&self) -> &[f32; 9]

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for Mat3

source§

fn clone(&self) -> Mat3

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Mat3

source§

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Default for Mat3

source§

fn default() -> Mat3

Returns the “default value” for a type. Read more
source§

impl Display for Mat3

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
source§

impl Div<f32> for Mat3

source§

type Output = Mat3

The resulting type after applying the / operator.
source§

fn div(self, rhs: f32) -> <Mat3 as Div<f32>>::Output

Performs the / operation. Read more
source§

impl DivAssign<f32> for Mat3

source§

fn div_assign(&mut self, rhs: f32)

Performs the /= operation. Read more
source§

impl From<Affine2> for Mat3

source§

fn from(m: Affine2) -> Mat3

Converts to this type from the input type.
source§

impl From<Mat3> for Mat3A

source§

fn from(m: Mat3) -> Mat3A

Converts to this type from the input type.
source§

impl From<Mat3A> for Mat3

source§

fn from(m: Mat3A) -> Mat3

Converts to this type from the input type.
source§

impl Mul<Affine2> for Mat3

source§

type Output = Mat3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: Affine2) -> <Mat3 as Mul<Affine2>>::Output

Performs the * operation. Read more
source§

impl Mul<Mat3> for Affine2

source§

type Output = Mat3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: Mat3) -> <Affine2 as Mul<Mat3>>::Output

Performs the * operation. Read more
source§

impl Mul<Vec3> for Mat3

source§

type Output = Vec3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: Vec3) -> <Mat3 as Mul<Vec3>>::Output

Performs the * operation. Read more
source§

impl Mul<Vec3A> for Mat3

source§

type Output = Vec3A

The resulting type after applying the * operator.
source§

fn mul(self, rhs: Vec3A) -> Vec3A

Performs the * operation. Read more
source§

impl Mul<f32> for Mat3

source§

type Output = Mat3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: f32) -> <Mat3 as Mul<f32>>::Output

Performs the * operation. Read more
source§

impl Mul for Mat3

source§

type Output = Mat3

The resulting type after applying the * operator.
source§

fn mul(self, rhs: Mat3) -> <Mat3 as Mul>::Output

Performs the * operation. Read more
source§

impl MulAssign<f32> for Mat3

source§

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation. Read more
source§

impl MulAssign for Mat3

source§

fn mul_assign(&mut self, rhs: Mat3)

Performs the *= operation. Read more
source§

impl Neg for Mat3

source§

type Output = Mat3

The resulting type after applying the - operator.
source§

fn neg(self) -> <Mat3 as Neg>::Output

Performs the unary - operation. Read more
source§

impl PartialEq for Mat3

source§

fn eq(&self, rhs: &Mat3) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> Product<&'a Mat3> for Mat3

source§

fn product<I>(iter: I) -> Mat3
where I: Iterator<Item = &'a Mat3>,

Takes an iterator and generates Self from the elements by multiplying the items.
source§

impl Product for Mat3

source§

fn product<I>(iter: I) -> Mat3
where I: Iterator<Item = Mat3>,

Takes an iterator and generates Self from the elements by multiplying the items.
source§

impl Sub for Mat3

source§

type Output = Mat3

The resulting type after applying the - operator.
source§

fn sub(self, rhs: Mat3) -> <Mat3 as Sub>::Output

Performs the - operation. Read more
source§

impl SubAssign for Mat3

source§

fn sub_assign(&mut self, rhs: Mat3)

Performs the -= operation. Read more
source§

impl<'a> Sum<&'a Mat3> for Mat3

source§

fn sum<I>(iter: I) -> Mat3
where I: Iterator<Item = &'a Mat3>,

Takes an iterator and generates Self from the elements by “summing up” the items.
source§

impl Sum for Mat3

source§

fn sum<I>(iter: I) -> Mat3
where I: Iterator<Item = Mat3>,

Takes an iterator and generates Self from the elements by “summing up” the items.
source§

impl Copy 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§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.