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