Struct bevy_math::Mat3

#[repr(C)]pub struct Mat3 { /* fields omitted */ }

A 3x3 column major matrix.

This type is 16 byte aligned.

Implementations

impl Mat3

pub fn zero() -> Mat3

Creates a 3x3 matrix with all elements set to 0.0.

pub fn identity() -> Mat3

Creates a 3x3 identity matrix.

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

Creates a 3x3 matrix from three column vectors.

pub fn from_cols_array(m: &[f32; 9]) -> Mat3

Creates a 3x3 matrix from a [f32; 9] stored in column major order. If your data is stored in row major you will need to transpose the returned matrix.

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

Creates a [f32; 9] storing data in column major order. If you require data in row major order transpose the matrix first.

pub fn from_cols_array_2d(m: &[[f32; 3]; 3]) -> Mat3

Creates a 3x3 matrix from a [[f32; 3]; 3] stored in column major order. If your data is in row major order you will need to transpose the returned matrix.

pub fn to_cols_array_2d(&self) -> [[f32; 3]; 3]

Creates a [[f32; 3]; 3] storing data in column major order. If you require data in row major order transpose the matrix first.

pub fn from_scale_angle_translation(
    scale: Vec2,
    angle: f32,
    translation: Vec2
) -> Mat3

Creates a 3x3 homogeneous transformation matrix from the given scale, rotation angle (in radians) and translation.

The resulting matrix can be used to transform 2D points and vectors.

pub fn from_quat(rotation: Quat) -> Mat3

Creates a 3x3 rotation matrix from the given quaternion.

pub fn from_axis_angle(axis: Vec3, angle: f32) -> Mat3

Creates a 3x3 rotation matrix from a normalized rotation axis and angle (in radians).

pub fn from_rotation_ypr(yaw: f32, pitch: f32, roll: f32) -> Mat3

Creates a 3x3 rotation matrix from the given Euler angles (in radians).

pub fn from_rotation_x(angle: f32) -> Mat3

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

pub fn from_rotation_y(angle: f32) -> Mat3

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

pub fn from_rotation_z(angle: f32) -> Mat3

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

pub fn from_scale(scale: Vec3) -> Mat3

Creates a 3x3 non-uniform scale matrix.

pub fn set_x_axis(&mut self, x: Vec3)

pub fn set_y_axis(&mut self, y: Vec3)

pub fn set_z_axis(&mut self, z: Vec3)

pub fn x_axis(&self) -> Vec3

pub fn y_axis(&self) -> Vec3

pub fn z_axis(&self) -> Vec3

pub fn x_axis_mut(&mut self) -> &mut Vec3

pub fn y_axis_mut(&mut self) -> &mut Vec3

pub fn z_axis_mut(&mut self) -> &mut Vec3

pub fn transpose(&self) -> Mat3

Returns the transpose of self.

pub fn determinant(&self) -> f32

Returns the determinant of self.

pub fn inverse(&self) -> Mat3

Returns the inverse of self.

If the matrix is not invertible the returned matrix will be invalid.

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

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

Transforms a 3D vector.

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

Multiplies two 3x3 matrices.

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

Adds two 3x3 matrices.

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

Subtracts two 3x3 matrices.

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

Multiplies a 3x3 matrix by a scalar.

pub fn transform_point2(&self, other: Vec2) -> Vec2

Transforms the given Vec2 as 2D point. This is the equivalent of multiplying the Vec2 as a Vec3 where z is 1.0.

pub fn transform_vector2(&self, other: Vec2) -> Vec2

Transforms the given Vec2 as 2D vector. This is the equivalent of multiplying the Vec2 as a Vec3 where z is 0.0.

pub fn abs_diff_eq(&self, other: Mat3, 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 Mat3's 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 on floating point comparisons see https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/

Trait Implementations

impl Add<Mat3> for Mat3

type Output = Mat3

The resulting type after applying the + operator.

fn add(self, other: Mat3) -> Mat3

Performs the + operation.

impl Clone for Mat3

fn clone(&self) -> Mat3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mat3

impl Debug for Mat3

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

Formats the value using the given formatter.

impl Default for Mat3

fn default() -> Mat3

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Mat3

fn deserialize<D>(
    deserializer: D
) -> Result<Mat3, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Mat3

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

Formats the value using the given formatter.

impl Mul<Mat3> for Mat3

type Output = Mat3

The resulting type after applying the * operator.

fn mul(self, other: Mat3) -> Mat3

Performs the * operation.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, other: Vec3) -> Vec3

Performs the * operation.

impl Mul<Vec3A> for Mat3

type Output = Vec3A

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Mat3

type Output = Mat3

The resulting type after applying the * operator.

fn mul(self, other: f32) -> Mat3

Performs the * operation.

impl PartialEq<Mat3> for Mat3

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Mat3> for Mat3

fn partial_cmp(&self, other: &Mat3) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Mat3) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Mat3) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Mat3) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Mat3) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Mat3

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.

impl StructuralPartialEq for Mat3

impl Sub<Mat3> for Mat3

type Output = Mat3

The resulting type after applying the - operator.

fn sub(self, other: Mat3) -> Mat3

Performs the - operation.