Merging r58475 through r58700 from trunk into soc-2013-depsgraph_mt
[blender.git] / source / blender / blenkernel / intern / pbvh_intern.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __PBVH_INTERN_H__
22 #define __PBVH_INTERN_H__
23
24 /* Axis-aligned bounding box */
25 typedef struct {
26         float bmin[3], bmax[3];
27 } BB;
28
29 /* Axis-aligned bounding box with centroid */
30 typedef struct {
31         float bmin[3], bmax[3], bcentroid[3];
32 } BBC;
33
34 /* Note: this structure is getting large, might want to split it into
35  * union'd structs */
36 struct PBVHNode {
37         /* Opaque handle for drawing code */
38         struct GPU_Buffers *draw_buffers;
39
40         /* Voxel bounds */
41         BB vb;
42         BB orig_vb;
43
44         /* For internal nodes, the offset of the children in the PBVH
45          * 'nodes' array. */
46         int children_offset;
47
48         /* Pointer into the PBVH prim_indices array and the number of
49          * primitives used by this leaf node.
50          *
51          * Used for leaf nodes in both mesh- and multires-based PBVHs.
52          */
53         int *prim_indices;
54         unsigned int totprim;
55
56         /* Array of indices into the mesh's MVert array. Contains the
57          * indices of all vertices used by faces that are within this
58          * node's bounding box.
59          *
60          * Note that a vertex might be used by a multiple faces, and
61          * these faces might be in different leaf nodes. Such a vertex
62          * will appear in the vert_indices array of each of those leaf
63          * nodes.
64          *
65          * In order to support cases where you want access to multiple
66          * nodes' vertices without duplication, the vert_indices array
67          * is ordered such that the first part of the array, up to
68          * index 'uniq_verts', contains "unique" vertex indices. These
69          * vertices might not be truly unique to this node, but if
70          * they appear in another node's vert_indices array, they will
71          * be above that node's 'uniq_verts' value.
72          *
73          * Used for leaf nodes in a mesh-based PBVH (not multires.)
74          */
75         int *vert_indices;
76         unsigned int uniq_verts, face_verts;
77
78         /* An array mapping face corners into the vert_indices
79          * array. The array is sized to match 'totprim', and each of
80          * the face's corners gets an index into the vert_indices
81          * array, in the same order as the corners in the original
82          * MFace. The fourth value should not be used if the original
83          * face is a triangle.
84          *
85          * Used for leaf nodes in a mesh-based PBVH (not multires.)
86          */
87         int (*face_vert_indices)[4];
88
89         /* Indicates whether this node is a leaf or not; also used for
90          * marking various updates that need to be applied. */
91         PBVHNodeFlags flag : 16;
92
93         /* Used for raycasting: how close bb is to the ray point. */
94         float tmin;
95
96         /* Scalar displacements for sculpt mode's layer brush. */
97         float *layer_disp;
98
99         int proxy_count;
100         PBVHProxyNode *proxies;
101
102         /* Dyntopo */
103         GHash *bm_faces;
104         GHash *bm_unique_verts;
105         GHash *bm_other_verts;
106         float (*bm_orco)[3];
107         int (*bm_ortri)[3];
108         int bm_tot_ortri;
109 };
110
111 typedef enum {
112         PBVH_DYNTOPO_SMOOTH_SHADING = 1
113 } PBVHFlags;
114
115 typedef struct PBVHBMeshLog PBVHBMeshLog;
116
117 struct PBVH {
118         PBVHType type;
119         PBVHFlags flags;
120
121         PBVHNode *nodes;
122         int node_mem_count, totnode;
123
124         int *prim_indices;
125         int totprim;
126         int totvert;
127
128         int leaf_limit;
129
130         /* Mesh data */
131         MVert *verts;
132         MFace *faces;
133         CustomData *vdata;
134
135         /* Grid Data */
136         CCGKey gridkey;
137         CCGElem **grids;
138         DMGridAdjacency *gridadj;
139         void **gridfaces;
140         const DMFlagMat *grid_flag_mats;
141         int totgrid;
142         BLI_bitmap **grid_hidden;
143
144         /* Only used during BVH build and update,
145          * don't need to remain valid after */
146         BLI_bitmap *vert_bitmap;
147
148 #ifdef PERFCNTRS
149         int perf_modified;
150 #endif
151
152         /* flag are verts/faces deformed */
153         int deformed;
154
155         int show_diffuse_color;
156
157         /* Dynamic topology */
158         BMesh *bm;
159         GHash *bm_face_to_node;
160         GHash *bm_vert_to_node;
161         float bm_max_edge_len;
162         float bm_min_edge_len;
163
164         struct BMLog *bm_log;
165 };
166
167 /* pbvh.c */
168 void BB_reset(BB *bb);
169 void BB_expand(BB *bb, const float co[3]);
170 void BB_expand_with_bb(BB *bb, BB *bb2);
171 void BBC_update_centroid(BBC *bbc);
172 int BB_widest_axis(const BB *bb);
173 void pbvh_grow_nodes(PBVH *bvh, int totnode);
174 int ray_face_intersection(const float ray_start[3], const float ray_normal[3],
175                                                   const float *t0, const float *t1, const float *t2,
176                                                   const float *t3, float *fdist);
177 void pbvh_update_BB_redraw(PBVH *bvh, PBVHNode **nodes, int totnode, int flag);
178
179 /* pbvh_bmesh.c */
180 int pbvh_bmesh_node_raycast(PBVHNode *node, const float ray_start[3],
181                                                         const float ray_normal[3], float *dist,
182                                                         int use_original);
183
184 void pbvh_bmesh_normals_update(PBVHNode **nodes, int totnode);
185
186 #endif