grid-tree 0.2.0

Pixel quadtrees and voxel octrees.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use crate::{BranchShape, ChildIndex, Level, Tree, VectorKey};

use glam::{IVec2, IVec3, UVec2, UVec3};
use ndshape::{
    ConstPow2Shape2i32, ConstPow2Shape2u32, ConstPow2Shape3i32, ConstPow2Shape3u32, ConstShape,
};

/// A [`BranchShape`] for signed quadtrees.
pub type QuadtreeShapeI32 = ConstPow2Shape2i32<1, 1>;
/// A [`BranchShape`] for unsigned quadtrees.
pub type QuadtreeShapeU32 = ConstPow2Shape2u32<1, 1>;

/// A [`BranchShape`] for signed octrees.
pub type OctreeShapeI32 = ConstPow2Shape3i32<1, 1, 1>;
/// A [`BranchShape`] for unsigned octrees.
pub type OctreeShapeU32 = ConstPow2Shape3u32<1, 1, 1>;

/// The default quadtree with `i32` coordinates.
pub type QuadtreeI32<T> = Tree<IVec2, QuadtreeShapeI32, T, 4>;
/// The default quadtree with `u32` coordinates.
pub type QuadtreeU32<T> = Tree<UVec2, QuadtreeShapeU32, T, 4>;

/// The default octree with `i32` coordinates.
pub type OctreeI32<T> = Tree<IVec3, OctreeShapeI32, T, 8>;
/// The default octree with `u32` coordinates.
pub type OctreeU32<T> = Tree<UVec3, OctreeShapeU32, T, 8>;

impl<T> QuadtreeI32<T> {
    pub fn new(height: Level) -> Self {
        unsafe { Self::new_generic(height) }
    }
}
impl<T> QuadtreeU32<T> {
    pub fn new(height: Level) -> Self {
        unsafe { Self::new_generic(height) }
    }
}
impl<T> OctreeI32<T> {
    pub fn new(height: Level) -> Self {
        unsafe { Self::new_generic(height) }
    }
}
impl<T> OctreeU32<T> {
    pub fn new(height: Level) -> Self {
        unsafe { Self::new_generic(height) }
    }
}

macro_rules! impl_signed_branch_shape {
    ($name:ty, $vector:ty, $shifter:expr) => {
        impl BranchShape<$vector> for $name {
            const SHAPE_SHIFTER: $vector = $shifter;

            #[inline]
            fn linearize_child(v: $vector) -> ChildIndex {
                <$name>::linearize(v.into()) as ChildIndex
            }

            #[inline]
            fn delinearize_child(i: ChildIndex) -> $vector {
                <$name>::delinearize(i as i32).into()
            }
        }
    };
}

macro_rules! impl_unsigned_branch_shape {
    ($name:ty, $vector:ty, $shifter:expr) => {
        impl BranchShape<$vector> for $name {
            const SHAPE_SHIFTER: $vector = $shifter;

            #[inline]
            fn linearize_child(v: $vector) -> ChildIndex {
                <$name>::linearize(v.into()) as ChildIndex
            }

            #[inline]
            fn delinearize_child(i: ChildIndex) -> $vector {
                <$name>::delinearize(i as u32).into()
            }
        }
    };
}

impl_unsigned_branch_shape!(QuadtreeShapeU32, UVec2, UVec2::from_array([1; 2]));
impl_unsigned_branch_shape!(OctreeShapeU32, UVec3, UVec3::from_array([1; 3]));
impl_signed_branch_shape!(QuadtreeShapeI32, IVec2, IVec2::from_array([1; 2]));
impl_signed_branch_shape!(OctreeShapeI32, IVec3, IVec3::from_array([1; 3]));

impl VectorKey for IVec2 {
    #[inline]
    fn mul_u32(self, rhs: u32) -> Self {
        self * rhs as i32
    }
}
impl VectorKey for IVec3 {
    #[inline]
    fn mul_u32(self, rhs: u32) -> Self {
        self * rhs as i32
    }
}
impl VectorKey for UVec2 {
    #[inline]
    fn mul_u32(self, rhs: u32) -> Self {
        self * rhs
    }
}
impl VectorKey for UVec3 {
    #[inline]
    fn mul_u32(self, rhs: u32) -> Self {
        self * rhs
    }
}