style cleanup: block comments
[blender.git] / intern / cycles / bvh / bvh.h
1 /*
2  * Adapted from code copyright 2009-2010 NVIDIA Corporation
3  * Modifications Copyright 2011, Blender Foundation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #ifndef __BVH_H__
19 #define __BVH_H__
20
21 #include "bvh_params.h"
22
23 #include "util_string.h"
24 #include "util_types.h"
25 #include "util_vector.h"
26
27 CCL_NAMESPACE_BEGIN
28
29 class BVHNode;
30 struct BVHStackEntry;
31 class BVHParams;
32 class BoundBox;
33 class CacheData;
34 class LeafNode;
35 class Object;
36 class Progress;
37
38 #define BVH_NODE_SIZE   4
39 #define BVH_QNODE_SIZE  8
40 #define BVH_ALIGN               4096
41 #define TRI_NODE_SIZE   3
42
43 /* Packed BVH
44  *
45  * BVH stored as it will be used for traversal on the rendering device. */
46
47 struct PackedBVH {
48         /* BVH nodes storage, one node is 4x int4, and contains two bounding boxes,
49          * and child, triangle or object indexes dependening on the node type */
50         array<int4> nodes; 
51         /* object index to BVH node index mapping for instances */
52         array<int> object_node; 
53         /* precomputed triangle intersection data, one triangle is 4x float4 */
54         array<float4> tri_woop; 
55         /* visibility visibilitys for primitives */
56         array<uint> prim_visibility;
57         /* mapping from BVH primitive index to true primitive index, as primitives
58          * may be duplicated due to spatial splits. -1 for instances. */
59         array<int> prim_index;
60         /* mapping from BVH primitive index, to the object id of that primitive. */
61         array<int> prim_object;
62         /* quick array to lookup if a node is a leaf, not used for traversal, only
63          * for instance BVH merging  */
64         array<int> is_leaf;
65
66         /* index of the root node. */
67         int root_index;
68
69         /* surface area heuristic, for building top level BVH */
70         float SAH;
71
72         PackedBVH()
73         {
74                 root_index = 0;
75                 SAH = 0.0f;
76         }
77 };
78
79 /* BVH */
80
81 class BVH
82 {
83 public:
84         PackedBVH pack;
85         BVHParams params;
86         vector<Object*> objects;
87         string cache_filename;
88
89         static BVH *create(const BVHParams& params, const vector<Object*>& objects);
90         virtual ~BVH() {}
91
92         void build(Progress& progress);
93         void refit(Progress& progress);
94
95         void clear_cache_except();
96
97 protected:
98         BVH(const BVHParams& params, const vector<Object*>& objects);
99
100         /* cache */
101         bool cache_read(CacheData& key);
102         void cache_write(CacheData& key);
103
104         /* triangles */
105         void pack_triangles();
106         void pack_triangle(int idx, float4 woop[3]);
107
108         /* merge instance BVH's */
109         void pack_instances(size_t nodes_size);
110
111         /* for subclasses to implement */
112         virtual void pack_nodes(const array<int>& prims, const BVHNode *root) = 0;
113         virtual void refit_nodes() = 0;
114 };
115
116 /* Regular BVH
117  *
118  * Typical BVH with each node having two children. */
119
120 class RegularBVH : public BVH {
121 protected:
122         /* constructor */
123         friend class BVH;
124         RegularBVH(const BVHParams& params, const vector<Object*>& objects);
125
126         /* pack */
127         void pack_nodes(const array<int>& prims, const BVHNode *root);
128         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
129         void pack_inner(const BVHStackEntry& e, const BVHStackEntry& e0, const BVHStackEntry& e1);
130         void pack_node(int idx, const BoundBox& b0, const BoundBox& b1, int c0, int c1, uint visibility0, uint visibility1);
131
132         /* refit */
133         void refit_nodes();
134         void refit_node(int idx, bool leaf, BoundBox& bbox, uint& visibility);
135 };
136
137 /* QBVH
138  *
139  * Quad BVH, with each node having four children, to use with SIMD instructions. */
140
141 class QBVH : public BVH {
142 protected:
143         /* constructor */
144         friend class BVH;
145         QBVH(const BVHParams& params, const vector<Object*>& objects);
146
147         /* pack */
148         void pack_nodes(const array<int>& prims, const BVHNode *root);
149         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
150         void pack_inner(const BVHStackEntry& e, const BVHStackEntry *en, int num);
151
152         /* refit */
153         void refit_nodes();
154 };
155
156 CCL_NAMESPACE_END
157
158 #endif /* __BVH_H__ */
159