Struct dot_vox::Rotation

pub struct Rotation(_);

A Signed Permutation Matrix ¹ encoded in a byte.

Encoding

The encoding follows the MagicaVoxel ROTATION type.

for example :

let R = [
  [0,  1,  0],
  [0,  0, -1],
  [-1, 0,  0],
];
let _r: u8 = (1 << 0) | (2 << 2) | (0 << 4) | (1 << 5) | (1 << 6);

bit	value	descripton
0-1	1	Index of the non-zero entry in the first row
2-3	2	Index of the non-zero entry in the second row
4	0	The sign in the first row (0 - positive; 1 - negative)
5	1	The sign in the second row (0 - positive; 1 - negative)
6	1	The sign in the third row (0 - positive; 1 - negative)

---

1. A Signed Permutation Matrix is a square binary matrix that has exactly one entry of ±1 in each row and each column and 0s elsewhere. ↩

Implementations

impl Rotation

pub const IDENTITY: Self = _

pub fn from_byte(byte: u8) -> Self

pub fn to_quat_scale(&self) -> ([f32; 4], [f32; 3])

Decompose the Signed Permutation Matrix into a rotation component, represented by a Quaternion, and a flip component, represented by a Vec3 which is either Vec3::ONE or -Vec3::ONE.

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

Trait Implementations

impl Clone for Rotation

fn clone(&self) -> Rotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rotation

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

Print the Rotation in a format that looks like Rotation(-y, -z, x)

impl Mul<Rotation> for Rotation

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

Integer-only multiplication of two Rotation.

type Output = Rotation

The resulting type after applying the * operator.

impl Copy for Rotation