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