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