Cycles: Make BVH wider prior to packing
[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/bvh_params.h"
22 #include "util/util_array.h"
23 #include "util/util_types.h"
24 #include "util/util_vector.h"
25
26 CCL_NAMESPACE_BEGIN
27
28 class Stats;
29 class BVHNode;
30 struct BVHStackEntry;
31 class BVHParams;
32 class BoundBox;
33 class LeafNode;
34 class Object;
35 class Progress;
36
37 #define BVH_ALIGN     4096
38 #define TRI_NODE_SIZE 3
39 /* Packed BVH
40  *
41  * BVH stored as it will be used for traversal on the rendering device. */
42
43 struct PackedBVH {
44         /* BVH nodes storage, one node is 4x int4, and contains two bounding boxes,
45          * and child, triangle or object indexes depending on the node type */
46         array<int4> nodes;
47         /* BVH leaf nodes storage. */
48         array<int4> leaf_nodes;
49         /* object index to BVH node index mapping for instances */
50         array<int> object_node;
51         /* Mapping from primitive index to index in triangle array. */
52         array<uint> prim_tri_index;
53         /* Continuous storage of triangle vertices. */
54         array<float4> prim_tri_verts;
55         /* primitive type - triangle or strand */
56         array<int> prim_type;
57         /* visibility visibilitys for primitives */
58         array<uint> prim_visibility;
59         /* mapping from BVH primitive index to true primitive index, as primitives
60          * may be duplicated due to spatial splits. -1 for instances. */
61         array<int> prim_index;
62         /* mapping from BVH primitive index, to the object id of that primitive. */
63         array<int> prim_object;
64         /* Time range of BVH primitive. */
65         array<float2> prim_time;
66
67         /* index of the root node. */
68         int root_index;
69
70         PackedBVH()
71         {
72                 root_index = 0;
73         }
74 };
75
76 enum BVH_TYPE {
77         bvh2,
78         bvh4,
79         bvh8
80 };
81
82 /* BVH */
83
84 class BVH
85 {
86 public:
87         PackedBVH pack;
88         BVHParams params;
89         vector<Object*> objects;
90
91         static BVH *create(const BVHParams& params, const vector<Object*>& objects);
92         virtual ~BVH() {}
93
94         virtual void build(Progress& progress, Stats *stats=NULL);
95         void refit(Progress& progress);
96
97 protected:
98         BVH(const BVHParams& params, const vector<Object*>& objects);
99
100         /* Refit range of primitives. */
101         void refit_primitives(int start, int end, BoundBox& bbox, uint& visibility);
102
103         /* triangles and strands */
104         void pack_primitives();
105         void pack_triangle(int idx, float4 storage[3]);
106
107         /* merge instance BVH's */
108         void pack_instances(size_t nodes_size, size_t leaf_nodes_size);
109
110         /* for subclasses to implement */
111         virtual void pack_nodes(const BVHNode *root) = 0;
112         virtual void refit_nodes() = 0;
113
114         virtual BVHNode *widen_children_nodes(const BVHNode *root) = 0;
115 };
116
117 /* Pack Utility */
118 struct BVHStackEntry
119 {
120         const BVHNode *node;
121         int idx;
122
123         BVHStackEntry(const BVHNode *n = 0, int i = 0);
124         int encodeIdx() const;
125 };
126
127 CCL_NAMESPACE_END
128
129 #endif  /* __BVH_H__ */