Struct OctVec

pub struct OctVec {
    pub x: u64,
    pub y: u64,
    pub z: u64,
    pub depth: u8,
}

A Lod Vector for use in an octree It subdivides into 8 children of equal size

Fields

x: u64

x position in the octree

y: u64

y position in the octree

z: u64

z position in the octree

depth: u8

lod depth in the octree this is limited, hence we use u8

Implementations

impl OctVec

pub fn new(x: u64, y: u64, z: u64, depth: u8) -> Self

creates a new vector from the raw x and y coords

Args

• x The x position in the tree. Allowed range scales with the depth (doubles as the depth increases by one)
• y The y position in the tree. Allowed range scales with the depth (doubles as the depth increases by one)
• z The z position in the tree. Allowed range scales with the depth (doubles as the depth increases by one)
• depth the lod depth the coord is at. This is soft limited at roughly 60, and the tree might behave weird if it gets higher

pub fn from_float_coords(x: f64, y: f64, z: f64, depth: u8) -> Self

creates a new vector from floating point coords mapped so that (0, 0, 0) is the front bottom left corner and (1, 1, 1) is the back top right

Args

• x x coord of the float vector, from 0 to 1
• y y coord of the float vector, from 0 to 1
• z z coord of the float vector, from 0 to 1
• depth The lod depth of the coord

pub fn get_float_coords(self) -> (f64, f64, f64)

converts the coord into float coords Returns a tuple of (x: f64, y: f64, z: f64) to represent the coordinates, at the front bottom left corner

pub fn get_size(self) -> f64

gets the size the chunk of this lod vector takes up, with the root taking up

Trait Implementations

impl Clone for OctVec

fn clone(&self) -> OctVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OctVec

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

Formats the value using the given formatter.

impl Default for OctVec

fn default() -> OctVec

Returns the “default value” for a type.

impl LodVec for OctVec

fn num_children() -> usize

get the number of child nodes a node can have in the tree

fn root() -> Self

returns the lod vector as if it’s at the root of the tree

fn get_child(self, index: usize) -> Self

gets one of the child node position of this node, defined by it’s index

fn can_subdivide(self, node: Self, detail: u64) -> bool

wether the node can subdivide, compared to another node and the required detail.

impl Ord for OctVec

fn cmp(&self, other: &OctVec) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for OctVec

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

fn partial_cmp(&self, other: &OctVec) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for OctVec

impl Eq for OctVec

impl StructuralPartialEq for OctVec