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