Skip to main content

Mat4

Struct Mat4 

Source
pub struct Mat4 { /* private fields */ }
Expand description

A 4x4 matrix that moves, turns and scales points in 3D. It maps a point p to M * (p, 1), so the last column holds the translation.

Implementations§

Source§

impl Mat4

Source

pub const IDENTITY: Mat4

The matrix that leaves every point where it is.

Source

pub const fn from_rows(rows: [[f32; 4]; 4]) -> Mat4

The matrix with these rows.

Source

pub const fn rows(&self) -> [[f32; 4]; 4]

The matrix’s rows.

Source

pub const fn from_axes(x: Vec3, y: Vec3, z: Vec3, origin: Vec3) -> Mat4

The matrix whose columns map the x, y and z axes onto x, y and z and the origin onto origin.

Source

pub const fn translation(offset: Vec3) -> Mat4

Moves every point by offset.

Source

pub const fn scaling(factors: Vec3) -> Mat4

Scales each axis by its factor about the origin.

Source

pub fn rotation_x(radians: f32) -> Mat4

Turns points about the x axis by radians. A positive angle tips the y axis, which points down, away from the viewer.

Source

pub fn rotation_y(radians: f32) -> Mat4

Turns points about the y axis by radians. A positive angle swings the x axis away from the viewer.

Source

pub fn rotation_z(radians: f32) -> Mat4

Turns points about the z axis by radians. A positive angle turns clockwise on screen.

Source

pub fn then(&self, next: &Mat4) -> Mat4

This matrix followed by next: next * self.

Source

pub fn transform_point(&self, point: Vec3) -> Vec3

Maps point, dividing by the resulting w.

Source

pub fn transform_homogeneous(&self, point: Vec3) -> [f32; 4]

Maps point and returns all four coordinates of the result, before any division by w.

Source

pub fn transform_vector(&self, vector: Vec3) -> Vec3

Maps a direction: the translation does not apply.

Source

pub fn length_scale(&self) -> f32

How long the map makes a unit length, averaged over the three axes: the cube root of how much it scales volume.

Source

pub fn transpose(&self) -> Mat4

The transpose.

Source

pub fn inverse(&self) -> Option<Mat4>

The inverse, or None when the matrix flattens space.

Trait Implementations§

Source§

impl Clone for Mat4

Source§

fn clone(&self) -> Mat4

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Mat4

Source§

impl Debug for Mat4

Source§

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

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

impl Default for Mat4

Source§

fn default() -> Mat4

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

impl PartialEq for Mat4

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Mat4

Auto Trait Implementations§

§

impl Freeze for Mat4

§

impl RefUnwindSafe for Mat4

§

impl Send for Mat4

§

impl Sync for Mat4

§

impl Unpin for Mat4

§

impl UnsafeUnpin for Mat4

§

impl UnwindSafe for Mat4

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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, dest: *mut u8)

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

impl<T> ErasedDestructor for T
where T: 'static,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutData for T
where T: Any + Debug + PartialEq,

Source§

fn same_as(&self, other: &(dyn LayoutData + 'static)) -> bool

Whether other holds the same data, so a parent can keep its last measure.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

The data as Any, to read it by its type.
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.