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