Struct pasture_core::math::Octant

pub struct Octant(_);

Wrapper type around an u8 that encodes the index of an octant within an octree. Since there are only 8 possible octants, this type is only valid for values in [0;7] and acts as a safeguard to prevent out-of-bounds errors when passing around and setting octant indices

Implementations

impl Octant

pub const ZERO: Octant

Constant for the octant with index 0

pub const ONE: Octant

Constant for the octant with index 1

pub const TWO: Octant

Constant for the octant with index 2

pub const THREE: Octant

Constant for the octant with index 3

pub const FOUR: Octant

Constant for the octant with index 4

pub const FIVE: Octant

Constant for the octant with index 5

pub const SIX: Octant

Constant for the octant with index 6

pub const SEVEN: Octant

Constant for the octant with index 7

pub fn index(&self) -> u8

The index of the associated Octant as an u8 value

Trait Implementations

impl Clone for Octant

fn clone(&self) -> Octant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Octant

impl Debug for Octant

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

Formats the value using the given formatter.

impl Eq for Octant

impl Ord for Octant

fn cmp(&self, other: &Octant) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Octant> for Octant

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

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

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

This method tests for !=.

impl PartialOrd<Octant> for Octant

fn partial_cmp(&self, other: &Octant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Octant

impl StructuralPartialEq for Octant

impl TryFrom<u8> for Octant

type Error = OctantIndexOutOfBoundsError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.