- added modifier_dependsOnTime to check if modifier needs updating
[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_RequiresObject = (1<<3),
62 } ModifierTypeFlag;
63
64 typedef struct ModifierTypeInfo {
65         char name[32], structName[32];
66         ModifierTypeType type;
67         ModifierTypeFlag flags;
68
69                 /* Create new instance data for this modifier type.
70                  * 
71                  * This function must be present.
72                  */
73         struct ModifierData *(*allocData)(void);
74
75                 /* Return a boolean value indicating if this modifier is able to be calculated
76                  * based on the modifier data. This is *not* regarding the md->flag, that is
77                  * tested by the system, this is just if the data validates (for example, a
78                  * lattice will return false if the lattice object is not defined).
79                  *
80                  * This function must be present.
81                  */
82         int (*isDisabled)(struct ModifierData *md);
83
84                 /* Add the appropriate relations to the DEP graph depending on the modifier
85                  * data. 
86                  *
87                  * This function is optional.
88                  */
89         void (*updateDepgraph)(struct ModifierData *md, struct DagForest *forest, struct Object *ob, struct DagNode *obNode);
90
91                 /* Should return true if the modifier needs to be recalculated on time changes.
92                  *
93                  * This function is optional (assumes false if not present).
94                  */
95         int (*dependsOnTime)(struct ModifierData *md);
96
97                 /* Only for deform types, should apply the deformation
98                  * to the given vertex array. Object is guaranteed to be
99                  * non-NULL.
100                  */
101         void (*deformVerts)(struct ModifierData *md, struct Object *ob, float (*vertexCos)[3], int numVerts);
102
103                 /* For non-deform types: apply the modifier and return a new derived
104                  * data object (type is dependent on object type). If the _derivedData_
105                  * argument is non-NULL then the modifier should read the object data 
106                  * from the derived object instead of the _data_ object. 
107                  *
108                  * If the _vertexCos_ argument is non-NULL then the modifier should read 
109                  * the vertex coordinates from that (even if _derivedData_ is non-NULL).
110                  * The length of the _vertexCos_ array is either the number of verts in
111                  * the derived object (if non-NULL) or otherwise the number of verts in
112                  * the original object.
113                  *
114                  * The _useRenderParams_ indicates if the modifier is being applied in
115                  * the service of the renderer which may alter quality settings.
116                  *
117                  * The modifier is expected to release (or reuse) the _derivedData_ argument
118                  * if non-NULL. The modifier *MAY NOT* share the _vertexCos_ argument.
119                  *
120                  * It is possible for _ob_ to be NULL if the modifier type is not flagged
121                  * to require an object. A NULL _ob_ occurs when original coordinate data
122                  * is requested for an object.
123                  */
124         void *(*applyModifier)(struct ModifierData *md, void *data, struct Object *ob, 
125                                                                                 void *derivedData, float (*vertexCos)[3], int useRenderParams);
126 } ModifierTypeInfo;
127
128 ModifierTypeInfo *modifierType_get_info(ModifierType type);
129
130 int modifier_dependsOnTime(struct ModifierData *md);
131
132 #endif
133