Struct pasture_core::math::MortonIndex64

pub struct MortonIndex64 { /* fields omitted */ }

64-bit 3D Morton index

Implementations

impl MortonIndex64

pub const LEVELS: usize

pub fn from_raw(index: u64) -> Self

Creates a MortonIndex64 from the given raw index

Example:

let morton_index = MortonIndex64::from_raw(1234);

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

Creates a MortonIndex64 that encodes the given octree octants. The order of the octant numbering is unspecified, i.e. there is no assumption made which octant in 3D space has index 0, 1, etc. Octants are encoded little-endian, i.e. the first octant is encoded in the most significant bits of the Morton index. octants may contain at most MortonIndex64::LEVELS entries. If it contains less than MortonIndex64::LEVELS entries, the remaining octants will be zero.

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 = MortonIndex64::from_octants(&[Octant::ONE, Octant::TWO, Octant::FOUR]);
assert_eq!(Some(Octant::ONE), morton_index.get_octant_at_level(1));
assert_eq!(Some(Octant::TWO), morton_index.get_octant_at_level(2));
assert_eq!(Some(Octant::FOUR), morton_index.get_octant_at_level(3));

pub fn from_point_in_bounds(point: &Point3<f64>, bounds: &AABB<f64>) -> Self

Computes a MortonIndex64 for the given point within bounds. Octant order is ZYX little-endian (MSB encodes Z, LSB encodes X)

pub fn index(&self) -> u64

Returns the raw value of the associated MortonIndex64

let morton_index = MortonIndex64::from_raw(1234);
assert_eq!(1234, morton_index.index());

pub fn set_octant_at_level(&mut self, level: u8, octant: Octant)

Sets the octant index at the specified level to octant. level must be in [1;MortonIndex64::LEVELS]. This may seem surprising, however in an octree level 0 represents the root node and there is only one node at this level. The first level that has octants with respect to its parent node thus is level 1! octant must be in [0;7]. Octant numbering order is unspecified.

Example:

let mut morton_index = MortonIndex64::from_raw(0);
morton_index.set_octant_at_level(3, Octant::ONE);
assert_eq!(Some(Octant::ONE), morton_index.get_octant_at_level(3));

Panics

If level is either zero (see comment above) or level is greater than MortonIndex64::LEVELS.

pub fn set_octant_at_level_unchecked(&mut self, level: u8, octant: u8)

Unchecked version of set_octant_at_level

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

Returns the octant index at the specified level in the associated MortonIndex64. level describes the level relative to the root node. Since the root node is only a single node and has no parent, there is no octant at level 0, so None is returned in this case.

Example

let mut morton_index = MortonIndex64::from_raw(0);
morton_index.set_octant_at_level(3, Octant::ONE);
assert_eq!(Some(Octant::ONE), morton_index.get_octant_at_level(3));

Panics

If level is greater than MortonIndex64::LEVELS

pub fn get_octant_at_level_unchecked(&self, level: u8) -> u8

Unchecked version of ‘get_octant_at_level’. In contrast to get_octant_at_level, this always returns zero for level 0 (instead of None). Calling this method with a value for level that is greater than MortonIndex64::LEVELS is undefined behaviour!

pub fn with_depth(&self, depth: u8) -> MortonIndex64WithDepth

Returns a MortonIndex64WithDepth from the associated MortonIndex64 with the given depth

Panics

If depth is greater than MortonIndex64::LEVELS

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

Converts the associated MortonIndex64 into an XYZ index within a 3D grid

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 MortonIndex64

fn clone(&self) -> MortonIndex64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MortonIndex64

impl Debug for MortonIndex64

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

Formats the value using the given formatter.

impl Default for MortonIndex64

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MortonIndex64

impl From<&'_ u64> for MortonIndex64

fn from(val: &u64) -> Self

Performs the conversion.

impl From<MortonIndex64> for DynamicMortonIndex

fn from(morton_index: MortonIndex64) -> Self

Performs the conversion.

impl From<u64> for MortonIndex64

fn from(val: u64) -> Self

Performs the conversion.

impl Ord for MortonIndex64

fn cmp(&self, other: &Self) -> 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<MortonIndex64> for MortonIndex64

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

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

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

This method tests for !=.

impl PartialOrd<MortonIndex64> for MortonIndex64

fn partial_cmp(&self, other: &MortonIndex64) -> 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 MortonIndex64

impl StructuralPartialEq for MortonIndex64