669d2ccdcd54ed41e6391b9f38797fbc2a095b1b
[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_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_NODE_LEAF_SIZE      1
40 #define BVH_QNODE_SIZE  7
41 #define BVH_QNODE_LEAF_SIZE     1
42 #define BVH_ALIGN               4096
43 #define TRI_NODE_SIZE   3
44
45 /* Packed BVH
46  *
47  * BVH stored as it will be used for traversal on the rendering device. */
48
49 struct PackedBVH {
50         /* BVH nodes storage, one node is 4x int4, and contains two bounding boxes,
51          * and child, triangle or object indexes depending on the node type */
52         array<int4> nodes;
53         /* BVH leaf nodes storage. */
54         array<int4> leaf_nodes;
55         /* object index to BVH node index mapping for instances */
56         array<int> object_node; 
57         /* precomputed triangle intersection data, one triangle is 4x float4 */
58         array<float4> tri_woop;
59         /* primitive type - triangle or strand */
60         array<int> prim_type;
61         /* visibility visibilitys for primitives */
62         array<uint> prim_visibility;
63         /* mapping from BVH primitive index to true primitive index, as primitives
64          * may be duplicated due to spatial splits. -1 for instances. */
65         array<int> prim_index;
66         /* mapping from BVH primitive index, to the object id of that primitive. */
67         array<int> prim_object;
68
69         /* index of the root node. */
70         int root_index;
71
72         /* surface area heuristic, for building top level BVH */
73         float SAH;
74
75         PackedBVH()
76         {
77                 root_index = 0;
78                 SAH = 0.0f;
79         }
80 };
81
82 /* BVH */
83
84 class BVH
85 {
86 public:
87         PackedBVH pack;
88         BVHParams params;
89         vector<Object*> objects;
90         string cache_filename;
91
92         static BVH *create(const BVHParams& params, const vector<Object*>& objects);
93         virtual ~BVH() {}
94
95         void build(Progress& progress);
96         void refit(Progress& progress);
97
98         void clear_cache_except();
99
100 protected:
101         BVH(const BVHParams& params, const vector<Object*>& objects);
102
103         /* cache */
104         bool cache_read(CacheData& key);
105         void cache_write(CacheData& key);
106
107         /* triangles and strands*/
108         void pack_primitives();
109         void pack_triangle(int idx, float4 woop[3]);
110
111         /* merge instance BVH's */
112         void pack_instances(size_t nodes_size, size_t leaf_nodes_size);
113
114         /* for subclasses to implement */
115         virtual void pack_nodes(const BVHNode *root) = 0;
116         virtual void refit_nodes() = 0;
117 };
118
119 /* Regular BVH
120  *
121  * Typical BVH with each node having two children. */
122
123 class RegularBVH : public BVH {
124 protected:
125         /* constructor */
126         friend class BVH;
127         RegularBVH(const BVHParams& params, const vector<Object*>& objects);
128
129         /* pack */
130         void pack_nodes(const BVHNode *root);
131         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
132         void pack_inner(const BVHStackEntry& e, const BVHStackEntry& e0, const BVHStackEntry& e1);
133         void pack_node(int idx, const BoundBox& b0, const BoundBox& b1, int c0, int c1, uint visibility0, uint visibility1);
134
135         /* refit */
136         void refit_nodes();
137         void refit_node(int idx, bool leaf, BoundBox& bbox, uint& visibility);
138 };
139
140 /* QBVH
141  *
142  * Quad BVH, with each node having four children, to use with SIMD instructions. */
143
144 class QBVH : public BVH {
145 protected:
146         /* constructor */
147         friend class BVH;
148         QBVH(const BVHParams& params, const vector<Object*>& objects);
149
150         /* pack */
151         void pack_nodes(const BVHNode *root);
152         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
153         void pack_inner(const BVHStackEntry& e, const BVHStackEntry *en, int num);
154
155         /* refit */
156         void refit_nodes();
157         void refit_node(int idx, bool leaf, BoundBox& bbox, uint& visibility);
158 };
159
160 CCL_NAMESPACE_END
161
162 #endif /* __BVH_H__ */
163