Mesh Remap: Face Corner Data: Do not use large epsilon values to create bvhtrees.
[blender.git] / source / blender / blenkernel / BKE_modifier.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  * The Original Code is: all of this file.
19  *
20  * Contributor(s): none yet.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24 #ifndef __BKE_MODIFIER_H__
25 #define __BKE_MODIFIER_H__
26
27 /** \file BKE_modifier.h
28  *  \ingroup bke
29  */
30
31 #include "DNA_modifier_types.h"     /* needed for all enum typdefs */
32 #include "BLI_compiler_attrs.h"
33 #include "BKE_customdata.h"
34
35 struct ID;
36 struct DerivedMesh;
37 struct DagForest;
38 struct DagNode;
39 struct Object;
40 struct Scene;
41 struct ListBase;
42 struct bArmature;
43 struct Main;
44 struct ModifierData;
45 struct BMEditMesh;
46 struct DepsNodeHandle;
47
48 typedef enum {
49         /* Should not be used, only for None modifier type */
50         eModifierTypeType_None,
51
52         /* Modifier only does deformation, implies that modifier
53          * type should have a valid deformVerts function. OnlyDeform
54          * style modifiers implicitly accept either mesh or CV
55          * input but should still declare flags appropriately.
56          */
57         eModifierTypeType_OnlyDeform,
58
59         eModifierTypeType_Constructive,
60         eModifierTypeType_Nonconstructive,
61
62         /* both deformVerts & applyModifier are valid calls
63          * used for particles modifier that doesn't actually modify the object
64          * unless it's a mesh and can be exploded -> curve can also emit particles
65          */
66         eModifierTypeType_DeformOrConstruct,
67
68         /* Like eModifierTypeType_Nonconstructive, but does not affect the geometry
69          * of the object, rather some of its CustomData layers.
70          * E.g. UVProject and WeightVG modifiers. */
71         eModifierTypeType_NonGeometrical,
72 } ModifierTypeType;
73
74 typedef enum {
75         eModifierTypeFlag_AcceptsMesh          = (1 << 0),
76         eModifierTypeFlag_AcceptsCVs           = (1 << 1),
77         eModifierTypeFlag_SupportsMapping      = (1 << 2),
78         eModifierTypeFlag_SupportsEditmode     = (1 << 3),
79
80         /* For modifiers that support editmode this determines if the
81          * modifier should be enabled by default in editmode. This should
82          * only be used by modifiers that are relatively speedy and
83          * also generally used in editmode, otherwise let the user enable
84          * it by hand.
85          */
86         eModifierTypeFlag_EnableInEditmode     = (1 << 4),
87
88         /* For modifiers that require original data and so cannot
89          * be placed after any non-deformative modifier.
90          */
91         eModifierTypeFlag_RequiresOriginalData = (1 << 5),
92
93         /* For modifiers that support pointcache, so we can check to see if it has files we need to deal with
94          */
95         eModifierTypeFlag_UsesPointCache = (1 << 6),
96
97         /* For physics modifiers, max one per type */
98         eModifierTypeFlag_Single = (1 << 7),
99
100         /* Some modifier can't be added manually by user */
101         eModifierTypeFlag_NoUserAdd = (1 << 8),
102
103         /* For modifiers that use CD_PREVIEW_MCOL for preview. */
104         eModifierTypeFlag_UsesPreview = (1 << 9),
105         eModifierTypeFlag_AcceptsLattice = (1 << 10),
106 } ModifierTypeFlag;
107
108 /* IMPORTANT! Keep ObjectWalkFunc and IDWalkFunc signatures compatible. */
109 typedef void (*ObjectWalkFunc)(void *userData, struct Object *ob, struct Object **obpoin, int cb_flag);
110 typedef void (*IDWalkFunc)(void *userData, struct Object *ob, struct ID **idpoin, int cb_flag);
111 typedef void (*TexWalkFunc)(void *userData, struct Object *ob, struct ModifierData *md, const char *propname);
112
113 typedef enum ModifierApplyFlag {
114         MOD_APPLY_RENDER = 1 << 0,       /* Render time. */
115         MOD_APPLY_USECACHE = 1 << 1,     /* Result of evaluation will be cached, so modifier might
116                                           * want to cache data for quick updates (used by subsurf) */
117         MOD_APPLY_ORCO = 1 << 2,         /* Modifier evaluated for undeformed texture coordinates */
118         MOD_APPLY_IGNORE_SIMPLIFY = 1 << 3, /* Ignore scene simplification flag and use subdivisions
119                                              * level set in multires modifier.
120                                              */
121         MOD_APPLY_ALLOW_GPU = 1 << 4,  /* Allow modifier to be applied and stored in the GPU.
122                                         * Used by the viewport in order to be able to have SS
123                                         * happening on GPU.
124                                         * Render pipeline (including viewport render) should
125                                         * have DM on the CPU.
126                                         */
127 } ModifierApplyFlag;
128
129
130 typedef struct ModifierUpdateDepsgraphContext {
131         struct Scene *scene;
132         struct Object *object;
133
134         /* Old depsgraph node handle. */
135         struct DagForest *forest;
136         struct DagNode *obNode;
137
138         /* new depsgraph node handle. */
139         struct DepsNodeHandle *node;
140 } ModifierUpdateDepsgraphContext;
141
142 typedef struct ModifierTypeInfo {
143         /* The user visible name for this modifier */
144         char name[32];
145
146         /* The DNA struct name for the modifier data type, used to
147          * write the DNA data out.
148          */
149         char structName[32];
150
151         /* The size of the modifier data type, used by allocation. */
152         int structSize;
153
154         ModifierTypeType type;
155         ModifierTypeFlag flags;
156
157
158         /********************* Non-optional functions *********************/
159
160         /* Copy instance data for this modifier type. Should copy all user
161          * level settings to the target modifier.
162          */
163         void (*copyData)(struct ModifierData *md, struct ModifierData *target);
164
165         /********************* Deform modifier functions *********************/
166
167         /* Only for deform types, should apply the deformation
168          * to the given vertex array. If the deformer requires information from
169          * the object it can obtain it from the derivedData argument if non-NULL,
170          * and otherwise the ob argument.
171          */
172         void (*deformVerts)(struct ModifierData *md, struct Object *ob,
173                             struct DerivedMesh *derivedData,
174                             float (*vertexCos)[3], int numVerts,
175                             ModifierApplyFlag flag);
176
177         /* Like deformMatricesEM but called from object mode (for supporting modifiers in sculpt mode) */
178         void (*deformMatrices)(struct ModifierData *md, struct Object *ob,
179                                struct DerivedMesh *derivedData,
180                                float (*vertexCos)[3], float (*defMats)[3][3], int numVerts);
181
182         /* Like deformVerts but called during editmode (for supporting modifiers)
183          */
184         void (*deformVertsEM)(struct ModifierData *md, struct Object *ob,
185                               struct BMEditMesh *editData, struct DerivedMesh *derivedData,
186                               float (*vertexCos)[3], int numVerts);
187
188         /* Set deform matrix per vertex for crazyspace correction */
189         void (*deformMatricesEM)(struct ModifierData *md, struct Object *ob,
190                                  struct BMEditMesh *editData, struct DerivedMesh *derivedData,
191                                  float (*vertexCos)[3], float (*defMats)[3][3], int numVerts);
192
193         /********************* Non-deform modifier functions *********************/
194
195         /* For non-deform types: apply the modifier and return a derived
196          * data object (type is dependent on object type).
197          *
198          * The derivedData argument should always be non-NULL; the modifier
199          * should read the object data from the derived object instead of the
200          * actual object data. 
201          *
202          * The useRenderParams argument indicates if the modifier is being
203          * applied in the service of the renderer which may alter quality
204          * settings.
205          *
206          * The isFinalCalc parameter indicates if the modifier is being
207          * calculated for a final result or for something temporary
208          * (like orcos). This is a hack at the moment, it is meant so subsurf
209          * can know if it is safe to reuse its internal cache.
210          *
211          * The modifier may reuse the derivedData argument (i.e. return it in
212          * modified form), but must not release it.
213          */
214         struct DerivedMesh *(*applyModifier)(struct ModifierData *md, struct Object *ob,
215                                              struct DerivedMesh *derivedData,
216                                              ModifierApplyFlag flag);
217
218         /* Like applyModifier but called during editmode (for supporting
219          * modifiers).
220          * 
221          * The derived object that is returned must support the operations that
222          * are expected from editmode objects. The same qualifications regarding
223          * derivedData apply as for applyModifier.
224          */
225         struct DerivedMesh *(*applyModifierEM)(struct ModifierData *md, struct Object *ob,
226                                                struct BMEditMesh *editData,
227                                                struct DerivedMesh *derivedData,
228                                                ModifierApplyFlag flag);
229
230
231         /********************* Optional functions *********************/
232
233         /* Initialize new instance data for this modifier type, this function
234          * should set modifier variables to their default values.
235          * 
236          * This function is optional.
237          */
238         void (*initData)(struct ModifierData *md);
239
240         /* Should return a CustomDataMask indicating what data this
241          * modifier needs. If (mask & (1 << (layer type))) != 0, this modifier
242          * needs that custom data layer. This function's return value can change
243          * depending on the modifier's settings.
244          *
245          * Note that this means extra data (e.g. vertex groups) - it is assumed
246          * that all modifiers need mesh data and deform modifiers need vertex
247          * coordinates.
248          *
249          * Note that this limits the number of custom data layer types to 32.
250          *
251          * If this function is not present or it returns 0, it is assumed that
252          * no extra data is needed.
253          *
254          * This function is optional.
255          */
256         CustomDataMask (*requiredDataMask)(struct Object *ob, struct ModifierData *md);
257
258         /* Free internal modifier data variables, this function should
259          * not free the md variable itself.
260          *
261          * This function is optional.
262          */
263         void (*freeData)(struct ModifierData *md);
264
265         /* Return a boolean value indicating if this modifier is able to be
266          * calculated based on the modifier data. This is *not* regarding the
267          * md->flag, that is tested by the system, this is just if the data
268          * validates (for example, a lattice will return false if the lattice
269          * object is not defined).
270          *
271          * This function is optional (assumes never disabled if not present).
272          */
273         bool (*isDisabled)(struct ModifierData *md, int userRenderParams);
274
275         /* Add the appropriate relations to the DEP graph depending on the
276          * modifier data. 
277          *
278          * This function is optional.
279          */
280         void (*updateDepgraph)(struct ModifierData *md,
281                                const ModifierUpdateDepsgraphContext *ctx);
282
283         /* Add the appropriate relations to the dependency graph.
284          *
285          * This function is optional.
286          */
287         /* TODO(sergey): Remove once we finally switched to the new depsgraph. */
288         void (*updateDepsgraph)(struct ModifierData *md,
289                                 const ModifierUpdateDepsgraphContext *ctx);
290
291         /* Should return true if the modifier needs to be recalculated on time
292          * changes.
293          *
294          * This function is optional (assumes false if not present).
295          */
296         bool (*dependsOnTime)(struct ModifierData *md);
297
298
299         /* True when a deform modifier uses normals, the requiredDataMask
300          * cant be used here because that refers to a normal layer where as
301          * in this case we need to know if the deform modifier uses normals.
302          * 
303          * this is needed because applying 2 deform modifiers will give the
304          * second modifier bogus normals.
305          * */
306         bool (*dependsOnNormals)(struct ModifierData *md);
307
308
309         /* Should call the given walk function on with a pointer to each Object
310          * pointer that the modifier data stores. This is used for linking on file
311          * load and for unlinking objects or forwarding object references.
312          *
313          * This function is optional.
314          */
315         void (*foreachObjectLink)(struct ModifierData *md, struct Object *ob,
316                                   ObjectWalkFunc walk, void *userData);
317
318         /* Should call the given walk function with a pointer to each ID
319          * pointer (i.e. each datablock pointer) that the modifier data
320          * stores. This is used for linking on file load and for
321          * unlinking datablocks or forwarding datablock references.
322          *
323          * This function is optional. If it is not present, foreachObjectLink
324          * will be used.
325          */
326         void (*foreachIDLink)(struct ModifierData *md, struct Object *ob,
327                               IDWalkFunc walk, void *userData);
328
329         /* Should call the given walk function for each texture that the
330          * modifier data stores. This is used for finding all textures in
331          * the context for the UI.
332          *
333          * This function is optional. If it is not present, it will be
334          * assumed the modifier has no textures.
335          */
336         void (*foreachTexLink)(struct ModifierData *md, struct Object *ob,
337                                TexWalkFunc walk, void *userData);
338 } ModifierTypeInfo;
339
340 /* Initialize modifier's global data (type info and some common global storages). */
341 void BKE_modifier_init(void);
342
343 const ModifierTypeInfo *modifierType_getInfo(ModifierType type);
344
345 /* Modifier utility calls, do call through type pointer and return
346  * default values if pointer is optional.
347  */
348 struct ModifierData  *modifier_new(int type);
349 void          modifier_free_ex(struct ModifierData *md, const int flag);
350 void          modifier_free(struct ModifierData *md);
351
352 bool          modifier_unique_name(struct ListBase *modifiers, struct ModifierData *md);
353
354 void          modifier_copyData_generic(const struct ModifierData *md, struct ModifierData *target);
355 void          modifier_copyData(struct ModifierData *md, struct ModifierData *target);
356 void          modifier_copyData_ex(struct ModifierData *md, struct ModifierData *target, const int flag);
357 bool          modifier_dependsOnTime(struct ModifierData *md);
358 bool          modifier_supportsMapping(struct ModifierData *md);
359 bool          modifier_supportsCage(struct Scene *scene, struct ModifierData *md);
360 bool          modifier_couldBeCage(struct Scene *scene, struct ModifierData *md);
361 bool          modifier_isCorrectableDeformed(struct ModifierData *md);
362 bool          modifier_isSameTopology(ModifierData *md);
363 bool          modifier_isNonGeometrical(ModifierData *md);
364 bool          modifier_isEnabled(struct Scene *scene, struct ModifierData *md, int required_mode);
365 void          modifier_setError(struct ModifierData *md, const char *format, ...) ATTR_PRINTF_FORMAT(2, 3);
366 bool          modifier_isPreview(struct ModifierData *md);
367
368 void          modifiers_foreachObjectLink(struct Object *ob,
369                                           ObjectWalkFunc walk,
370                                           void *userData);
371 void          modifiers_foreachIDLink(struct Object *ob,
372                                       IDWalkFunc walk,
373                                       void *userData);
374 void          modifiers_foreachTexLink(struct Object *ob,
375                                        TexWalkFunc walk,
376                                        void *userData);
377
378 struct ModifierData  *modifiers_findByType(struct Object *ob, ModifierType type);
379 struct ModifierData  *modifiers_findByName(struct Object *ob, const char *name);
380 void          modifiers_clearErrors(struct Object *ob);
381 int           modifiers_getCageIndex(struct Scene *scene, struct Object *ob,
382                                      int *r_lastPossibleCageIndex, bool is_virtual);
383
384 bool          modifiers_isModifierEnabled(struct Object *ob, int modifierType);
385 bool          modifiers_isSoftbodyEnabled(struct Object *ob);
386 bool          modifiers_isClothEnabled(struct Object *ob);
387 bool          modifiers_isParticleEnabled(struct Object *ob);
388
389 struct Object *modifiers_isDeformedByArmature(struct Object *ob);
390 struct Object *modifiers_isDeformedByLattice(struct Object *ob);
391 struct Object *modifiers_isDeformedByCurve(struct Object *ob);
392 bool          modifiers_usesArmature(struct Object *ob, struct bArmature *arm);
393 bool          modifiers_isCorrectableDeformed(struct Scene *scene, struct Object *ob);
394 void          modifier_freeTemporaryData(struct ModifierData *md);
395 bool          modifiers_isPreview(struct Object *ob);
396
397 typedef struct CDMaskLink {
398         struct CDMaskLink *next;
399         CustomDataMask mask;
400 } CDMaskLink;
401
402 /* Calculates and returns a linked list of CustomDataMasks indicating the
403  * data required by each modifier in the stack pointed to by md for correct
404  * evaluation, assuming the data indicated by dataMask is required at the
405  * end of the stack.
406  */
407 struct CDMaskLink *modifiers_calcDataMasks(struct Scene *scene,
408                                            struct Object *ob,
409                                            struct ModifierData *md,
410                                            CustomDataMask dataMask,
411                                            int required_mode,
412                                            ModifierData *previewmd, CustomDataMask previewmask);
413 struct ModifierData *modifiers_getLastPreview(struct Scene *scene,
414                                               struct ModifierData *md,
415                                               int required_mode);
416
417 typedef struct VirtualModifierData {
418         ArmatureModifierData amd;
419         CurveModifierData cmd;
420         LatticeModifierData lmd;
421         ShapeKeyModifierData smd;
422 } VirtualModifierData;
423
424 struct ModifierData  *modifiers_getVirtualModifierList(struct Object *ob, struct VirtualModifierData *data);
425
426 /* ensure modifier correctness when changing ob->data */
427 void test_object_modifiers(struct Object *ob);
428
429 /* here for do_versions */
430 void modifier_mdef_compact_influences(struct ModifierData *md);
431
432 void        modifier_path_init(char *path, int path_maxlen, const char *name);
433 const char *modifier_path_relbase(struct Object *ob);
434
435
436 /* wrappers for modifier callbacks */
437
438 struct DerivedMesh *modwrap_applyModifier(
439         ModifierData *md, struct Object *ob,
440         struct DerivedMesh *dm,
441         ModifierApplyFlag flag);
442
443 struct DerivedMesh *modwrap_applyModifierEM(
444         ModifierData *md, struct Object *ob,
445         struct BMEditMesh *em,
446         struct DerivedMesh *dm,
447         ModifierApplyFlag flag);
448
449 void modwrap_deformVerts(
450         ModifierData *md, struct Object *ob,
451         struct DerivedMesh *dm,
452         float (*vertexCos)[3], int numVerts,
453         ModifierApplyFlag flag);
454
455 void modwrap_deformVertsEM(
456         ModifierData *md, struct Object *ob,
457         struct BMEditMesh *em, struct DerivedMesh *dm,
458         float (*vertexCos)[3], int numVerts);
459
460 #endif
461