Splash: Increase contrast of build info text
[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         /* Time-Source */
92         DEG_NODE_TYPE_TIMESOURCE,
93         /* ID-Block reference - used as landmarks/collection point for components,
94          * but not usually part of main graph.
95          */
96         DEG_NODE_TYPE_ID_REF,
97
98         /* **** Outer Types **** */
99
100         /* Parameters Component - Default when nothing else fits
101          * (i.e. just SDNA property setting).
102          */
103         DEG_NODE_TYPE_PARAMETERS,
104         /* Generic "Proxy-Inherit" Component. */
105         DEG_NODE_TYPE_PROXY,
106         /* Animation Component */
107         DEG_NODE_TYPE_ANIMATION,
108         /* Transform Component (Parenting/Constraints) */
109         DEG_NODE_TYPE_TRANSFORM,
110         /* Geometry Component (DerivedMesh/Displist) */
111         DEG_NODE_TYPE_GEOMETRY,
112         /* Sequencer Component (Scene Only) */
113         DEG_NODE_TYPE_SEQUENCER,
114         /* Component which contains all operations needed for layer collections
115          * evaluation.
116          */
117         DEG_NODE_TYPE_LAYER_COLLECTIONS,
118         /* Entry component of majority of ID nodes: prepares CoW pointers for
119          * execution.
120          */
121         DEG_NODE_TYPE_COPY_ON_WRITE,
122
123         /* **** Evaluation-Related Outer Types (with Subdata) **** */
124
125         /* Pose Component - Owner/Container of Bones Eval */
126         DEG_NODE_TYPE_EVAL_POSE,
127         /* Bone Component - Child/Subcomponent of Pose */
128         DEG_NODE_TYPE_BONE,
129         /* Particle Systems Component */
130         DEG_NODE_TYPE_EVAL_PARTICLES,
131         /* Material Shading Component */
132         DEG_NODE_TYPE_SHADING,
133         DEG_NODE_TYPE_SHADING_PARAMETERS,
134         /* Cache Component */
135         DEG_NODE_TYPE_CACHE,
136 } eDepsNode_Type;
137
138 /* Identifiers for common operations (as an enum). */
139 typedef enum eDepsOperation_Code {
140         /* Generic Operations. ------------------------------ */
141
142         /* Placeholder for operations which don't need special mention */
143         DEG_OPCODE_OPERATION = 0,
144
145         /* Generic parameters evaluation. */
146         DEG_OPCODE_PARAMETERS_EVAL,
147
148         // XXX: Placeholder while porting depsgraph code
149         DEG_OPCODE_PLACEHOLDER,
150
151         /* Animation, Drivers, etc. ------------------------ */
152         /* NLA + Action */
153         DEG_OPCODE_ANIMATION,
154         /* Driver */
155         DEG_OPCODE_DRIVER,
156
157         /* Transform. -------------------------------------- */
158         /* Transform entry point - local transforms only */
159         DEG_OPCODE_TRANSFORM_LOCAL,
160         /* Parenting */
161         DEG_OPCODE_TRANSFORM_PARENT,
162         /* Constraints */
163         DEG_OPCODE_TRANSFORM_CONSTRAINTS,
164         /* Transform exit point */
165         DEG_OPCODE_TRANSFORM_FINAL,
166         /* Handle object-level updates, mainly proxies hacks and recalc flags.  */
167         DEG_OPCODE_TRANSFORM_OBJECT_UBEREVAL,
168
169         /* Rigid body. -------------------------------------- */
170         /* Perform Simulation */
171         DEG_OPCODE_RIGIDBODY_REBUILD,
172         DEG_OPCODE_RIGIDBODY_SIM,
173         /* Copy results to object */
174         DEG_OPCODE_RIGIDBODY_TRANSFORM_COPY,
175
176         /* Geometry. ---------------------------------------- */
177         /* Evaluate the whole geometry, including modifiers. */
178         DEG_OPCODE_GEOMETRY_UBEREVAL,
179
180         /* Pose. -------------------------------------------- */
181         /* Init IK Trees, etc. */
182         DEG_OPCODE_POSE_INIT,
183         /* Free IK Trees + Compute Deform Matrices */
184         DEG_OPCODE_POSE_DONE,
185         /* IK/Spline Solvers */
186         DEG_OPCODE_POSE_IK_SOLVER,
187         DEG_OPCODE_POSE_SPLINE_IK_SOLVER,
188
189         /* Bone. -------------------------------------------- */
190         /* Bone local transforms - entry point */
191         DEG_OPCODE_BONE_LOCAL,
192         /* Pose-space conversion (includes parent + restpose, */
193         DEG_OPCODE_BONE_POSE_PARENT,
194         /* Constraints */
195         DEG_OPCODE_BONE_CONSTRAINTS,
196         /* Bone transforms are ready
197          *
198          * - "READY"  This (internal, noop is used to signal that all pre-IK
199          *            operations are done. Its role is to help mediate situations
200          *            where cyclic relations may otherwise form (i.e. one bone in
201          *            chain targetting another in same chain,
202          *
203          * - "DONE"   This noop is used to signal that the bone's final pose
204          *            transform can be read by others
205          */
206         // TODO: deform mats could get calculated in the final_transform ops...
207         DEG_OPCODE_BONE_READY,
208         DEG_OPCODE_BONE_DONE,
209
210         /* Particles. --------------------------------------- */
211         /* Particle System evaluation. */
212         DEG_OPCODE_PARTICLE_SYSTEM_EVAL_INIT,
213         DEG_OPCODE_PARTICLE_SYSTEM_EVAL,
214         DEG_OPCODE_PARTICLE_SETTINGS_EVAL,
215         DEG_OPCODE_PARTICLE_SETTINGS_RECALC_CLEAR,
216
217         /* Collections. ------------------------------------- */
218         DEG_OPCODE_SCENE_LAYER_INIT,
219         DEG_OPCODE_SCENE_LAYER_EVAL,
220         DEG_OPCODE_SCENE_LAYER_DONE,
221
222         /* Copy on Write. ------------------------------------ */
223         DEG_OPCODE_COPY_ON_WRITE,
224
225         /* Shading. ------------------------------------------- */
226         DEG_OPCODE_SHADING,
227         DEG_OPCODE_MATERIAL_UPDATE,
228         DEG_OPCODE_WORLD_UPDATE,
229
230         /* Masks ------------------------------------------- */
231         DEG_OPCODE_MASK_ANIMATION,
232         DEG_OPCODE_MASK_EVAL,
233
234         DEG_NUM_OPCODES,
235 } eDepsOperation_Code;
236
237 /* Some magic to stringify operation codes. */
238 class DepsOperationStringifier {
239 public:
240         DepsOperationStringifier();
241         const char *operator[](eDepsOperation_Code opcodex);
242 protected:
243         const char *names_[DEG_NUM_OPCODES];
244 };
245
246 /* String defines for these opcodes, defined in depsgraph_type_defines.cpp */
247 extern DepsOperationStringifier DEG_OPNAMES;
248
249 }  // namespace DEG