Struct ultraviolet::mat::Mat4x4

#[repr(C)]pub struct Mat4x4 {
    pub cols: [Vec4x4; 4],
}

A 4x4 square matrix.

Useful for performing linear transformations (rotation, scaling) on 4d vectors, or for performing arbitrary transformations (linear + translation, projection, etc) on homogeneous 3d vectors.

Note that most constructors assume that the matrix will be used as a homogeneous 3d transformation matrix.

Fields

cols: [Vec4x4; 4]

Implementations

impl Mat4x4

pub const fn new(col1: Vec4x4, col2: Vec4x4, col3: Vec4x4, col4: Vec4x4) -> Self

pub fn identity() -> Self

pub fn from_translation(trans: Vec3x4) -> Self

Assumes homogeneous 3d coordinates.

pub fn from_scale(scale: f32x4) -> Self

Assumes homogeneous 3d coordinates.

pub fn from_nonuniform_scale(scale: Vec3x4) -> Self

Assumes homogeneous 3d coordinates.

pub fn from_scale_4d(scale: f32x4) -> Self

Full 4d diagonal matrix.

pub fn from_nonuniform_scale_4d(scale: Vec4x4) -> Self

Full 4d nonuniform scaling matrix.

pub fn from_euler_angles(roll: f32x4, pitch: f32x4, yaw: f32x4) -> Self

Angles are applied in the order roll -> pitch -> yaw

• Roll is rotation inside the xy plane (“around the z axis”)
• Pitch is rotation inside the yz plane (“around the x axis”)
• Yaw is rotation inside the xz plane (“around the y axis”)

Assumes homogeneous 3d coordinates.

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_rotation_x(angle: f32x4) -> Self

Create a new rotation matrix from a rotation “about the x axis”. This is here as a convenience function for users coming from other libraries; it is more proper to think of this as a rotation in the yz plane.

Assumes homogeneous 3d coordinates.

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_rotation_y(angle: f32x4) -> Self

Create a new rotation matrix from a rotation “about the y axis”. This is here as a convenience function for users coming from other libraries; it is more proper to think of this as a rotation in the xz plane.

Assumes homogeneous 3d coordinates.

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_rotation_z(angle: f32x4) -> Self

Create a new rotation matrix from a rotation “about the z axis”. This is here as a convenience function for users coming from other libraries; it is more proper to think of this as a rotation in the xy plane.

Assumes homogeneous 3d coordinates.

Important: This function assumes a right-handed, y-up coordinate space where:

• +X axis points right
• +Y axis points up
• +Z axis points towards the viewer (i.e. out of the screen)

This means that you may see unexpected behavior when used with OpenGL or DirectX as they use a different coordinate system. You should use the appropriate projection matrix in projection module to fit your use case to remedy this.

pub fn from_angle_plane(angle: f32x4, plane: Bivec3x4) -> Self

Construct a rotation matrix given a bivector which defines a plane and rotation orientation, and a rotation angle.

plane must be normalized!

This is the equivalent of an axis-angle rotation.

Assumes homogeneous 3d coordinates.

pub fn translate(&mut self, translation: &Vec3x4)

Assumes homogeneous 3d coordinates.

pub fn translated(&self, translation: &Vec3x4) -> Self

Assumes homogeneous 3d coordinates.

pub fn look_at(eye: Vec3x4, at: Vec3x4, up: Vec3x4) -> Self

Constructs a ‘look-at’ matrix from an eye position, a focus position to look towards, and a vector that defines the ‘up’ direction.

This function assumes a right-handed, y-up coordinate space.

pub fn look_at_lh(eye: Vec3x4, at: Vec3x4, up: Vec3x4) -> Self

Constructs a ‘look-at’ matrix from an eye position, a focus position to look towards, and a vector that defines the ‘up’ direction.

This function assumes a left-handed, y-up coordinate space.

pub fn transpose(&mut self)

