Struct OctantMask 

pub struct OctantMask { /* private fields */ }

A set of Octants (or equivalently, one bool for each cube of a 2×2×2 volume).

Internally represented as a u8 bit-set.

This type may be used for culling or other calculations relating to the axis-aligned volumes surrounding a point. If more data than bool is needed, use OctantMap.

Implementations

impl OctantMask

pub const ALL: Self

The mask including all octants (all bits set).

pub const NONE: Self

The mask including no octants (no bits set).

pub fn get(self, octant: Octant) -> bool

Get the flag for the given octant.

pub fn set(&mut self, octant: Octant)

Set the flag for the given octant.

pub fn clear(&mut self, octant: Octant)

Clear the flat for the given octant.

pub fn shift(self, direction: Face6) -> Self

Shift the data in the specified direction, discarding overflows and filling with false/clear.

Trait Implementations

impl BitAnd for OctantMask

type Output = OctantMask

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for OctantMask

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for OctantMask

type Output = OctantMask

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for OctantMask

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for OctantMask

fn clone(&self) -> OctantMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OctantMask

impl Debug for OctantMask

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

Formats the value using the given formatter.

impl Eq for OctantMask

impl Exhaust for OctantMask

type Iter = ExhaustOctantMaskIter

Iterator type returned by Self::exhaust_factories(). See the trait documentation for what properties this iterator should have.

type Factory = ExhaustOctantMaskFactory

Data which can be used to construct Self.

fn exhaust_factories() -> Self::Iter

Returns an iterator over factories for all values of this type.

fn from_factory(factory: Self::Factory) -> Self

Construct a concrete value of this type from a Self::Factory value produced by its Self::Iter.

fn exhaust() -> Iter<Self>

Returns an iterator over all values of this type.

impl From<Octant> for OctantMask

fn from(octant: Octant) -> Self

Converts to this type from the input type.

impl FromIterator<Octant> for OctantMask

fn from_iter<T: IntoIterator<Item = Octant>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for OctantMask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for OctantMask

type Output = OctantMask

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for OctantMask

fn eq(&self, other: &OctantMask) -> 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 StructuralPartialEq for OctantMask