Cycles: svn merge -r41225:41232 ^/trunk/blender
[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_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         /* visibility visibilitys for primitives */
55         array<uint> prim_visibility;
56         /* mapping from BVH primitive index to true primitive index, as primitives
57            may be duplicated due to spatial splits. -1 for instances. */
58         array<int> prim_index;
59         /* mapping from BVH primitive index, to the object id of that primitive. */
60         array<int> prim_object;
61         /* quick array to lookup if a node is a leaf, not used for traversal, only
62            for instance BVH merging  */
63         array<int> is_leaf;
64
65         /* index of the root node. */
66         int root_index;
67
68         /* surface area heuristic, for building top level BVH */
69         float SAH;
70
71         PackedBVH()
72         {
73                 root_index = 0;
74                 SAH = 0.0f;
75         }
76 };
77
78 /* BVH */
79
80 class BVH
81 {
82 public:
83         PackedBVH pack;
84         BVHParams params;
85         vector<Object*> objects;
86
87         static BVH *create(const BVHParams& params, const vector<Object*>& objects);
88         virtual ~BVH() {}
89
90         void build(Progress& progress);
91         void refit(Progress& progress);
92
93 protected:
94         BVH(const BVHParams& params, const vector<Object*>& objects);
95
96         /* cache */
97         bool cache_read(CacheData& key);
98         void cache_write(CacheData& key);
99
100         /* triangles */
101         void pack_triangles();
102         void pack_triangle(int idx, float4 woop[3]);
103
104         /* merge instance BVH's */
105         void pack_instances(size_t nodes_size);
106
107         /* for subclasses to implement */
108         virtual void pack_nodes(const array<int>& prims, const BVHNode *root) = 0;
109         virtual void refit_nodes() = 0;
110 };
111
112 /* Regular BVH
113  *
114  * Typical BVH with each node having two children. */
115
116 class RegularBVH : public BVH {
117 protected:
118         /* constructor */
119         friend class BVH;
120         RegularBVH(const BVHParams& params, const vector<Object*>& objects);
121
122         /* pack */
123         void pack_nodes(const array<int>& prims, const BVHNode *root);
124         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
125         void pack_inner(const BVHStackEntry& e, const BVHStackEntry& e0, const BVHStackEntry& e1);
126         void pack_node(int idx, const BoundBox& b0, const BoundBox& b1, int c0, int c1, uint visibility0, uint visibility1);
127
128         /* refit */
129         void refit_nodes();
130         void refit_node(int idx, bool leaf, BoundBox& bbox, uint& visibility);
131 };
132
133 /* QBVH
134  *
135  * Quad BVH, with each node having four children, to use with SIMD instructions. */
136
137 class QBVH : public BVH {
138 protected:
139         /* constructor */
140         friend class BVH;
141         QBVH(const BVHParams& params, const vector<Object*>& objects);
142
143         /* pack */
144         void pack_nodes(const array<int>& prims, const BVHNode *root);
145         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
146         void pack_inner(const BVHStackEntry& e, const BVHStackEntry *en, int num);
147
148         /* refit */
149         void refit_nodes();
150 };
151
152 CCL_NAMESPACE_END
153
154 #endif /* __BVH_H__ */
155