Cycles: svn merge -r36495:36747 https://svn.blender.org/svnroot/bf-blender/trunk...
[blender-staging.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_types.h"
24 #include "util_vector.h"
25
26 CCL_NAMESPACE_BEGIN
27
28 class BVHNode;
29 struct BVHStackEntry;
30 class BVHParams;
31 class BoundBox;
32 class CacheData;
33 class LeafNode;
34 class Object;
35 class Progress;
36
37 #define BVH_NODE_SIZE   4
38 #define BVH_QNODE_SIZE  8
39 #define BVH_ALIGN               4096
40 #define TRI_NODE_SIZE   3
41
42 /* Packed BVH
43  *
44  * BVH stored as it will be used for traversal on the rendering device. */
45
46 struct PackedBVH {
47         /* BVH nodes storage, one node is 4x int4, and contains two bounding boxes,
48            and child, triangle or object indexes dependening on the node type */
49         array<int4> nodes; 
50         /* object index to BVH node index mapping for instances */
51         array<int> object_node; 
52         /* precomputed triangle intersection data, one triangle is 4x float4 */
53         array<float4> tri_woop; 
54         /* mapping from BVH primitive index to true primitive index, as primitives
55            may be duplicated due to spatial splits. -1 for instances. */
56         array<int> prim_index;
57         /* mapping from BVH primitive index, to the object id of that primitive. */
58         array<int> prim_object;
59         /* quick array to lookup if a node is a leaf, not used for traversal, only
60            for instance BVH merging  */
61         array<int> is_leaf;
62
63         /* index of the root node. */
64         int root_index;
65
66         /* surface area heuristic, for building top level BVH */
67         float SAH;
68
69         PackedBVH()
70         {
71                 root_index = 0;
72                 SAH = 0.0f;
73         }
74 };
75
76 /* BVH */
77
78 class BVH
79 {
80 public:
81         PackedBVH pack;
82         BVHParams params;
83         vector<Object*> objects;
84
85         static BVH *create(const BVHParams& params, const vector<Object*>& objects);
86
87         void build(Progress& progress);
88         void refit(Progress& progress);
89
90 protected:
91         BVH(const BVHParams& params, const vector<Object*>& objects);
92
93         /* cache */
94         bool cache_read(CacheData& key);
95         void cache_write(CacheData& key);
96
97         /* triangles */
98         void pack_triangles();
99         void pack_triangle(int idx, float4 woop[3]);
100
101         /* merge instance BVH's */
102         void pack_instances(size_t nodes_size);
103
104         /* for subclasses to implement */
105         virtual void pack_nodes(const array<int>& prims, const BVHNode *root) = 0;
106         virtual void refit_nodes() = 0;
107 };
108
109 /* Regular BVH
110  *
111  * Typical BVH with each node having two children. */
112
113 class RegularBVH : public BVH {
114 protected:
115         /* constructor */
116         friend class BVH;
117         RegularBVH(const BVHParams& params, const vector<Object*>& objects);
118
119         /* pack */
120         void pack_nodes(const array<int>& prims, const BVHNode *root);
121         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
122         void pack_inner(const BVHStackEntry& e, const BVHStackEntry& e0, const BVHStackEntry& e1);
123         void pack_node(int idx, const BoundBox& b0, const BoundBox& b1, int c0, int c1);
124
125         /* refit */
126         void refit_nodes();
127         void refit_node(int idx, bool leaf, BoundBox& bbox);
128 };
129
130 /* QBVH
131  *
132  * Quad BVH, with each node having four children, to use with SIMD instructions. */
133
134 class QBVH : public BVH {
135 protected:
136         /* constructor */
137         friend class BVH;
138         QBVH(const BVHParams& params, const vector<Object*>& objects);
139
140         /* pack */
141         void pack_nodes(const array<int>& prims, const BVHNode *root);
142         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
143         void pack_inner(const BVHStackEntry& e, const BVHStackEntry *en, int num);
144
145         /* refit */
146         void refit_nodes();
147 };
148
149 CCL_NAMESPACE_END
150
151 #endif /* __BVH_H__ */
152