Struct OctreeSet 

pub struct OctreeSet { /* private fields */ }

A sparse set of voxel coordinates (3D integer points). Supports spatial queries.

The octree is a cube shape and the edge lengths can only be a power of 2, at most 64.

Implementations

impl OctreeSet

pub fn new_empty(extent: ExtentN<[i32; 3]>) -> OctreeSet

Make an empty set in the universe (domain) of extent.

pub fn new_full(extent: ExtentN<[i32; 3]>) -> OctreeSet

Make a full set in the universe (domain) of extent.

pub fn from_array3<A, T>(array: &A, extent: ExtentN<[i32; 3]>) -> OctreeSet

where A: IndexedArray<[i32; 3]> + Get<Stride, Item = T>, T: Clone + IsEmpty,

Constructs an OctreeSet which contains all of the points in extent which are not empty (as defined by the IsEmpty trait). extent must be cube-shaped with edge length being a power of 2. For power P where edge length is 2^P, we must have 0 < P <= 6, because there is a maximum fixed depth of the octree.

pub fn power(&self) -> u8

The exponent P such that self.edge_length() = 2 ^ P.

pub fn edge_length(&self) -> i32

The length of any edge of the root octant.

pub fn octant(&self) -> Octant

The entire octant spanned by the octree.

pub fn extent(&self) -> &ExtentN<[i32; 3]>

The extent spanned by the octree.

pub fn is_empty(&self) -> bool

Returns true iff the octree contains zero points.

pub fn visit_branches_and_fat_leaves_for_extent_in_preorder( &self, extent: &ExtentN<[i32; 3]>, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Same as visit_branches_and_fat_leaves_in_preorder, but visit only the octants that overlap extent.

pub fn visit_branches_and_fat_leaves_for_extent_in_postorder( &self, extent: &ExtentN<[i32; 3]>, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Same as visit_branches_and_fat_leaves_in_postorder, but visit only the octants that overlap extent.

pub fn visit_all_octants_in_preorder( &self, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Same as visit_branches_and_fat_leaves_in_preorder, but descendants of fat leaves are also visited.

pub fn visit_all_octants_in_postorder( &self, predicate: &impl Fn(&OctreeNode) -> bool, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Same as visit_branches_and_fat_leaves_in_postorder, but descendants of fat leaves are also visited.

pub fn visit_all_octants_for_extent_in_preorder( &self, extent: &ExtentN<[i32; 3]>, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Same as visit_all_octants_in_preorder, but only for octants overlapping extent.

pub fn visit_all_octants_for_extent_in_postorder( &self, extent: &ExtentN<[i32; 3]>, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Same as visit_all_octants_in_postorder, but only for octants overlapping extent.

pub fn visit_branches_and_fat_leaves_in_preorder( &self, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Visit every branch and fat leaf in the octree. This is a pre-order traversal.

pub fn visit_branches_and_fat_leaves_in_postorder( &self, predicate: &impl Fn(&OctreeNode) -> bool, visitor: &mut impl OctreeVisitor, ) -> VisitStatus

Visit every branch and fat leaf in the octree. This is a post-order traversal.

pub fn root_node(&self) -> Option<OctreeNode>

The OctreeNode of the root, if it exists.

pub fn get_child( &self, parent: &OctreeNode, child_index: u8, ) -> Option<OctreeNode>

Returns the child OctreeNode of parent at the given child_index, where 0 < child_octant < 8.

pub fn add_extent(&mut self, add_extent: &ExtentN<[i32; 3]>)

Add all points from extent to the set.

pub fn subtract_extent(&mut self, sub_extent: &ExtentN<[i32; 3]>)

Subtract all points from extent from the set.

pub fn collect_points(&self) -> Vec<PointN<[i32; 3]>>

Get all of the points in this set collected into a Vec.

Trait Implementations

impl Clone for OctreeSet

fn clone(&self) -> OctreeSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OctreeSet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OctreeSet

fn deserialize<__D>( __deserializer: __D, ) -> Result<OctreeSet, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OctreeSet

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OctreeSet

impl StructuralPartialEq for OctreeSet