Struct ultraviolet::mat::Wat3

#[repr(C)]
pub struct Wat3 {
    pub cols: [Wec3; 3],
}

Fields

cols: [Wec3; 3]

Methods

impl Wat3

pub fn new(col1: Wec3, col2: Wec3, col3: Wec3) -> Self

pub fn from_translation(trans: Wec2) -> Self

Assumes homogeneous 2d coordinates.

pub fn from_scale_homogeneous(scale: f32x4) -> Self

Assumes homogeneous 2d coordinates.

pub fn from_nonuniform_scale_homogeneous(scale: Wec3) -> Self

Assumes homogeneous 2d coordinates.

pub fn from_rotation_homogeneous(angle: f32x4) -> Self

Builds a homogeneous 2d rotation matrix (in the xy plane) from a given angle in radians.

pub fn from_scale(scale: f32x4) -> Self

pub fn from_nonuniform_scale(scale: Wec3) -> Self

pub fn identity() -> Self

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

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

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

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.

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.

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.

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

pub fn into_homogeneous(self) -> Wat4

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 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 transpose(&mut self)

pub fn transposed(&self) -> Self

pub fn layout() -> Layout

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

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

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 [Wec3]

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

pub 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 From<[f32x4; 9]> for Wat3

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

Performs the conversion.

impl<'_> From<&'_ [f32x4; 9]> for Wat3

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

Performs the conversion.

impl From<WRotor3> for Wat3

fn from(rotor: WRotor3) -> Wat3

Performs the conversion.

impl Clone for Wat3

fn clone(&self) -> Wat3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Wat3

impl Default for Wat3

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Wat3

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

Formats the value using the given formatter.

impl Mul<Wat3> for Wat3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Wec3> for Wat3

type Output = Wec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Index<usize> for Wat3

type Output = Wec3

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Wat3

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

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