Cycles microdisplacement: Move displacement options from mesh to material settings
[blender.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 struct PackedPatchTable;
44
45 /* Mesh */
46
47 class Mesh : public Node {
48 public:
49         NODE_DECLARE;
50
51         /* Mesh Triangle */
52         struct Triangle {
53                 int v[3];
54
55                 void bounds_grow(const float3 *verts, BoundBox& bounds) const;
56         };
57
58         Triangle get_triangle(size_t i) const
59         {
60                 Triangle tri = {{triangles[i*3 + 0], triangles[i*3 + 1], triangles[i*3 + 2]}};
61                 return tri;
62         }
63
64         size_t num_triangles() const
65         {
66                 return triangles.size() / 3;
67         }
68
69         /* Mesh Curve */
70         struct Curve {
71                 int first_key;
72                 int num_keys;
73
74                 int num_segments() { return num_keys - 1; }
75
76                 void bounds_grow(const int k,
77                                  const float3 *curve_keys,
78                                  const float *curve_radius,
79                                  BoundBox& bounds) const;
80                 void bounds_grow(const int k,
81                                  const float3 *curve_keys,
82                                  const float *curve_radius,
83                                  const Transform& aligned_space,
84                                  BoundBox& bounds) const;
85         };
86
87         Curve get_curve(size_t i) const
88         {
89                 int first = curve_first_key[i];
90                 int next_first = (i+1 < curve_first_key.size()) ? curve_first_key[i+1] : curve_keys.size();
91
92                 Curve curve = {first, next_first - first};
93                 return curve;
94         }
95
96         size_t num_curves() const
97         {
98                 return curve_first_key.size();
99         }
100
101         /* Mesh SubdFace */
102         struct SubdFace {
103                 int start_corner;
104                 int num_corners;
105                 int shader;
106                 bool smooth;
107                 int ptex_offset;
108
109                 bool is_quad() { return num_corners == 4; }
110                 float3 normal(const Mesh *mesh) const;
111                 int num_ptex_faces() const { return num_corners == 4 ? 1 : num_corners; }
112         };
113
114         struct SubdEdgeCrease {
115                 int v[2];
116                 float crease;
117         };
118
119         enum SubdivisionType {
120                 SUBDIVISION_NONE,
121                 SUBDIVISION_LINEAR,
122                 SUBDIVISION_CATMULL_CLARK,
123         };
124
125         SubdivisionType subdivision_type;
126
127         /* Mesh Data */
128         enum GeometryFlags {
129                 GEOMETRY_NONE      = 0,
130                 GEOMETRY_TRIANGLES = (1 << 0),
131                 GEOMETRY_CURVES    = (1 << 1),
132         };
133         int geometry_flags;  /* used to distinguish meshes with no verts
134                                 and meshed for which geometry is not created */
135
136         array<int> triangles;
137         array<float3> verts;
138         array<int> shader;
139         array<bool> smooth;
140
141         /* used for storing patch info for subd triangles, only allocated if there are patches */
142         array<int> triangle_patch; /* must be < 0 for non subd triangles */
143         array<float2> vert_patch_uv;
144
145         bool has_volume;  /* Set in the device_update_flags(). */
146         bool has_surface_bssrdf;  /* Set in the device_update_flags(). */
147
148         array<float3> curve_keys;
149         array<float> curve_radius;
150         array<int> curve_first_key;
151         array<int> curve_shader;
152
153         array<SubdFace> subd_faces;
154         array<int> subd_face_corners;
155         int num_ngons;
156
157         array<SubdEdgeCrease> subd_creases;
158
159         vector<Shader*> used_shaders;
160         AttributeSet attributes;
161         AttributeSet curve_attributes;
162         AttributeSet subd_attributes;
163
164         BoundBox bounds;
165         bool transform_applied;
166         bool transform_negative_scaled;
167         Transform transform_normal;
168
169         PackedPatchTable *patch_table;
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 patch_table_offset;
188         size_t face_offset;
189         size_t corner_offset;
190
191         size_t num_subd_verts;
192
193         /* Functions */
194         Mesh();
195         ~Mesh();
196
197         void resize_mesh(int numverts, int numfaces);
198         void reserve_mesh(int numverts, int numfaces);
199         void resize_curves(int numcurves, int numkeys);
200         void reserve_curves(int numcurves, int numkeys);
201         void resize_subd_faces(int numfaces, int num_ngons, int numcorners);
202         void reserve_subd_faces(int numfaces, int num_ngons, int numcorners);
203         void clear();
204         void add_vertex(float3 P);
205         void add_vertex_slow(float3 P);
206         void add_triangle(int v0, int v1, int v2, int shader, bool smooth);
207         void add_curve_key(float3 loc, float radius);
208         void add_curve(int first_key, int shader);
209         void add_subd_face(int* corners, int num_corners, int shader_, bool smooth_);
210         int split_vertex(int vertex);
211
212         void compute_bounds();
213         void add_face_normals();
214         void add_vertex_normals();
215
216         void pack_normals(Scene *scene, uint *shader, float4 *vnormal);
217         void pack_verts(const vector<uint>& tri_prim_index,
218                         uint4 *tri_vindex,
219                         uint *tri_patch,
220                         float2 *tri_patch_uv,
221                         size_t vert_offset,
222                         size_t tri_offset);
223         void pack_curves(Scene *scene, float4 *curve_key_co, float4 *curve_data, size_t curvekey_offset);
224         void pack_patches(uint *patch_data, uint vert_offset, uint face_offset, uint corner_offset);
225
226         void compute_bvh(DeviceScene *dscene,
227                          SceneParams *params,
228                          Progress *progress,
229                          int n,
230                          int total);
231
232         bool need_attribute(Scene *scene, AttributeStandard std);
233         bool need_attribute(Scene *scene, ustring name);
234
235         void tag_update(Scene *scene, bool rebuild);
236
237         bool has_motion_blur() const;
238         bool has_true_displacement() const;
239
240         /* Check whether the mesh should have own BVH built separately. Briefly,
241          * own BVH is needed for mesh, if:
242          *
243          * - It is instanced multiple times, so each instance object should share the
244          *   same BVH tree.
245          * - Special ray intersection is needed, for example to limit subsurface rays
246          *   to only the mesh itself.
247          */
248         bool need_build_bvh() const;
249
250         /* Check if the mesh should be treated as instanced. */
251         bool is_instanced() const;
252
253         void tessellate(DiagSplit *split);
254 };
255
256 /* Mesh Manager */
257
258 class MeshManager {
259 public:
260         BVH *bvh;
261
262         bool need_update;
263         bool need_flags_update;
264
265         MeshManager();
266         ~MeshManager();
267
268         bool displace(Device *device, DeviceScene *dscene, Scene *scene, Mesh *mesh, Progress& progress);
269
270         /* attributes */
271         void update_osl_attributes(Device *device, Scene *scene, vector<AttributeRequestSet>& mesh_attributes);
272         void update_svm_attributes(Device *device, DeviceScene *dscene, Scene *scene, vector<AttributeRequestSet>& mesh_attributes);
273
274         void device_update(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
275         void device_update_flags(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
276
277         void device_free(Device *device, DeviceScene *dscene);
278
279         void tag_update(Scene *scene);
280
281 protected:
282         /* Calculate verts/triangles/curves offsets in global arrays. */
283         void mesh_calc_offset(Scene *scene);
284
285         void device_update_object(Device *device,
286                                   DeviceScene *dscene,
287                                   Scene *scene,
288                                   Progress& progress);
289
290         void device_update_mesh(Device *device,
291                                 DeviceScene *dscene,
292                                 Scene *scene,
293                                 bool for_displacement,
294                                 Progress& progress);
295
296         void device_update_attributes(Device *device,
297                                       DeviceScene *dscene,
298                                       Scene *scene,
299                                       Progress& progress);
300
301         void device_update_bvh(Device *device,
302                                DeviceScene *dscene,
303                                Scene *scene,
304                                Progress& progress);
305
306         void device_update_displacement_images(Device *device,
307                                                DeviceScene *dscene,
308                                                Scene *scene,
309                                                Progress& progress);
310 };
311
312 CCL_NAMESPACE_END
313
314 #endif /* __MESH_H__ */
315