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 #include <algorithm>
47
48 struct bAction;
49 struct ChannelDriver;
50 struct ModifierData;
51 struct PointerRNA;
52 struct EvaluationContext;
53 struct FCurve;
54
55 namespace DEG {
56
57 /* TODO(sergey): Find a better place for this. */
58 using std::string;
59 using std::vector;
60 using std::max;
61
62 /* Evaluation Operation for atomic operation */
63 // XXX: move this to another header that can be exposed?
64 typedef function<void(struct EvaluationContext *)> DepsEvalOperationCb;
65
66 /* Metatype of Nodes - The general "level" in the graph structure
67  * the node serves.
68  */
69 typedef enum eDepsNode_Class {
70         /* Types generally unassociated with user-visible entities,
71          * but needed for graph functioning.
72          */
73         DEG_NODE_CLASS_GENERIC         = 0,
74         /* [Outer Node] An "aspect" of evaluating/updating an ID-Block, requiring
75          * certain types of evaluation behavior.
76          */
77         DEG_NODE_CLASS_COMPONENT       = 1,
78         /* [Inner Node] A glorified function-pointer/callback for scheduling up
79          * evaluation operations for components, subject to relationship
80          * requirements.
81          */
82         DEG_NODE_CLASS_OPERATION       = 2,
83 } eDepsNode_Class;
84
85 /* Note: We use max comparison to mark an id node that is linked more than once
86  * So keep this enum ordered accordingly.
87  */
88 typedef enum eDepsNode_LinkedState_Type {
89         /* Generic indirectly linked id node. */
90         DEG_ID_LINKED_INDIRECTLY       = 0,
91         /* Id node present in the set (background) only. */
92         DEG_ID_LINKED_VIA_SET          = 1,
93         /* Id node directly linked via the ScenLayer. */
94         DEG_ID_LINKED_DIRECTLY         = 2,
95 } eDepsNode_LinkedState_Type;
96
97 /* Types of Nodes */
98 typedef enum eDepsNode_Type {
99         /* Fallback type for invalid return value */
100         DEG_NODE_TYPE_UNDEFINED        = 0,
101         /* Inner Node (Operation) */
102         DEG_NODE_TYPE_OPERATION,
103
104         /* **** Generic Types **** */
105
106         /* Time-Source */
107         DEG_NODE_TYPE_TIMESOURCE,
108         /* ID-Block reference - used as landmarks/collection point for components,
109          * but not usually part of main graph.
110          */
111         DEG_NODE_TYPE_ID_REF,
112
113         /* **** Outer Types **** */
114
115         /* Parameters Component - Default when nothing else fits
116          * (i.e. just SDNA property setting).
117          */
118         DEG_NODE_TYPE_PARAMETERS,
119         /* Generic "Proxy-Inherit" Component. */
120         DEG_NODE_TYPE_PROXY,
121         /* Animation Component */
122         DEG_NODE_TYPE_ANIMATION,
123         /* Transform Component (Parenting/Constraints) */
124         DEG_NODE_TYPE_TRANSFORM,
125         /* Geometry Component (DerivedMesh/Displist) */
126         DEG_NODE_TYPE_GEOMETRY,
127         /* Sequencer Component (Scene Only) */
128         DEG_NODE_TYPE_SEQUENCER,
129         /* Component which contains all operations needed for layer collections
130          * evaluation.
131          */
132         DEG_NODE_TYPE_LAYER_COLLECTIONS,
133         /* Entry component of majority of ID nodes: prepares CoW pointers for
134          * execution.
135          */
136         DEG_NODE_TYPE_COPY_ON_WRITE,
137
138         /* **** Evaluation-Related Outer Types (with Subdata) **** */
139
140         /* Pose Component - Owner/Container of Bones Eval */
141         DEG_NODE_TYPE_EVAL_POSE,
142         /* Bone Component - Child/Subcomponent of Pose */
143         DEG_NODE_TYPE_BONE,
144         /* Particle Systems Component */
145         DEG_NODE_TYPE_EVAL_PARTICLES,
146         /* Material Shading Component */
147         DEG_NODE_TYPE_SHADING,
148         DEG_NODE_TYPE_SHADING_PARAMETERS,
149         /* Cache Component */
150         DEG_NODE_TYPE_CACHE,
151         /* Batch Cache Component */
152         DEG_NODE_TYPE_BATCH_CACHE,
153
154         /* Total number of meaningful node types. */
155         NUM_DEG_NODE_TYPES,
156 } eDepsNode_Type;
157
158 /* Identifiers for common operations (as an enum). */
159 typedef enum eDepsOperation_Code {
160         /* Generic Operations. ------------------------------ */
161
162         /* Placeholder for operations which don't need special mention */
163         DEG_OPCODE_OPERATION = 0,
164
165         /* Generic parameters evaluation. */
166         DEG_OPCODE_ID_PROPERTY,
167         DEG_OPCODE_PARAMETERS_EVAL,
168
169         // XXX: Placeholder while porting depsgraph code
170         DEG_OPCODE_PLACEHOLDER,
171
172         /* Animation, Drivers, etc. ------------------------ */
173         /* NLA + Action */
174         DEG_OPCODE_ANIMATION,
175         /* Driver */
176         DEG_OPCODE_DRIVER,
177
178         /* Object related. --------------------------------- */
179         DEG_OPCODE_OBJECT_BASE_FLAGS,
180
181         /* Transform. -------------------------------------- */
182         /* Transform entry point - local transforms only */
183         DEG_OPCODE_TRANSFORM_LOCAL,
184         /* Parenting */
185         DEG_OPCODE_TRANSFORM_PARENT,
186         /* Constraints */
187         DEG_OPCODE_TRANSFORM_CONSTRAINTS,
188         /* Transform exit point */
189         DEG_OPCODE_TRANSFORM_FINAL,
190         /* Handle object-level updates, mainly proxies hacks and recalc flags.  */
191         DEG_OPCODE_TRANSFORM_OBJECT_UBEREVAL,
192
193         /* Rigid body. -------------------------------------- */
194         /* Perform Simulation */
195         DEG_OPCODE_RIGIDBODY_REBUILD,
196         DEG_OPCODE_RIGIDBODY_SIM,
197         /* Copy results to object */
198         DEG_OPCODE_RIGIDBODY_TRANSFORM_COPY,
199
200         /* Geometry. ---------------------------------------- */
201         /* Evaluate the whole geometry, including modifiers. */
202         DEG_OPCODE_GEOMETRY_UBEREVAL,
203         DEG_OPCODE_GEOMETRY_CLOTH_MODIFIER,
204         DEG_OPCODE_GEOMETRY_SHAPEKEY,
205
206         /* Pose. -------------------------------------------- */
207         /* Init pose, clear flags, etc. */
208         DEG_OPCODE_POSE_INIT,
209         /* Initialize IK solver related pose stuff. */
210         DEG_OPCODE_POSE_INIT_IK,
211         /* Free IK Trees + Compute Deform Matrices */
212         DEG_OPCODE_POSE_DONE,
213         /* IK/Spline Solvers */
214         DEG_OPCODE_POSE_IK_SOLVER,
215         DEG_OPCODE_POSE_SPLINE_IK_SOLVER,
216
217         /* Bone. -------------------------------------------- */
218         /* Bone local transforms - entry point */
219         DEG_OPCODE_BONE_LOCAL,
220         /* Pose-space conversion (includes parent + restpose, */
221         DEG_OPCODE_BONE_POSE_PARENT,
222         /* Constraints */
223         DEG_OPCODE_BONE_CONSTRAINTS,
224         /* Bone transforms are ready
225          *
226          * - "READY"  This (internal, noop is used to signal that all pre-IK
227          *            operations are done. Its role is to help mediate situations
228          *            where cyclic relations may otherwise form (i.e. one bone in
229          *            chain targetting another in same chain,
230          *
231          * - "DONE"   This noop is used to signal that the bone's final pose
232          *            transform can be read by others
233          */
234         // TODO: deform mats could get calculated in the final_transform ops...
235         DEG_OPCODE_BONE_READY,
236         DEG_OPCODE_BONE_DONE,
237
238         /* Particles. --------------------------------------- */
239         /* Particle System evaluation. */
240         DEG_OPCODE_PARTICLE_SYSTEM_EVAL_INIT,
241         DEG_OPCODE_PARTICLE_SYSTEM_EVAL,
242         DEG_OPCODE_PARTICLE_SETTINGS_EVAL,
243         DEG_OPCODE_PARTICLE_SETTINGS_RECALC_CLEAR,
244
245         /* Point Cache. ------------------------------------- */
246         DEG_OPCODE_POINT_CACHE_RESET,
247
248         /* Collections. ------------------------------------- */
249         DEG_OPCODE_VIEW_LAYER_INIT,
250         DEG_OPCODE_VIEW_LAYER_EVAL,
251         DEG_OPCODE_VIEW_LAYER_DONE,
252
253         /* Copy on Write. ------------------------------------ */
254         DEG_OPCODE_COPY_ON_WRITE,
255
256         /* Shading. ------------------------------------------- */
257         DEG_OPCODE_SHADING,
258         DEG_OPCODE_MATERIAL_UPDATE,
259         DEG_OPCODE_WORLD_UPDATE,
260
261         /* Batch caches. -------------------------------------- */
262         DEG_OPCODE_GEOMETRY_SELECT_UPDATE,
263
264         /* Masks. ------------------------------------------ */
265         DEG_OPCODE_MASK_ANIMATION,
266         DEG_OPCODE_MASK_EVAL,
267
268         /* Movie clips. ------------------------------------ */
269         DEG_OPCODE_MOVIECLIP_EVAL,
270
271         DEG_NUM_OPCODES,
272 } eDepsOperation_Code;
273
274 /* Some magic to stringify operation codes. */
275 class DepsOperationStringifier {
276 public:
277         DepsOperationStringifier();
278         const char *operator[](eDepsOperation_Code opcodex);
279 protected:
280         const char *names_[DEG_NUM_OPCODES];
281 };
282
283 /* String defines for these opcodes, defined in depsgraph_type_defines.cpp */
284 extern DepsOperationStringifier DEG_OPNAMES;
285
286 }  // namespace DEG