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