pub fn transposed(&self) -> Self

pub fn inverse(&mut self)

If this matrix is not currently invertable, this function will return an invalid inverse. This status is not checked by the library.

pub fn determinant(&self) -> f32x4

pub fn adjugate(&self) -> Self

The adjugate of this matrix, i.e. the transpose of the cofactor matrix.

This is equivalent to the inverse but without dividing by the determinant of the matrix, which can be useful in some contexts for better performance.

One such case is when this matrix is interpreted as a a homogeneous transformation matrix, in which case uniform scaling will not affect the resulting projected 3d version of transformed points or vectors.

pub fn inversed(&self) -> Self

If this matrix is not currently invertable, this function will return an invalid inverse. This status is not checked by the library.

pub fn transform_vec3(&self, vec: Vec3x4) -> Vec3x4

Transform a Vec3 by self, interpreting it as a vector.

pub fn transform_point3(&self, point: Vec3x4) -> Vec3x4

Transform a Vec3 by self, interpreting it as a point.

pub fn extract_translation(&self) -> Vec3x4

If self represents an affine transformation, return its translation components. Otherwise, the returned value has undefined properties.

pub fn extract_rotation(&self) -> Rotor3x4

If the 3x3 left upper block of self is a rotation, return the corresponding rotor. Otherwise, the returned value is a Rotor3 with undefined properties.

pub fn into_isometry(&self) -> Isometry3x4

If self represents an Isometry3 (i.e. self is a product of the from T * R where T is a translation and R a rotation), return the isometry

If self does not represent an isometry, the returned value has undefined properties.

pub fn truncate(&self) -> Mat3x4

Truncate self to a matrix consisting of the 3x3 left upper block. If you need a rotation, consider using Self::extract_rotation() instead.

pub fn layout() -> Layout

pub fn as_array(&self) -> &[f32x4; 16]

pub fn as_component_array(&self) -> &[Vec4x4; 4]

pub fn as_slice(&self) -> &[f32x4]

pub fn as_component_slice(&self) -> &[Vec4x4]

pub fn as_byte_slice(&self) -> &[u8]

pub fn as_mut_slice(&mut self) -> &mut [f32x4]

pub fn as_mut_component_slice(&mut self) -> &mut [Vec4x4]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8]

pub const fn as_ptr(&self) -> *const f32x4

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

pub fn as_mut_ptr(&mut self) -> *mut f32x4

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

Trait Implementations

impl Add<Mat4x4> for Mat4x4

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Mat4x4> for Mat4x4

fn add_assign(&mut self, rhs: Mat4x4)

Performs the += operation.

impl Clone for Mat4x4

fn clone(&self) -> Mat4x4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mat4x4

impl Debug for Mat4x4

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

Formats the value using the given formatter.

impl Default for Mat4x4

fn default() -> Self

Returns the “default value” for a type.

impl From<&'_ [f32x4; 16]> for Mat4x4

fn from(comps: &[f32x4; 16]) -> Self

Performs the conversion.

impl From<[[f32x4; 4]; 4]> for Mat4x4

fn from(comps: [[f32x4; 4]; 4]) -> Self

Performs the conversion.

impl From<[f32x4; 16]> for Mat4x4

fn from(comps: [f32x4; 16]) -> Self

Performs the conversion.

impl Index<usize> for Mat4x4

type Output = Vec4x4

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Mat4x4

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl Mul<Mat4x4> for Mat4x4

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Mat4x4> for f32x4

type Output = Mat4x4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec4x4> for Mat4x4

type Output = Vec4x4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32x4> for Mat4x4

type Output = Mat4x4

The resulting type after applying the * operator.

fn mul(self, rhs: f32x4) -> Mat4x4

Performs the * operation.

impl PartialEq<Mat4x4> for Mat4x4

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

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

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

This method tests for !=.

impl StructuralPartialEq for Mat4x4