Struct dmc::octree::MortonKey

pub struct MortonKey(pub u64);

A 64-bit integer that indicates a single node in a hashed octree. Its internal representation starts with 1 as the root node and appends 3 bits for each following child node, indicating its position in the X, Y and Z axis.

Implementations

impl MortonKey

pub const fn root() -> Self

Returns a Morton key pointing to the octree root node.

pub const fn none() -> Self

Returns a Morton key pointing to no node.

pub fn parent(self) -> Self

Returns the parent of this Morton key. If this key is pointing to the root node, the node given will be equal to MortonKey::none().

pub fn child(self, index: OctreeIndex) -> Self

Returns a child of the node this key is pointing to.

Panics

Panics if the level of this key is equal to the maximum level possible.

pub fn level(self) -> u32

Returns the level or depth of this node, where 0 is the root node.

Panics

Panics if this is a Morton key pointing to no node.

pub const fn max_level() -> u32

Returns the maximum depth of the nodes that this type can point to.

pub fn position(self) -> Point3<f32>

Returns the position of the center of the node this key is pointing to. All axis are in the (0, 1) interval.

pub fn closest_to_position(position: Point3<f32>, level: u32) -> Self

Returns the Morton key with level level of an octree of bounds [-1]³ to [1]³ which is closest to the position position.

Panics

Panics if level < Self::max_level().

pub fn until_level(self, level: u32) -> Self

Returns a key that goes along the current key until a given level.

Panics

If self.level() < level.

Trait Implementations

impl Clone for MortonKey

fn clone(&self) -> MortonKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MortonKey

impl Debug for MortonKey

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

Formats the value using the given formatter.

impl Eq for MortonKey

impl Hash for MortonKey

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<MortonKey> for MortonKey

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

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

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

This method tests for !=.

impl StructuralEq for MortonKey

impl StructuralPartialEq for MortonKey