Struct ssbh_lib::Matrix3x3

pub struct Matrix3x3 {
    pub col1: Vector3,
    pub col2: Vector3,
    pub col3: Vector3,
}

A column-major 3x3 matrix of contiguous floats.

Fields

col1: Vector3

col2: Vector3

col3: Vector3

Implementations

impl Matrix3x3

pub fn identity() -> Matrix3x3

The identity transformation matrix.

use ssbh_lib::{Vector3, Matrix3x3};

let m = Matrix3x3::identity();
assert_eq!(Vector3::new(1f32, 0f32, 0f32), m.col1);
assert_eq!(Vector3::new(0f32, 1f32, 0f32), m.col2);
assert_eq!(Vector3::new(0f32, 0f32, 1f32), m.col3);

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

Converts the elements to a 2d array in column-major order.

use ssbh_lib::{Vector3, Matrix3x3};

let m = Matrix3x3 {
    col1: Vector3::new(1f32, 2f32, 3f32),
    col2: Vector3::new(4f32, 5f32, 6f32),
    col3: Vector3::new(7f32, 8f32, 9f32),
};

assert_eq!(
    [
        [1f32, 2f32, 3f32],
        [4f32, 5f32, 6f32],
        [7f32, 8f32, 9f32],
    ],
    m.to_cols_array(),
);

pub fn from_cols_array(cols: &[[f32; 3]; 3]) -> Matrix3x3

Creates the matrix from a 2d array in column-major order.

let elements = [
    [1f32, 2f32, 3f32],
    [4f32, 5f32, 6f32],
    [7f32, 8f32, 9f32],
];
let m = Matrix3x3::from_cols_array(&elements);
assert_eq!(elements, m.to_cols_array());

Trait Implementations

impl BinRead for Matrix3x3

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_> ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl Clone for Matrix3x3

fn clone(&self) -> Matrix3x3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Matrix3x3

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

Formats the value using the given formatter.

impl Default for Matrix3x3

fn default() -> Matrix3x3

Returns the “default value” for a type.

impl PartialEq for Matrix3x3

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SsbhWrite for Matrix3x3

fn ssbh_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Result<()>

Writes the byte representation of self to writer. data_ptr is assumed to be the absolute offset where the next data stored behind an offset will be written. Struct that contains no offsets as fields can skip updating data_ptr.

fn size_in_bytes(&self) -> u64

The offset in bytes between successive elements in an array of this type. This should include any alignment or padding.

fn alignment_in_bytes() -> u64

The alignment for pointers of this type, which is useful for offset calculations.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek,

Writes the byte representation of self to writer. This is a convenience method for ssbh_write that handles initializing the data pointer.

impl Copy for Matrix3x3

impl StructuralPartialEq for Matrix3x3