merging trunk 17221:17300
[blender.git] / source / blender / blenkernel / BKE_modifier.h
1 /**
2  *      
3  * $Id$ 
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
20  *
21  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30 #ifndef BKE_MODIFIER_H
31 #define BKE_MODIFIER_H
32
33 #include "DNA_modifier_types.h"         /* needed for all enum typdefs */
34 #include "BKE_customdata.h"
35
36 struct EditMesh;
37 struct DerivedMesh;
38 struct DagForest;
39 struct DagNode;
40 struct Object;
41 struct ListBase;
42 struct LinkNode;
43 struct bArmature;
44 struct ModifierData;
45
46 typedef enum {
47         /* Should not be used, only for None modifier type */
48         eModifierTypeType_None,
49
50         /* Modifier only does deformation, implies that modifier
51          * type should have a valid deformVerts function. OnlyDeform
52          * style modifiers implicitly accept either mesh or CV
53          * input but should still declare flags appropriately.
54          */
55         eModifierTypeType_OnlyDeform,
56
57         eModifierTypeType_Constructive,
58         eModifierTypeType_Nonconstructive,
59
60         /* both deformVerts & applyModifier are valid calls
61          * used for particles modifier that doesn't actually modify the object
62          * unless it's a mesh and can be exploded -> curve can also emit particles
63          */
64         eModifierTypeType_DeformOrConstruct
65 } ModifierTypeType;
66
67 typedef enum {
68         eModifierTypeFlag_AcceptsMesh          = (1<<0),
69         eModifierTypeFlag_AcceptsCVs           = (1<<1),
70         eModifierTypeFlag_SupportsMapping      = (1<<2),
71         eModifierTypeFlag_SupportsEditmode     = (1<<3),
72
73         /* For modifiers that support editmode this determines if the
74          * modifier should be enabled by default in editmode. This should
75          * only be used by modifiers that are relatively speedy and
76          * also generally used in editmode, otherwise let the user enable
77          * it by hand.
78          */
79         eModifierTypeFlag_EnableInEditmode     = (1<<4),
80
81         /* For modifiers that require original data and so cannot
82          * be placed after any non-deformative modifier.
83          */
84         eModifierTypeFlag_RequiresOriginalData = (1<<5),
85
86         /* For modifiers that support pointcache, so we can check to see if it has files we need to deal with
87         */
88         eModifierTypeFlag_UsesPointCache = (1<<6),
89 } ModifierTypeFlag;
90
91 typedef void (*ObjectWalkFunc)(void *userData, struct Object *ob, struct Object **obpoin);
92 typedef void (*IDWalkFunc)(void *userData, struct Object *ob, struct ID **idpoin);
93
94 typedef struct ModifierTypeInfo {
95         /* The user visible name for this modifier */
96         char name[32];
97
98         /* The DNA struct name for the modifier data type, used to
99          * write the DNA data out.
100          */
101         char structName[32];
102
103         /* The size of the modifier data type, used by allocation. */
104         int structSize;
105
106         ModifierTypeType type;
107         ModifierTypeFlag flags;
108
109
110         /********************* Non-optional functions *********************/
111
112         /* Copy instance data for this modifier type. Should copy all user
113          * level settings to the target modifier.
114          */
115         void (*copyData)(struct ModifierData *md, struct ModifierData *target);
116
117         /********************* Deform modifier functions *********************/
118
119         /* Only for deform types, should apply the deformation
120          * to the given vertex array. If the deformer requires information from
121          * the object it can obtain it from the derivedData argument if non-NULL,
122          * and otherwise the ob argument.
123          */
124         void (*deformVerts)(struct ModifierData *md, struct Object *ob,
125                             struct DerivedMesh *derivedData,
126                             float (*vertexCos)[3], int numVerts);
127
128         /* Like deformVerts but called during editmode (for supporting modifiers)
129          */
130         void (*deformVertsEM)(
131                     struct ModifierData *md, struct Object *ob,
132                     struct EditMesh *editData, struct DerivedMesh *derivedData,
133                     float (*vertexCos)[3], int numVerts);
134
135         /* Set deform matrix per vertex for crazyspace correction */
136         void (*deformMatricesEM)(
137                     struct ModifierData *md, struct Object *ob,
138                     struct EditMesh *editData, struct DerivedMesh *derivedData,
139                     float (*vertexCos)[3], float (*defMats)[3][3], int numVerts);
140
141         /********************* Non-deform modifier functions *********************/
142
143         /* For non-deform types: apply the modifier and return a derived
144          * data object (type is dependent on object type).
145          *
146          * The derivedData argument should always be non-NULL; the modifier
147          * should read the object data from the derived object instead of the
148          * actual object data. 
149          *
150          * The useRenderParams argument indicates if the modifier is being
151          * applied in the service of the renderer which may alter quality
152          * settings.
153          *
154          * The isFinalCalc parameter indicates if the modifier is being
155          * calculated for a final result or for something temporary
156          * (like orcos). This is a hack at the moment, it is meant so subsurf
157          * can know if it is safe to reuse its internal cache.
158          *
159          * The modifier may reuse the derivedData argument (i.e. return it in
160          * modified form), but must not release it.
161          */
162         struct DerivedMesh *(*applyModifier)(
163                                     struct ModifierData *md, struct Object *ob,
164                                     struct DerivedMesh *derivedData,
165                                     int useRenderParams, int isFinalCalc);
166
167         /* Like applyModifier but called during editmode (for supporting
168          * modifiers).
169          * 
170          * The derived object that is returned must support the operations that
171          * are expected from editmode objects. The same qualifications regarding
172          * derivedData apply as for applyModifier.
173          */
174         struct DerivedMesh *(*applyModifierEM)(
175                                     struct ModifierData *md, struct Object *ob,
176                                     struct EditMesh *editData,
177                                     struct DerivedMesh *derivedData);
178
179
180         /********************* Optional functions *********************/
181
182         /* Initialize new instance data for this modifier type, this function
183          * should set modifier variables to their default values.
184          * 
185          * This function is optional.
186          */
187         void (*initData)(struct ModifierData *md);
188
189         /* Should return a CustomDataMask indicating what data this
190          * modifier needs. If (mask & (1 << (layer type))) != 0, this modifier
191          * needs that custom data layer. This function's return value can change
192          * depending on the modifier's settings.
193          *
194          * Note that this means extra data (e.g. vertex groups) - it is assumed
195          * that all modifiers need mesh data and deform modifiers need vertex
196          * coordinates.
197          *
198          * Note that this limits the number of custom data layer types to 32.
199          *
200          * If this function is not present or it returns 0, it is assumed that
201          * no extra data is needed.
202          *
203          * This function is optional.
204          */
205         CustomDataMask (*requiredDataMask)(struct ModifierData *md);
206
207         /* Free internal modifier data variables, this function should
208          * not free the md variable itself.
209          *
210          * This function is optional.
211          */
212         void (*freeData)(struct ModifierData *md);
213
214         /* Return a boolean value indicating if this modifier is able to be
215          * calculated based on the modifier data. This is *not* regarding the
216          * md->flag, that is tested by the system, this is just if the data
217          * validates (for example, a lattice will return false if the lattice
218          * object is not defined).
219          *
220          * This function is optional (assumes never disabled if not present).
221          */
222         int (*isDisabled)(struct ModifierData *md);
223
224         /* Add the appropriate relations to the DEP graph depending on the
225          * modifier data. 
226          *
227          * This function is optional.
228          */
229         void (*updateDepgraph)(struct ModifierData *md, struct DagForest *forest,
230                                struct Object *ob, struct DagNode *obNode);
231
232         /* Should return true if the modifier needs to be recalculated on time
233          * changes.
234          *
235          * This function is optional (assumes false if not present).
236          */
237         int (*dependsOnTime)(struct ModifierData *md);
238
239         /* Should call the given walk function on with a pointer to each Object
240          * pointer that the modifier data stores. This is used for linking on file
241          * load and for unlinking objects or forwarding object references.
242          *
243          * This function is optional.
244          */
245         void (*foreachObjectLink)(struct ModifierData *md, struct Object *ob,
246                                   ObjectWalkFunc walk, void *userData);
247
248         /* Should call the given walk function with a pointer to each ID
249          * pointer (i.e. each datablock pointer) that the modifier data
250          * stores. This is used for linking on file load and for
251          * unlinking datablocks or forwarding datablock references.
252          *
253          * This function is optional. If it is not present, foreachObjectLink
254          * will be used.
255          */
256         void (*foreachIDLink)(struct ModifierData *md, struct Object *ob,
257                               IDWalkFunc walk, void *userData);
258 } ModifierTypeInfo;
259
260 ModifierTypeInfo *modifierType_getInfo (ModifierType type);
261
262 /* Modifier utility calls, do call through type pointer and return
263  * default values if pointer is optional.
264  */
265 struct ModifierData  *modifier_new(int type);
266 void          modifier_free(struct ModifierData *md);
267
268 void          modifier_copyData(struct ModifierData *md, struct ModifierData *target);
269 int           modifier_dependsOnTime(struct ModifierData *md);
270 int           modifier_supportsMapping(struct ModifierData *md);
271 int           modifier_couldBeCage(struct ModifierData *md);
272 int           modifier_isDeformer(struct ModifierData *md);
273 void          modifier_setError(struct ModifierData *md, char *format, ...);
274
275 void          modifiers_foreachObjectLink(struct Object *ob,
276                                           ObjectWalkFunc walk,
277                                           void *userData);
278 void          modifiers_foreachIDLink(struct Object *ob,
279                                       IDWalkFunc walk,
280                                       void *userData);
281 struct ModifierData  *modifiers_findByType(struct Object *ob, ModifierType type);
282 void          modifiers_clearErrors(struct Object *ob);
283 int           modifiers_getCageIndex(struct Object *ob,
284                                      int *lastPossibleCageIndex_r);
285
286 int           modifiers_isSoftbodyEnabled(struct Object *ob);
287 int           modifiers_isClothEnabled(struct Object *ob);
288 int           modifiers_isParticleEnabled(struct Object *ob);
289
290 struct Object *modifiers_isDeformedByArmature(struct Object *ob);
291 struct Object *modifiers_isDeformedByLattice(struct Object *ob);
292 int           modifiers_usesArmature(struct Object *ob, struct bArmature *arm);
293 int           modifiers_isDeformed(struct Object *ob);
294 void          modifier_freeTemporaryData(struct ModifierData *md);
295
296 int           modifiers_indexInObject(struct Object *ob, struct ModifierData *md);
297
298 /* Calculates and returns a linked list of CustomDataMasks indicating the
299  * data required by each modifier in the stack pointed to by md for correct
300  * evaluation, assuming the data indicated by dataMask is required at the
301  * end of the stack.
302  */
303 struct LinkNode *modifiers_calcDataMasks(struct ModifierData *md,
304                                          CustomDataMask dataMask);
305 struct ModifierData  *modifiers_getVirtualModifierList(struct Object *ob);
306
307 #endif
308