Struct pasture_core::math::MortonIndex64WithDepth

pub struct MortonIndex64WithDepth { /* fields omitted */ }

64-bit 3D Morton index with depth information. This is the more efficient, but more constraint version of DynamicMortonIndex because it can store at maximum 21 levels. Important note: Since a Morton index defines a node in an octree, one has to define what index the root node has. As each 3 bits within a 3D Morton index identify an octant at a certain level, there is no level that defines the root node since it is just a single node. We now define that the root node is always at level 0, so the level parameter of this structure is always relative to the root node. A MortonIndex64WithLevel with a level of 0 is therefore always zero. The first octant lies at level 1. This can be a bit confusing because it makes the code prone to off-by-one errors, however it is better than the alternative (IMO) where root node has level -1, or None.

Implementations

impl MortonIndex64WithDepth

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

Creates a new MortonIndex64WithDepth from the given octants. octants.len() must be <= MortonIndex64::LEVELS

Example

// Create a Morton index for the octants 1->2->4 (octant 4 of octant 2 of octant 1 of the root node)
let morton_index_with_depth = MortonIndex64WithDepth::from_octants(&[Octant::ONE, Octant::TWO, Octant::FOUR]);
assert_eq!(3, morton_index_with_depth.depth());
assert_eq!(Some(Octant::ONE), morton_index_with_depth.get_octant_at_level(1));
assert_eq!(Some(Octant::TWO), morton_index_with_depth.get_octant_at_level(2));
assert_eq!(Some(Octant::FOUR), morton_index_with_depth.get_octant_at_level(3));

pub fn raw_index(&self) -> u64

Returns the raw integer value of the associated MortonIndex64WithDepth. This index is similar to what MortonIndex64::index() returns, however only the highest 3 * depth() bits are used (ignoring the MSB which is always unused for 64 bit Morton indices). All lower bits (and the MSB) are zero!

pub fn depth(&self) -> u8

Returns the depth of the octree node represented by the associated MortonIndex64WithDepth. A depth of zero represents the root node and corresponds to a raw_index() where no bits are used

pub fn get_octant_at_level(&self, level: u8) -> Option<Octant>

Returns the octant index relative to the parent node for the node at the given level. Since level zero represents the root node, and the root node has no parent, None is returned for level zero.

Panics

If level is greater than depth()

pub fn child(&self, octant: Octant) -> Option<Self>

Returns the child node at the given octant from the associated MortonIndex64WithDepth. If the associated index is already of maximum depth (MortonIndex64::LEVELS), returns None

pub fn with_lower_depth(&self, lower_depth: u8) -> Self

Returns a version of the associated MortonIndex64WithDepth with the given lower depth

pub fn as_grid_index(&self) -> Vector3<u32>

Converts the associated MortonIndex64WithDepth into an XYZ index within a 3D grid of size (2^self.depth)x(2^self.depth)x(2^self.depth)

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

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

Trait Implementations

impl Clone for MortonIndex64WithDepth

fn clone(&self) -> MortonIndex64WithDepth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MortonIndex64WithDepth

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

Formats the value using the given formatter.

impl Default for MortonIndex64WithDepth

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MortonIndex64WithDepth

impl From<&'_ MortonIndex64WithDepth> for DynamicMortonIndex

fn from(morton_index: &MortonIndex64WithDepth) -> Self

Performs the conversion.

impl From<MortonIndex64WithDepth> for DynamicMortonIndex

fn from(morton_index: MortonIndex64WithDepth) -> Self

Performs the conversion.

impl Hash for MortonIndex64WithDepth

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<MortonIndex64WithDepth> for MortonIndex64WithDepth

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

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

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

This method tests for !=.

impl StructuralEq for MortonIndex64WithDepth

impl StructuralPartialEq for MortonIndex64WithDepth

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.