7a98045f5808e943fd7286d08eb70a2372a8c7da
[divverent/darkplaces.git] / bih.h
1
2 // This code written in 2010 by Forest Hale (lordhavoc ghdigital com), and placed into public domain.
3
4 // Based on information in http://zach.in.tu-clausthal.de/papers/vrst02.html (in particular vrst02_boxtree.pdf)
5
6 #ifndef BIH_H
7 #define BIH_H
8
9 typedef enum biherror_e
10 {
11         BIHERROR_OK, // no error, be happy
12         BIHERROR_OUT_OF_NODES, // could not produce complete hierarchy, maxnodes too low (should be roughly half of numleafs)
13 }
14 biherror_t;
15
16 typedef enum bih_nodetype_e
17 {
18         BIH_SPLITX = 0,
19         BIH_SPLITY = 1,
20         BIH_SPLITZ = 2,
21         BIH_LEAF = 3,
22 }
23 bih_nodetype_t;
24
25 typedef struct bih_node_s
26 {
27         bih_nodetype_t type; // = BIH_SPLITX and similar values
28         // TODO: store just one float for distance, and have BIH_SPLITMINX and BIH_SPLITMAXX distinctions, to reduce memory footprint and traversal time, as described in the paper (vrst02_boxtree.pdf)
29         // TODO: move bounds data to parent node and remove it from leafs?
30         float mins[3];
31         float maxs[3];
32         // < 0 is a leaf index (-1-leafindex), >= 0 is another node index (always >= this node's index)
33         int children[2];
34 }
35 bih_node_t;
36
37 typedef struct bih_leaf_s
38 {
39         bih_nodetype_t type; // = BIH_LEAF
40         float mins[3];
41         float maxs[3];
42         // data past this point is generic and entirely up to the caller...
43         int textureindex;
44         int itemindex; // triangle or brush index
45 }
46 bih_leaf_t;
47
48 typedef struct bih_s
49 {
50         // permanent fields
51         // leafs are constructed by caller before calling BIH_Build
52         int numleafs;
53         bih_leaf_t *leafs;
54         // nodes are constructed by BIH_Build
55         int numnodes;
56         bih_node_t *nodes;
57
58         // fields used only during BIH_Build:
59         int maxnodes;
60         int error; // set to a value if an error occurs in building (such as numnodes == maxnodes)
61         int *leafsort;
62         int *leafsortscratch;
63 }
64 bih_t;
65
66 int BIH_Build(bih_t *bih, int numleafs, bih_leaf_t *leafs, int maxnodes, bih_node_t *nodes, int *temp_leafsort, int *temp_leafsortscratch);
67
68 #endif