Merge branch 'master' into blender2.8
[blender.git] / source / blender / depsgraph / intern / depsgraph_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2013 Blender Foundation.
19  * All rights reserved.
20  *
21  * Original Author: Joshua Leung
22  * Contributor(s): None Yet
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/depsgraph/intern/depsgraph_types.h
28  *  \ingroup depsgraph
29  *
30  * Datatypes for internal use in the Depsgraph
31  *
32  * All of these datatypes are only really used within the "core" depsgraph.
33  * In particular, node types declared here form the structure of operations
34  * in the graph.
35  */
36
37 #pragma once
38
39 #include "util/deg_util_function.h"
40
41 /* TODO(sergey): Ideally we'll just use char* and statically allocated strings
42  * to avoid any possible overhead caused by string (re)allocation/formatting.
43  */
44 #include <string>
45 #include <vector>
46
47 struct bAction;
48 struct ChannelDriver;
49 struct ModifierData;
50 struct PointerRNA;
51 struct EvaluationContext;
52 struct FCurve;
53
54 namespace DEG {
55
56 using std::string;
57 using std::vector;
58
59 /* Evaluation Operation for atomic operation */
60 // XXX: move this to another header that can be exposed?
61 typedef function<void(struct EvaluationContext *)> DepsEvalOperationCb;
62
63 /* Metatype of Nodes - The general "level" in the graph structure
64  * the node serves.
65  */
66 typedef enum eDepsNode_Class {
67         /* Types generally unassociated with user-visible entities,
68          * but needed for graph functioning.
69          */
70         DEG_NODE_CLASS_GENERIC         = 0,
71         /* [Outer Node] An "aspect" of evaluating/updating an ID-Block, requiring
72          * certain types of evaluation behavior.
73          */
74         DEG_NODE_CLASS_COMPONENT       = 1,
75         /* [Inner Node] A glorified function-pointer/callback for scheduling up
76          * evaluation operations for components, subject to relationship
77          * requirements.
78          */
79         DEG_NODE_CLASS_OPERATION       = 2,
80 } eDepsNode_Class;
81
82 /* Types of Nodes */
83 typedef enum eDepsNode_Type {
84         /* Fallback type for invalid return value */
85         DEG_NODE_TYPE_UNDEFINED        = -1,
86         /* Inner Node (Operation) */
87         DEG_NODE_TYPE_OPERATION        = 0,
88
89         /* **** Generic Types **** */
90
91         /* "Current Scene" - basically whatever kicks off the evaluation process. */
92         DEG_NODE_TYPE_ROOT,
93         /* Time-Source */
94         DEG_NODE_TYPE_TIMESOURCE,
95         /* ID-Block reference - used as landmarks/collection point for components,
96          * but not usually part of main graph.
97          */
98         DEG_NODE_TYPE_ID_REF,
99
100         /* **** Outer Types **** */
101
102         /* Parameters Component - Default when nothing else fits
103          * (i.e. just SDNA property setting).
104          */
105         DEG_NODE_TYPE_PARAMETERS,
106         /* Generic "Proxy-Inherit" Component. */
107         DEG_NODE_TYPE_PROXY,
108         /* Animation Component
109          *
110          * XXX: merge in with parameters?
111          */
112         DEG_NODE_TYPE_ANIMATION,
113         /* Transform Component (Parenting/Constraints) */
114         DEG_NODE_TYPE_TRANSFORM,
115         /* Geometry Component (DerivedMesh/Displist) */
116         DEG_NODE_TYPE_GEOMETRY,
117         /* Sequencer Component (Scene Only) */
118         DEG_NODE_TYPE_SEQUENCER,
119
120         /* **** Evaluation-Related Outer Types (with Subdata) **** */
121
122         /* Pose Component - Owner/Container of Bones Eval */
123         DEG_NODE_TYPE_EVAL_POSE,
124         /* Bone Component - Child/Subcomponent of Pose */
125         DEG_NODE_TYPE_BONE,
126         /* Particle Systems Component */
127         DEG_NODE_TYPE_EVAL_PARTICLES,
128         /* Material Shading Component */
129         DEG_NODE_TYPE_SHADING,
130         /* Cache Component */
131         DEG_NODE_TYPE_CACHE,
132         /* Component which contains all operations needed for layer collections evaluation. */
133         DEG_NODE_TYPE_LAYER_COLLECTIONS,
134 } eDepsNode_Type;
135
136 /* Identifiers for common operations (as an enum). */
137 typedef enum eDepsOperation_Code {
138         /* Generic Operations ------------------------------ */
139
140         /* Placeholder for operations which don't need special mention */
141         DEG_OPCODE_OPERATION = 0,
142
143         // XXX: Placeholder while porting depsgraph code
144         DEG_OPCODE_PLACEHOLDER,
145
146         /* Animation, Drivers, etc. ------------------------ */
147
148         /* NLA + Action */
149         DEG_OPCODE_ANIMATION,
150
151         /* Driver */
152         DEG_OPCODE_DRIVER,
153
154         /* Transform --------------------------------------- */
155
156         /* Transform entry point - local transforms only */
157         DEG_OPCODE_TRANSFORM_LOCAL,
158
159         /* Parenting */
160         DEG_OPCODE_TRANSFORM_PARENT,
161
162         /* Constraints */
163         DEG_OPCODE_TRANSFORM_CONSTRAINTS,
164
165         /* Rigidbody Sim - Perform Sim */
166         DEG_OPCODE_RIGIDBODY_REBUILD,
167         DEG_OPCODE_RIGIDBODY_SIM,
168
169         /* Rigidbody Sim - Copy Results to Object */
170         DEG_OPCODE_TRANSFORM_RIGIDBODY,
171
172         /* Transform exitpoint */
173         DEG_OPCODE_TRANSFORM_FINAL,
174
175         /* XXX: ubereval is for temporary porting purposes only */
176         DEG_OPCODE_OBJECT_UBEREVAL,
177
178         /* Geometry ---------------------------------------- */
179
180         /* XXX: Placeholder - UberEval */
181         DEG_OPCODE_GEOMETRY_UBEREVAL,
182
183         /* Curve Objects - Path Calculation (used for path-following tools, */
184         DEG_OPCODE_GEOMETRY_PATH,
185
186         /* Pose -------------------------------------------- */
187
188         /* Init IK Trees, etc. */
189         DEG_OPCODE_POSE_INIT,
190
191         /* Free IK Trees + Compute Deform Matrices */
192         DEG_OPCODE_POSE_DONE,
193
194         /* IK/Spline Solvers */
195         DEG_OPCODE_POSE_IK_SOLVER,
196         DEG_OPCODE_POSE_SPLINE_IK_SOLVER,
197
198         /* Bone -------------------------------------------- */
199
200         /* Bone local transforms - Entrypoint */
201         DEG_OPCODE_BONE_LOCAL,
202
203         /* Pose-space conversion (includes parent + restpose, */
204         DEG_OPCODE_BONE_POSE_PARENT,
205
206         /* Constraints */
207         DEG_OPCODE_BONE_CONSTRAINTS,
208
209         /* Bone transforms are ready
210          *
211          * - "READY"  This (internal, noop is used to signal that all pre-IK
212          *            operations are done. Its role is to help mediate situations
213          *            where cyclic relations may otherwise form (i.e. one bone in
214          *            chain targetting another in same chain,
215          *
216          * - "DONE"   This noop is used to signal that the bone's final pose
217          *            transform can be read by others
218          */
219         // TODO: deform mats could get calculated in the final_transform ops...
220         DEG_OPCODE_BONE_READY,
221         DEG_OPCODE_BONE_DONE,
222
223         /* Particles --------------------------------------- */
224
225         /* XXX: placeholder - Particle System eval */
226         DEG_OPCODE_PSYS_EVAL,
227
228         /* Collections ------------------------------------- */
229         DEG_OPCODE_SCENE_LAYER_INIT,
230         DEG_OPCODE_SCENE_LAYER_EVAL,
231         DEG_OPCODE_SCENE_LAYER_DONE,
232
233         DEG_NUM_OPCODES,
234 } eDepsOperation_Code;
235
236 /* Some magic to stringify operation codes. */
237 class DepsOperationStringifier {
238 public:
239         DepsOperationStringifier();
240         const char *operator[](eDepsOperation_Code opcodex);
241 protected:
242         const char *names_[DEG_NUM_OPCODES];
243 };
244
245 /* String defines for these opcodes, defined in depsgraph_type_defines.cpp */
246 extern DepsOperationStringifier DEG_OPNAMES;
247
248 }  // namespace DEG