Struct pasture_core::math::DynamicMortonIndex

pub struct DynamicMortonIndex { /* fields omitted */ }

3D Morton index with a dynamic depth

Implementations

impl DynamicMortonIndex

pub fn from_octants(octants: &[Octant]) -> Self

Creates a new DynamicMortonIndex from the given octants. The order of the octant numbering is unspecified. The order of the indices goes from shallowest node to deepest node.

Example:

let mut dynamic_morton_index = DynamicMortonIndex::from_octants(&[Octant::ONE, Octant::TWO, Octant::FOUR]);
assert_eq!(3, dynamic_morton_index.depth());

pub fn depth(&self) -> usize

Returns the depth of the associated DynamicMortonIndex. A depth of zero corresponds to the root node of an octree

pub fn octants(&self) -> &[Octant]

Returns a reference to the octant indices of associated DynamicMortonIndex. The order of the indices goes from shallowest node to deepest node.

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

Adds a new octant to the associated DynamicMortonIndex

Example:

let mut dynamic_morton_index = DynamicMortonIndex::from_octants(&[Octant::ONE, Octant::TWO, Octant::FOUR]);
dynamic_morton_index.add_octant(Octant::SIX);
assert_eq!(4, dynamic_morton_index.depth());
assert_eq!(&[Octant::ONE, Octant::TWO, Octant::FOUR, Octant::SIX], dynamic_morton_index.octants());

pub fn truncate_to_depth(&self, new_depth: usize) -> Option<Self>

Tries to truncate the associated DynamicMortonIndex to the given depth. If depth is greater than the current depth, this operation fails and returns None.

Example:

let mut dynamic_morton_index = DynamicMortonIndex::from_octants(&[Octant::ONE, Octant::TWO, Octant::FOUR]);
let truncated_index = dynamic_morton_index.truncate_to_depth(1);
assert_eq!(Some(DynamicMortonIndex::from_octants(&[Octant::ONE])), truncated_index);

let invalid_index = dynamic_morton_index.truncate_to_depth(10);
assert_eq!(None, invalid_index);

pub fn iter(&self) -> impl Iterator<Item = &Octant>

Returns an iterator over the octants in the associated DynamicMortonIndex

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Octant>

Returns a mutable iterator over the octants in the associated DynamicMortonIndex

pub fn to_string(&self, naming: MortonIndexNaming) -> String

Returns a string representation of the associated MortonIndex64 with the given MortonIndexNaming

Trait Implementations

impl Clone for DynamicMortonIndex

fn clone(&self) -> DynamicMortonIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicMortonIndex

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

Formats the value using the given formatter.

impl Default for DynamicMortonIndex

fn default() -> Self

Returns the “default value” for a type.

impl Display for DynamicMortonIndex

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

Formats the value using the given formatter.

impl Eq for DynamicMortonIndex

impl From<&'_ MortonIndex64WithDepth> for DynamicMortonIndex

fn from(morton_index: &MortonIndex64WithDepth) -> Self

Performs the conversion.

impl From<MortonIndex64> for DynamicMortonIndex

fn from(morton_index: MortonIndex64) -> Self

Performs the conversion.

impl From<MortonIndex64WithDepth> for DynamicMortonIndex

fn from(morton_index: MortonIndex64WithDepth) -> Self

Performs the conversion.

impl PartialEq<DynamicMortonIndex> for DynamicMortonIndex

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

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

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

This method tests for !=.

impl StructuralEq for DynamicMortonIndex

impl StructuralPartialEq for DynamicMortonIndex

impl TryFrom<&'_ DynamicMortonIndex> for MortonIndex64WithDepth

type Error = DynamicMortonIndexTooLargeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<DynamicMortonIndex> for MortonIndex64WithDepth

type Error = DynamicMortonIndexTooLargeError

The type returned in the event of a conversion error.

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

Performs the conversion.