- added modifiers_isDeformedByArmature function
[blender.git] / source / blender / blenkernel / BKE_modifier.h
1 /**
2  *      
3  * $Id$ 
4  *
5  * ***** BEGIN GPL/BL DUAL 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. The Blender
11  * Foundation also sells licenses for use in proprietary software under
12  * the Blender License.  See http://www.blender.org/BL/ for information
13  * about this.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL/BL DUAL LICENSE BLOCK *****
32  */
33 #ifndef BKE_MODIFIER_H
34 #define BKE_MODIFIER_H
35
36 struct DerivedMesh;
37 struct DagForest;
38 struct DagNode;
39 struct Object;
40 struct ListBase;
41
42 typedef enum {
43                 /* Should not be used, only for None modifier type */
44         eModifierTypeType_None,
45
46                 /* Modifier only does deformation, implies that modifier
47                  * type should have a valid deformVerts function. OnlyDeform
48                  * style modifiers implicitly accept either mesh or CV
49                  * input but should still declare flags appropriately.
50                  */
51         eModifierTypeType_OnlyDeform,
52
53         eModifierTypeType_Constructive,
54         eModifierTypeType_Nonconstructive,
55 } ModifierTypeType;
56
57 typedef enum {
58         eModifierTypeFlag_AcceptsMesh = (1<<0),
59         eModifierTypeFlag_AcceptsCVs = (1<<1),
60         eModifierTypeFlag_SupportsMapping = (1<<2),
61         eModifierTypeFlag_SupportsEditmode = (1<<3),
62         
63                 /* For modifiers that support editmode this determines if the
64                  * modifier should be enabled by default in editmode. This should
65                  * only be used by modifiers that are relatively speedy and
66                  * also generally used in editmode, otherwise let the user enable
67                  * it by hand.
68                  */
69         eModifierTypeFlag_EnableInEditmode = (1<<4),
70
71                 /* For modifiers that require original data and so cannot
72                  * be placed after any non-deformative modifier.
73                  */
74         eModifierTypeFlag_RequiresOriginalData = (1<<5),
75 } ModifierTypeFlag;
76
77 typedef struct ModifierTypeInfo {
78                 /* The user visible name for this modifier */
79         char name[32];
80
81                 /* The DNA struct name for the modifier data type, used to
82                  * write the DNA data out.
83                  */
84         char structName[32];
85
86                 /* The size of the modifier data type, used by allocation. */
87         int structSize;
88
89         ModifierTypeType type;
90         ModifierTypeFlag flags;
91
92                 /* Initialize new instance data for this modifier type, this function
93                  * should set modifier variables to their default values.
94                  * 
95                  * This function is optional.
96                  */
97         void (*initData)(ModifierData *md);
98
99                 /* Copy instance data for this modifier type. Should copy all user
100                  * level settings to the target modifier.
101                  */
102         void (*copyData)(ModifierData *md, ModifierData *target);
103
104                 /* Free internal modifier data variables, this function should
105                  * not free the _md_ variable itself.
106                  *
107                  * This function is optional.
108                  */
109         void (*freeData)(ModifierData *md);
110
111                 /* Return a boolean value indicating if this modifier is able to be calculated
112                  * based on the modifier data. This is *not* regarding the md->flag, that is
113                  * tested by the system, this is just if the data validates (for example, a
114                  * lattice will return false if the lattice object is not defined).
115                  *
116                  * This function is optional (assumes never disabled if not present).
117                  */
118         int (*isDisabled)(ModifierData *md);
119
120                 /* Add the appropriate relations to the DEP graph depending on the modifier
121                  * data. 
122                  *
123                  * This function is optional.
124                  */
125         void (*updateDepgraph)(ModifierData *md, struct DagForest *forest, struct Object *ob, struct DagNode *obNode);
126
127                 /* Should return true if the modifier needs to be recalculated on time changes.
128                  *
129                  * This function is optional (assumes false if not present).
130                  */
131         int (*dependsOnTime)(ModifierData *md);
132
133                 /* Should call the given _walk_ function on with a pointer to each Object pointer
134                  * that the modifier data stores. This is used for linking on file load and for
135                  * unlinking objects or forwarding object references.
136                  *
137                  * This function is optional.
138                  */
139         void (*foreachObjectLink)(ModifierData *md, struct Object *ob, void (*walk)(void *userData, Object *ob, Object **obpoin), void *userData);
140
141                 /* Only for deform types, should apply the deformation
142                  * to the given vertex array. If the deformer requires information from
143                  * the object it can obtain it from the _derivedData_ argument if non-NULL,
144                  * and otherwise the _ob_ argument.
145                  */
146         void (*deformVerts)(ModifierData *md, struct Object *ob, void *derivedData, float (*vertexCos)[3], int numVerts);
147
148                 /* Like deformVerts but called during editmode (for supporting modifiers) */
149         void (*deformVertsEM)(ModifierData *md, struct Object *ob, void *editData, void *derivedData, float (*vertexCos)[3], int numVerts);
150
151                 /* For non-deform types: apply the modifier and return a new derived
152                  * data object (type is dependent on object type). If the _derivedData_
153                  * argument is non-NULL then the modifier should read the object data 
154                  * from the derived object instead of the actual object data. 
155                  *
156                  * If the _vertexCos_ argument is non-NULL then the modifier should read 
157                  * the vertex coordinates from that (even if _derivedData_ is non-NULL).
158                  * The length of the _vertexCos_ array is either the number of verts in
159                  * the derived object (if non-NULL) or otherwise the number of verts in
160                  * the original object.
161                  *
162                  * The _useRenderParams_ indicates if the modifier is being applied in
163                  * the service of the renderer which may alter quality settings.
164                  *
165                  * The _isFinalCalc_ parameter indicates if the modifier is being calculated
166                  * for a final result or for something temporary (like orcos). This is a hack
167                  * at the moment, it is meant so subsurf can know if it is safe to reuse its
168                  * internal cache.
169                  *
170                  * The modifier *MAY NOT* reuse or release the _derivedData_ argument
171                  * if non-NULL. The modifier *MAY NOT* share the _vertexCos_ argument.
172                  */
173         void *(*applyModifier)(ModifierData *md, struct Object *ob, void *derivedData, float (*vertexCos)[3], int useRenderParams, int isFinalCalc);
174
175                 /* Like applyModifier but called during editmode (for supporting modifiers).
176                  * 
177                  * The derived object that is returned must support the operations that are expected
178                  * from editmode objects. The same qualifications regarding _derivedData_ and _vertexCos_
179                  * apply as for applyModifier.
180                  */
181         void *(*applyModifierEM)(ModifierData *md, struct Object *ob, void *editData, void *derivedData, float (*vertexCos)[3]);
182 } ModifierTypeInfo;
183
184 ModifierTypeInfo*               modifierType_getInfo    (ModifierType type);
185
186         /* Modifier utility calls, do call through type pointer and return
187          * default values if pointer is optional.
188          */
189 ModifierData*   modifier_new                            (int type);
190 void                    modifier_free                           (ModifierData *md);
191
192 void                    modifier_copyData                       (ModifierData *md, ModifierData *target);
193 int                             modifier_dependsOnTime          (ModifierData *md);
194 int                             modifier_supportsMapping        (ModifierData *md);
195 int                             modifier_couldBeCage            (ModifierData *md);
196 void                    modifier_setError                       (ModifierData *md, char *format, ...);
197
198 void                    modifiers_foreachObjectLink     (struct Object *ob, void (*walk)(void *userData, struct Object *ob, struct Object **obpoin), void *userData);
199 ModifierData*   modifiers_findByType            (struct Object *ob, ModifierType type);
200 void                    modifiers_clearErrors           (struct Object *ob);
201 int                             modifiers_getCageIndex          (struct Object *ob, int *lastPossibleCageIndex_r);
202
203 int                             modifiers_isSoftbodyEnabled     (struct Object *ob);
204 int                             modifiers_isDeformedByArmature(struct Object *ob, struct Object *armOb);
205
206 ModifierData*   modifiers_getVirtualModifierList        (struct Object *ob);
207
208 #endif
209