Struct Orientation 

pub struct Orientation {
    pub permutation_index: u8,
    pub plane: OrientationPlane,
}

Describes the parametric orientation between two matched faces using a permutation matrix index (0-7).

The permutation matrix transforms face2’s parametric (u, v) coordinates to align with face1’s. The plane field indicates whether the faces share the same constant axis (in-plane) or have different constant axes (cross-plane).

Construct via Orientation::from_flags when you have individual boolean flags, or set permutation_index directly when you already know the encoded value.

Bit layout

permutation_index = u_reversed | (v_reversed << 1) | (swapped << 2)

Examples

use plot3d::{Orientation, OrientationPlane, PERMUTATION_MATRICES};

// Build from boolean flags: u reversed, v not reversed, axes swapped
let orient = Orientation::from_flags(true, false, true, OrientationPlane::CrossPlane);
assert_eq!(orient.permutation_index, 5); // 1 + 0 + 4
assert!(orient.u_reversed());
assert!(!orient.v_reversed());
assert!(orient.swapped());

// Retrieve the 2x2 matrix
let m = orient.matrix();
assert_eq!(*m, PERMUTATION_MATRICES[5]);

Fields

permutation_index: u8

Index (0-7) into PERMUTATION_MATRICES.

plane: OrientationPlane

Whether this is an in-plane or cross-plane match.

Implementations

impl Orientation

pub fn from_flags( u_reversed: bool, v_reversed: bool, swapped: bool, plane: OrientationPlane, ) -> Self

Construct from the legacy boolean flags.

pub fn u_reversed(&self) -> bool

Whether block2’s u-axis is reversed relative to block1’s.

pub fn v_reversed(&self) -> bool

Whether block2’s v-axis is reversed relative to block1’s.

pub fn swapped(&self) -> bool

Whether block2’s u and v axes are transposed relative to block1’s.

pub fn matrix(&self) -> &[[i8; 2]; 2]

Get the 2×2 permutation matrix for this orientation.

Trait Implementations

impl Clone for Orientation

fn clone(&self) -> Orientation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Orientation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Orientation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Orientation

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Orientation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Orientation

impl StructuralPartialEq for Orientation