- added ModifierData flag, is modifier enabled in editmode
[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
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.
68                  */
69         eModifierTypeFlag_EnableInEditmode = (1<<4),
70 } ModifierTypeFlag;
71
72 typedef struct ModifierTypeInfo {
73                 /* The user visible name for this modifier */
74         char name[32];
75
76                 /* The DNA struct name for the modifier data type, used to
77                  * write the DNA data out.
78                  */
79         char structName[32];
80
81                 /* The size of the modifier data type, used by allocation. */
82         int structSize;
83
84         ModifierTypeType type;
85         ModifierTypeFlag flags;
86
87                 /* Initialize new instance data for this modifier type, this function
88                  * should set modifier variables to their default values.
89                  * 
90                  * This function is optional.
91                  */
92         void (*initData)(struct ModifierData *md);
93
94                 /* Free internal modifier data variables, this function should
95                  * not free the _md_ variable itself.
96                  *
97                  * This function is optional.
98                  */
99         void (*freeData)(struct ModifierData *md);
100
101                 /* Return a boolean value indicating if this modifier is able to be calculated
102                  * based on the modifier data. This is *not* regarding the md->flag, that is
103                  * tested by the system, this is just if the data validates (for example, a
104                  * lattice will return false if the lattice object is not defined).
105                  *
106                  * This function is optional (assumes never disabled if not present).
107                  */
108         int (*isDisabled)(struct ModifierData *md);
109
110                 /* Add the appropriate relations to the DEP graph depending on the modifier
111                  * data. 
112                  *
113                  * This function is optional.
114                  */
115         void (*updateDepgraph)(struct ModifierData *md, struct DagForest *forest, struct Object *ob, struct DagNode *obNode);
116
117                 /* Should return true if the modifier needs to be recalculated on time changes.
118                  *
119                  * This function is optional (assumes false if not present).
120                  */
121         int (*dependsOnTime)(struct ModifierData *md);
122
123                 /* Only for deform types, should apply the deformation
124                  * to the given vertex array. If the deformer requires information from
125                  * the object it can obtain it from the _derivedData_ argument if non-NULL,
126                  * and otherwise the _ob_ argument.
127                  */
128         void (*deformVerts)(struct ModifierData *md, struct Object *ob, void *derivedData, float (*vertexCos)[3], int numVerts);
129
130                 /* Like deformVerts but called during editmode (for supporting modifiers) */
131         void (*deformVertsEM)(struct ModifierData *md, struct Object *ob, void *editData, void *derivedData, float (*vertexCos)[3], int numVerts);
132
133                 /* For non-deform types: apply the modifier and return a new derived
134                  * data object (type is dependent on object type). If the _derivedData_
135                  * argument is non-NULL then the modifier should read the object data 
136                  * from the derived object instead of the actual object data. 
137                  *
138                  * If the _vertexCos_ argument is non-NULL then the modifier should read 
139                  * the vertex coordinates from that (even if _derivedData_ is non-NULL).
140                  * The length of the _vertexCos_ array is either the number of verts in
141                  * the derived object (if non-NULL) or otherwise the number of verts in
142                  * the original object.
143                  *
144                  * The _useRenderParams_ indicates if the modifier is being applied in
145                  * the service of the renderer which may alter quality settings.
146                  *
147                  * The _isFinalCalc_ parameter indicates if the modifier is being calculated
148                  * for a final result or for something temporary (like orcos). This is a hack
149                  * at the moment, it is meant so subsurf can know if it is safe to reuse its
150                  * internal cache.
151                  *
152                  * The modifier is expected to release (or reuse) the _derivedData_ argument
153                  * if non-NULL. The modifier *MAY NOT* share the _vertexCos_ argument.
154                  */
155         void *(*applyModifier)(struct ModifierData *md, struct Object *ob, void *derivedData, float (*vertexCos)[3], int useRenderParams, int isFinalCalc);
156
157                 /* Like applyModifier but called during editmode (for supporting modifiers).
158                  * 
159                  * The derived object that is returned must support the operations that are expected
160                  * from editmode objects. The same qualifications regarding _derivedData_ and _vertexCos_
161                  * apply as for applyModifier.
162                  */
163         void *(*applyModifierEM)(struct ModifierData *md, struct Object *ob, void *editData, void *derivedData, float (*vertexCos)[3]);
164 } ModifierTypeInfo;
165
166 ModifierTypeInfo *modifierType_get_info(ModifierType type);
167
168         /* Modifier utility calls, do call through type pointer and return
169          * default values if pointer is optional.
170          */
171 struct ModifierData*    modifier_new                    (int type);
172 void                                    modifier_free                   (struct ModifierData *md);
173
174 int                                             modifier_dependsOnTime  (struct ModifierData *md);
175
176 #endif
177