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