Struct mat3

#[repr(C)]
pub struct mat3<T>(/* private fields */);

3x3 matrix

Implementations

impl<T: Copy> mat3<T>

pub fn transpose(self) -> Self

Get transposed matrix.

Examples

let matrix = mat3::translate(vec2(1, 2));
let matrix_transposed = matrix.transpose();
for i in 0..3 {
    for j in 0..3 {
        assert_eq!(matrix[(i, j)], matrix_transposed[(j, i)]);
    }
}

impl<T: Num> mat3<T>

pub fn from_orts(x: vec2<T>, y: vec2<T>) -> Self

Construct a transformation matrix with given orts

Examples

let e1 = vec2(1.0, 2.0);
let e2 = vec2(3.0, 4.0);
let m = mat3::from_orts(e1, e2);
assert_eq!(vec2(1.0, 0.0).transform(m), e1);
assert_eq!(vec2(0.0, 1.0).transform(m), e2);
let v = vec2(2.0, 3.0);
assert_eq!(v.transform(m), e1 * v.x + e2 * v.y);

pub fn extend3d(self) -> mat4<T>

Extend this into a 3d transformation matrix, leaving z coordinate as is

impl<T: Float> mat3<T>

pub fn inverse(self) -> Self

Get inverse matrix.

Examples

let matrix = mat3::<f64>::rotate(Angle::from_radians(0.123));
let matrix_inv = matrix.inverse();
let mult = matrix * matrix_inv;
for i in 0..3 {
    for j in 0..3 {
        assert!((mult[(i, j)] - if i == j { 1.0 } else { 0.0 }).abs() < 1e-5);
    }
}

impl<T: Float> mat3<T>

pub fn ortho(aabb: Aabb2<T>) -> Self

Get 2d part of the orthographic projection matrix

impl<T: Num + Copy> mat3<T>

pub fn scale_uniform(factor: T) -> Self

Construct a uniform scale matrix.

Examples

let matrix = mat3::scale_uniform(2);
assert_eq!(matrix * vec3(1, 2, 1), vec3(2, 4, 1));

pub fn scale_uniform_around(p: vec2<T>, scale: T) -> Self

Construct matrix that performs uniform scaling around a specified point

pub fn scale_around(p: vec2<T>, scale: vec2<T>) -> Self

Construct matrix that performs scaling around a specified point

pub fn scale(factor: vec2<T>) -> Self

Construct a scale matrix.

Examples

let matrix = mat3::scale(vec2(1, 2));
assert_eq!(matrix * vec3(1, 2, 1), vec3(1, 4, 1));

pub fn translate(dv: vec2<T>) -> Self

Construct a translation matrix.

Examples

let matrix = mat3::translate(vec2(3, 2));
assert_eq!(matrix * vec3(1, 2, 1), vec3(4, 4, 1));

impl<T: Float> mat3<T>

pub fn rotate(angle: Angle<T>) -> Self

Construct rotational matrix

pub fn rotate_around(p: vec2<T>, angle: Angle<T>) -> Self

Construct matrix that performs rotation around a specified point

impl<T> mat3<T>

pub fn map<U, F: Fn(T) -> U>(self, f: F) -> mat3<U>

Map every element

impl<T: Copy> mat3<T>

pub fn new(values: [[T; 3]; 3]) -> Self

Construct a matrix.

Examples

let matrix = mat3::new([
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
]);

pub fn row(&self, row_index: usize) -> vec3<T>

Get row as a vec3

pub fn col(&self, col_index: usize) -> vec3<T>

Get column as a vec3

impl<T> mat3<T>

pub fn as_flat_array(&self) -> &[T; 9]

Get self as a flat array

pub fn as_flat_array_mut(&mut self) -> &mut [T; 9]

Get self as a mutable flat array

impl<T: Num + Copy> mat3<T>

pub fn zero() -> Self

Construct zero matrix.

Examples

let matrix = mat3::<i32>::zero();
for i in 0..3 {
    for j in 0..3 {
        assert_eq!(matrix[(i, j)], 0);
    }
}

pub fn identity() -> Self

Construct identity matrix.

Examples

let matrix = mat3::<i32>::identity();
for i in 0..3 {
    for j in 0..3 {
        assert_eq!(matrix[(i, j)], if i == j { 1 } else { 0 });
    }
}

Trait Implementations

impl<T: Num + Copy> Add for mat3<T>

type Output = mat3<T>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl<T: Num + Copy + AddAssign> AddAssign for mat3<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Float> Approx for mat3<T>

fn approx_distance_to(&self, other: &Self) -> f32

Get an approximated distance between two values

fn approx_eq(&self, other: &Self) -> bool

Check if values are approximately equal using DEFAULT_EPS

fn approx_eq_eps(&self, other: &Self, eps: f32) -> bool

Check if values are approximately equal using supplied eps value

impl<T: Clone> Clone for mat3<T>

fn clone(&self) -> mat3<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for mat3<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for mat3<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Num + Copy> Div<T> for mat3<T>

type Output = mat3<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self

Performs the / operation.

impl<T: Num + Copy + DivAssign> DivAssign<T> for mat3<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T> Index<(usize, usize)> for mat3<T>

type Output = T

The returned type after indexing.

fn index(&self, (row, col): (usize, usize)) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, usize)> for mat3<T>

fn index_mut(&mut self, (row, col): (usize, usize)) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: Num + Copy> Mul<T> for mat3<T>

type Output = mat3<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self

Performs the * operation.

impl<T: Num + Copy> Mul<vec3<T>> for mat3<T>

type Output = vec3<T>

The resulting type after applying the * operator.

fn mul(self, rhs: vec3<T>) -> vec3<T>

Performs the * operation.

impl<T: Num + Copy + AddAssign> Mul for mat3<T>

type Output = mat3<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Num + Copy + MulAssign> MulAssign<T> for mat3<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: Num + Copy + AddAssign> MulAssign for mat3<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T: Num + Copy + Neg<Output = T>> Neg for mat3<T>

type Output = mat3<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T> Serialize for mat3<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Num + Copy> Sub for mat3<T>

type Output = mat3<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl<T: Num + Copy + SubAssign> SubAssign for mat3<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T: Copy> Copy for mat3<T>