574f7b313b4dd82d762514329c5ed5a7d1236800
[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
41 typedef enum {
42                 /* Should not be used, only for None modifier type */
43         eModifierTypeType_None,
44
45                 /* Modifier only does deformation, implies that modifier
46                  * type should have a valid deformVerts function. OnlyDeform
47                  * style modifiers implicitly accept either mesh or CV
48                  * input but should still declare flags appropriately.
49                  */
50         eModifierTypeType_OnlyDeform,
51
52         eModifierTypeType_Constructive,
53         eModifierTypeType_Nonconstructive,
54 } ModifierTypeType;
55
56 typedef enum {
57         eModifierTypeFlag_AcceptsMesh = (1<<0),
58         eModifierTypeFlag_AcceptsCVs = (1<<1),
59         eModifierTypeFlag_SupportsMapping = (1<<2),
60         eModifierTypeFlag_SupportsEditmode = (1<<3),
61         
62                 /* For modifiers that support editmode this determines if the
63                  * modifier should be enabled by default in editmode. This should
64                  * only be used by modifiers that are relatively speedy and
65                  * also generally used in editmode, otherwise let the user enable
66                  * it by hand.
67                  */
68         eModifierTypeFlag_EnableInEditmode = (1<<4),
69
70                 /* For modifiers that require original data and so cannot
71                  * be placed after any non-deformative modifier.
72                  */
73         eModifierTypeFlag_RequiresOriginalData = (1<<5),
74 } ModifierTypeFlag;
75
76 typedef struct ModifierTypeInfo {
77                 /* The user visible name for this modifier */
78         char name[32];
79
80                 /* The DNA struct name for the modifier data type, used to
81                  * write the DNA data out.
82                  */
83         char structName[32];
84
85                 /* The size of the modifier data type, used by allocation. */
86         int structSize;
87
88         ModifierTypeType type;
89         ModifierTypeFlag flags;
90
91                 /* Initialize new instance data for this modifier type, this function
92                  * should set modifier variables to their default values.
93                  * 
94                  * This function is optional.
95                  */
96         void (*initData)(ModifierData *md);
97
98                 /* Copy instance data for this modifier type. Should copy all user
99                  * level settings to the target modifier.
100                  */
101         void (*copyData)(ModifierData *md, ModifierData *target);
102
103                 /* Free internal modifier data variables, this function should
104                  * not free the _md_ variable itself.
105                  *
106                  * This function is optional.
107                  */
108         void (*freeData)(ModifierData *md);
109
110                 /* Return a boolean value indicating if this modifier is able to be calculated
111                  * based on the modifier data. This is *not* regarding the md->flag, that is
112                  * tested by the system, this is just if the data validates (for example, a
113                  * lattice will return false if the lattice object is not defined).
114                  *
115                  * This function is optional (assumes never disabled if not present).
116                  */
117         int (*isDisabled)(ModifierData *md);
118
119                 /* Add the appropriate relations to the DEP graph depending on the modifier
120                  * data. 
121                  *
122                  * This function is optional.
123                  */
124         void (*updateDepgraph)(ModifierData *md, struct DagForest *forest, struct Object *ob, struct DagNode *obNode);
125
126                 /* Should return true if the modifier needs to be recalculated on time changes.
127                  *
128                  * This function is optional (assumes false if not present).
129                  */
130         int (*dependsOnTime)(ModifierData *md);
131
132                 /* Should call the given _walk_ function on with a pointer to each Object pointer
133                  * that the modifier data stores. This is used for linking on file load and for
134                  * unlinking objects or forwarding object references.
135                  *
136                  * This function is optional.
137                  */
138         void (*foreachObjectLink)(ModifierData *md, struct Object *ob, void (*walk)(void *userData, Object *ob, Object **obpoin), void *userData);
139
140                 /* Only for deform types, should apply the deformation
141                  * to the given vertex array. If the deformer requires information from
142                  * the object it can obtain it from the _derivedData_ argument if non-NULL,
143                  * and otherwise the _ob_ argument.
144                  */
145         void (*deformVerts)(ModifierData *md, struct Object *ob, void *derivedData, float (*vertexCos)[3], int numVerts);
146
147                 /* Like deformVerts but called during editmode (for supporting modifiers) */
148         void (*deformVertsEM)(ModifierData *md, struct Object *ob, void *editData, void *derivedData, float (*vertexCos)[3], int numVerts);
149
150                 /* For non-deform types: apply the modifier and return a new derived
151                  * data object (type is dependent on object type). If the _derivedData_
152                  * argument is non-NULL then the modifier should read the object data 
153                  * from the derived object instead of the actual object data. 
154                  *
155                  * If the _vertexCos_ argument is non-NULL then the modifier should read 
156                  * the vertex coordinates from that (even if _derivedData_ is non-NULL).
157                  * The length of the _vertexCos_ array is either the number of verts in
158                  * the derived object (if non-NULL) or otherwise the number of verts in
159                  * the original object.
160                  *
161                  * The _useRenderParams_ indicates if the modifier is being applied in
162                  * the service of the renderer which may alter quality settings.
163                  *
164                  * The _isFinalCalc_ parameter indicates if the modifier is being calculated
165                  * for a final result or for something temporary (like orcos). This is a hack
166                  * at the moment, it is meant so subsurf can know if it is safe to reuse its
167                  * internal cache.
168                  *
169                  * The modifier *MAY NOT* reuse or release the _derivedData_ argument
170                  * if non-NULL. The modifier *MAY NOT* share the _vertexCos_ argument.
171                  */
172         void *(*applyModifier)(ModifierData *md, struct Object *ob, void *derivedData, float (*vertexCos)[3], int useRenderParams, int isFinalCalc);
173
174                 /* Like applyModifier but called during editmode (for supporting modifiers).
175                  * 
176                  * The derived object that is returned must support the operations that are expected
177                  * from editmode objects. The same qualifications regarding _derivedData_ and _vertexCos_
178                  * apply as for applyModifier.
179                  */
180         void *(*applyModifierEM)(ModifierData *md, struct Object *ob, void *editData, void *derivedData, float (*vertexCos)[3]);
181 } ModifierTypeInfo;
182
183 ModifierTypeInfo*               modifierType_getInfo    (ModifierType type);
184
185         /* Modifier utility calls, do call through type pointer and return
186          * default values if pointer is optional.
187          */
188 ModifierData*   modifier_new                            (int type);
189 void                    modifier_free                           (ModifierData *md);
190
191 void                    modifier_copyData                       (ModifierData *md, ModifierData *target);
192 int                             modifier_dependsOnTime          (ModifierData *md);
193 int                             modifier_supportsMapping        (ModifierData *md);
194 int                             modifier_couldBeCage            (ModifierData *md);
195 void                    modifier_setError                       (ModifierData *md, char *format, ...);
196
197 void                    modifiers_foreachObjectLink     (struct Object *ob, void (*walk)(void *userData, struct Object *ob, struct Object **obpoin), void *userData);
198 ModifierData*   modifiers_findByType            (struct Object *ob, ModifierType type);
199 void                    modifiers_clearErrors           (struct Object *ob);
200 int                             modifiers_getCageIndex          (struct Object *ob, int *lastPossibleCageIndex_r);
201
202 int                             modifiers_isSoftbodyEnabled     (struct Object *ob);
203
204 #endif
205