- shuffled editmesh derived function name/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 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 } ModifierTypeFlag;
62
63 typedef struct ModifierTypeInfo {
64                 /* The user visible name for this modifier */
65         char name[32];
66
67                 /* The DNA struct name for the modifier data type, used to
68                  * write the DNA data out.
69                  */
70         char structName[32];
71
72                 /* The size of the modifier data type, used by allocation. */
73         int structSize;
74
75         ModifierTypeType type;
76         ModifierTypeFlag flags;
77
78                 /* Initialize new instance data for this modifier type, this function
79                  * should set modifier variables to their default values.
80                  * 
81                  * This function is optional.
82                  */
83         void (*initData)(struct ModifierData *md);
84
85                 /* Free internal modifier data variables, this function should
86                  * not free the _md_ variable itself.
87                  *
88                  * This function is optional.
89                  */
90         void (*freeData)(struct ModifierData *md);
91
92                 /* Return a boolean value indicating if this modifier is able to be calculated
93                  * based on the modifier data. This is *not* regarding the md->flag, that is
94                  * tested by the system, this is just if the data validates (for example, a
95                  * lattice will return false if the lattice object is not defined).
96                  *
97                  * This function is optional (assumes never disabled if not present).
98                  */
99         int (*isDisabled)(struct ModifierData *md);
100
101                 /* Add the appropriate relations to the DEP graph depending on the modifier
102                  * data. 
103                  *
104                  * This function is optional.
105                  */
106         void (*updateDepgraph)(struct ModifierData *md, struct DagForest *forest, struct Object *ob, struct DagNode *obNode);
107
108                 /* Should return true if the modifier needs to be recalculated on time changes.
109                  *
110                  * This function is optional (assumes false if not present).
111                  */
112         int (*dependsOnTime)(struct ModifierData *md);
113
114                 /* Only for deform types, should apply the deformation
115                  * to the given vertex array. 
116                  */
117         void (*deformVerts)(struct ModifierData *md, struct Object *ob, float (*vertexCos)[3], int numVerts);
118
119                 /* For non-deform types: apply the modifier and return a new derived
120                  * data object (type is dependent on object type). If the _derivedData_
121                  * argument is non-NULL then the modifier should read the object data 
122                  * from the derived object instead of the actual object data. 
123                  *
124                  * If the _vertexCos_ argument is non-NULL then the modifier should read 
125                  * the vertex coordinates from that (even if _derivedData_ is non-NULL).
126                  * The length of the _vertexCos_ array is either the number of verts in
127                  * the derived object (if non-NULL) or otherwise the number of verts in
128                  * the original object.
129                  *
130                  * The _useRenderParams_ indicates if the modifier is being applied in
131                  * the service of the renderer which may alter quality settings.
132                  *
133                  * The modifier is expected to release (or reuse) the _derivedData_ argument
134                  * if non-NULL. The modifier *MAY NOT* share the _vertexCos_ argument.
135                  */
136         void *(*applyModifier)(struct ModifierData *md, struct Object *ob, void *derivedData, float (*vertexCos)[3], int useRenderParams);
137 } ModifierTypeInfo;
138
139 ModifierTypeInfo *modifierType_get_info(ModifierType type);
140
141         /* Modifier utility calls, do call through type pointer and return
142          * default values if pointer is optional.
143          */
144 struct ModifierData*    modifier_new                    (int type);
145 void                                    modifier_free                   (struct ModifierData *md);
146
147 int                                             modifier_dependsOnTime  (struct ModifierData *md);
148
149 #endif
150