Cycles microdisplacement: move subdivision options to subsurf modifier
[blender-staging.git] / intern / cycles / render / mesh.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __MESH_H__
18 #define __MESH_H__
19
20 #include "attribute.h"
21 #include "node.h"
22 #include "shader.h"
23
24 #include "util_boundbox.h"
25 #include "util_list.h"
26 #include "util_map.h"
27 #include "util_param.h"
28 #include "util_transform.h"
29 #include "util_types.h"
30 #include "util_vector.h"
31
32 CCL_NAMESPACE_BEGIN
33
34 class BVH;
35 class Device;
36 class DeviceScene;
37 class Mesh;
38 class Progress;
39 class Scene;
40 class SceneParams;
41 class AttributeRequest;
42 class DiagSplit;
43
44 /* Mesh */
45
46 class Mesh : public Node {
47 public:
48         NODE_DECLARE;
49
50         /* Mesh Triangle */
51         struct Triangle {
52                 int v[3];
53
54                 void bounds_grow(const float3 *verts, BoundBox& bounds) const;
55         };
56
57         Triangle get_triangle(size_t i) const
58         {
59                 Triangle tri = {{triangles[i*3 + 0], triangles[i*3 + 1], triangles[i*3 + 2]}};
60                 return tri;
61         }
62
63         size_t num_triangles() const
64         {
65                 return triangles.size() / 3;
66         }
67
68         /* Mesh Curve */
69         struct Curve {
70                 int first_key;
71                 int num_keys;
72
73                 int num_segments() { return num_keys - 1; }
74
75                 void bounds_grow(const int k,
76                                  const float3 *curve_keys,
77                                  const float *curve_radius,
78                                  BoundBox& bounds) const;
79                 void bounds_grow(const int k,
80                                  const float3 *curve_keys,
81                                  const float *curve_radius,
82                                  const Transform& aligned_space,
83                                  BoundBox& bounds) const;
84         };
85
86         Curve get_curve(size_t i) const
87         {
88                 int first = curve_first_key[i];
89                 int next_first = (i+1 < curve_first_key.size()) ? curve_first_key[i+1] : curve_keys.size();
90
91                 Curve curve = {first, next_first - first};
92                 return curve;
93         }
94
95         size_t num_curves() const
96         {
97                 return curve_first_key.size();
98         }
99
100         /* Mesh SubdFace */
101         struct SubdFace {
102                 int start_corner;
103                 int num_corners;
104                 int shader;
105                 bool smooth;
106                 int ptex_offset;
107
108                 bool is_quad() { return num_corners == 4; }
109                 float3 normal(const Mesh *mesh) const;
110                 int num_ptex_faces() const { return num_corners == 4 ? 1 : num_corners; }
111         };
112
113         /* Displacement */
114         enum DisplacementMethod {
115                 DISPLACE_BUMP = 0,
116                 DISPLACE_TRUE = 1,
117                 DISPLACE_BOTH = 2,
118
119                 DISPLACE_NUM_METHODS,
120         };
121
122         enum SubdivisionType {
123                 SUBDIVISION_NONE,
124                 SUBDIVISION_LINEAR,
125                 SUBDIVISION_CATMULL_CLARK,
126         };
127
128         SubdivisionType subdivision_type;
129
130         /* Mesh Data */
131         enum GeometryFlags {
132                 GEOMETRY_NONE      = 0,
133                 GEOMETRY_TRIANGLES = (1 << 0),
134                 GEOMETRY_CURVES    = (1 << 1),
135         };
136         int geometry_flags;  /* used to distinguish meshes with no verts
137                                 and meshed for which geometry is not created */
138
139         array<int> triangles;
140         array<float3> verts;
141         array<int> shader;
142         array<bool> smooth;
143
144         /* used for storing patch info for subd triangles, only allocated if there are patches */
145         array<int> triangle_patch; /* must be < 0 for non subd triangles */
146         array<float2> vert_patch_uv;
147
148         bool has_volume;  /* Set in the device_update_flags(). */
149         bool has_surface_bssrdf;  /* Set in the device_update_flags(). */
150
151         array<float3> curve_keys;
152         array<float> curve_radius;
153         array<int> curve_first_key;
154         array<int> curve_shader;
155
156         array<SubdFace> subd_faces;
157         array<int> subd_face_corners;
158         int num_ngons;
159
160         vector<Shader*> used_shaders;
161         AttributeSet attributes;
162         AttributeSet curve_attributes;
163         AttributeSet subd_attributes;
164
165         BoundBox bounds;
166         bool transform_applied;
167         bool transform_negative_scaled;
168         Transform transform_normal;
169         DisplacementMethod displacement_method;
170
171         uint motion_steps;
172         bool use_motion_blur;
173
174         /* Update Flags */
175         bool need_update;
176         bool need_update_rebuild;
177
178         /* BVH */
179         BVH *bvh;
180         size_t tri_offset;
181         size_t vert_offset;
182
183         size_t curve_offset;
184         size_t curvekey_offset;
185
186         size_t patch_offset;
187         size_t face_offset;
188         size_t corner_offset;
189
190         size_t num_subd_verts;
191
192         /* Functions */
193         Mesh();
194         ~Mesh();
195
196         void resize_mesh(int numverts, int numfaces);
197         void reserve_mesh(int numverts, int numfaces);
198         void resize_curves(int numcurves, int numkeys);
199         void reserve_curves(int numcurves, int numkeys);
200         void resize_subd_faces(int numfaces, int num_ngons, int numcorners);
201         void reserve_subd_faces(int numfaces, int num_ngons, int numcorners);
202         void clear();
203         void add_vertex(float3 P);
204         void add_vertex_slow(float3 P);
205         void add_triangle(int v0, int v1, int v2, int shader, bool smooth);
206         void add_curve_key(float3 loc, float radius);
207         void add_curve(int first_key, int shader);
208         void add_subd_face(int* corners, int num_corners, int shader_, bool smooth_);
209         int split_vertex(int vertex);
210
211         void compute_bounds();
212         void add_face_normals();
213         void add_vertex_normals();
214
215         void pack_normals(Scene *scene, uint *shader, float4 *vnormal);
216         void pack_verts(const vector<uint>& tri_prim_index,
217                         uint4 *tri_vindex,
218                         uint *tri_patch,
219                         float2 *tri_patch_uv,
220                         size_t vert_offset,
221                         size_t tri_offset);
222         void pack_curves(Scene *scene, float4 *curve_key_co, float4 *curve_data, size_t curvekey_offset);
223         void pack_patches(uint *patch_data, uint vert_offset, uint face_offset, uint corner_offset);
224
225         void compute_bvh(DeviceScene *dscene,
226                          SceneParams *params,
227                          Progress *progress,
228                          int n,
229                          int total);
230
231         bool need_attribute(Scene *scene, AttributeStandard std);
232         bool need_attribute(Scene *scene, ustring name);
233
234         void tag_update(Scene *scene, bool rebuild);
235
236         bool has_motion_blur() const;
237
238         /* Check whether the mesh should have own BVH built separately. Briefly,
239          * own BVH is needed for mesh, if:
240          *
241          * - It is instanced multiple times, so each instance object should share the
242          *   same BVH tree.
243          * - Special ray intersection is needed, for example to limit subsurface rays
244          *   to only the mesh itself.
245          */
246         bool need_build_bvh() const;
247
248         /* Check if the mesh should be treated as instanced. */
249         bool is_instanced() const;
250
251         void tessellate(DiagSplit *split);
252 };
253
254 /* Mesh Manager */
255
256 class MeshManager {
257 public:
258         BVH *bvh;
259
260         bool need_update;
261         bool need_flags_update;
262
263         MeshManager();
264         ~MeshManager();
265
266         bool displace(Device *device, DeviceScene *dscene, Scene *scene, Mesh *mesh, Progress& progress);
267
268         /* attributes */
269         void update_osl_attributes(Device *device, Scene *scene, vector<AttributeRequestSet>& mesh_attributes);
270         void update_svm_attributes(Device *device, DeviceScene *dscene, Scene *scene, vector<AttributeRequestSet>& mesh_attributes);
271
272         void device_update(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
273         void device_update_flags(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
274
275         void device_free(Device *device, DeviceScene *dscene);
276
277         void tag_update(Scene *scene);
278
279 protected:
280         /* Calculate verts/triangles/curves offsets in global arrays. */
281         void mesh_calc_offset(Scene *scene);
282
283         void device_update_object(Device *device,
284                                   DeviceScene *dscene,
285                                   Scene *scene,
286                                   Progress& progress);
287
288         void device_update_mesh(Device *device,
289                                 DeviceScene *dscene,
290                                 Scene *scene,
291                                 bool for_displacement,
292                                 Progress& progress);
293
294         void device_update_attributes(Device *device,
295                                       DeviceScene *dscene,
296                                       Scene *scene,
297                                       Progress& progress);
298
299         void device_update_bvh(Device *device,
300                                DeviceScene *dscene,
301                                Scene *scene,
302                                Progress& progress);
303
304         void device_update_displacement_images(Device *device,
305                                                DeviceScene *dscene,
306                                                Scene *scene,
307                                                Progress& progress);
308 };
309
310 CCL_NAMESPACE_END
311
312 #endif /* __MESH_H__ */
313