Add C++ guards to some blenlib headers
[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 ChannelDriver;
49 struct Depsgraph;
50 struct FCurve;
51 struct ModifierData;
52 struct PointerRNA;
53 struct bAction;
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 ::Depsgraph *)> 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 (Mesh/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         /* Used by all operations which are updating object when something is
138          * changed in view layer.
139          */
140         DEG_NODE_TYPE_OBJECT_FROM_LAYER,
141         /* Un-interestying datablock, which is a part of dependency graph, but does
142          * not have very distinctive update procedure.  */
143         DEG_NODE_TYPE_GENERIC_DATABLOCK,
144
145         /* **** Evaluation-Related Outer Types (with Subdata) **** */
146
147         /* Pose Component - Owner/Container of Bones Eval */
148         DEG_NODE_TYPE_EVAL_POSE,
149         /* Bone Component - Child/Subcomponent of Pose */
150         DEG_NODE_TYPE_BONE,
151         /* Particle Systems Component */
152         DEG_NODE_TYPE_PARTICLE_SYSTEM,
153         DEG_NODE_TYPE_PARTICLE_SETTINGS,
154         /* Material Shading Component */
155         DEG_NODE_TYPE_SHADING,
156         DEG_NODE_TYPE_SHADING_PARAMETERS,
157         /* Point cache Component */
158         DEG_NODE_TYPE_POINT_CACHE,
159         /* Cache Component */
160         /* TODO(sergey); Verify that we really need this. */
161         DEG_NODE_TYPE_CACHE,
162         /* Batch Cache Component - TODO (dfelinto/sergey) rename to make it more generic. */
163         DEG_NODE_TYPE_BATCH_CACHE,
164         /* Duplication system. Used to force duplicated objects visible when
165          * when duplicator is visible.
166          */
167         DEG_NODE_TYPE_DUPLI,
168         /* Synchronization back to original datablock. */
169         DEG_NODE_TYPE_SYNCHRONIZE,
170
171         /* Total number of meaningful node types. */
172         NUM_DEG_NODE_TYPES,
173 } eDepsNode_Type;
174 const char *nodeTypeAsString(eDepsNode_Type type);
175
176 /* Identifiers for common operations (as an enum). */
177 typedef enum eDepsOperation_Code {
178         /* Generic Operations. -------------------------------------------------- */
179
180         /* Placeholder for operations which don't need special mention */
181         DEG_OPCODE_OPERATION = 0,
182
183         /* Generic parameters evaluation. */
184         DEG_OPCODE_ID_PROPERTY,
185         DEG_OPCODE_PARAMETERS_EVAL,
186
187         // XXX: Placeholder while porting depsgraph code
188         DEG_OPCODE_PLACEHOLDER,
189
190         /* Animation, Drivers, etc. --------------------------------------------- */
191         /* NLA + Action */
192         DEG_OPCODE_ANIMATION,
193         /* Driver */
194         DEG_OPCODE_DRIVER,
195
196         /* Object related. ------------------------------------------------------ */
197         DEG_OPCODE_OBJECT_BASE_FLAGS,
198
199         /* Transform. ----------------------------------------------------------- */
200         /* Transform entry point - local transforms only */
201         DEG_OPCODE_TRANSFORM_LOCAL,
202         /* Parenting */
203         DEG_OPCODE_TRANSFORM_PARENT,
204         /* Constraints */
205         DEG_OPCODE_TRANSFORM_CONSTRAINTS,
206         /* Transform exit point */
207         DEG_OPCODE_TRANSFORM_FINAL,
208         /* Handle object-level updates, mainly proxies hacks and recalc flags.  */
209         DEG_OPCODE_TRANSFORM_OBJECT_UBEREVAL,
210
211         /* Rigid body. ---------------------------------------------------------- */
212         /* Perform Simulation */
213         DEG_OPCODE_RIGIDBODY_REBUILD,
214         DEG_OPCODE_RIGIDBODY_SIM,
215         /* Copy results to object */
216         DEG_OPCODE_RIGIDBODY_TRANSFORM_COPY,
217
218         /* Geometry. ------------------------------------------------------------ */
219
220         /* Evaluate the whole geometry, including modifiers. */
221         DEG_OPCODE_GEOMETRY_UBEREVAL,
222         /* Evaluation of a shape key. */
223         DEG_OPCODE_GEOMETRY_SHAPEKEY,
224
225         /* Object data. --------------------------------------------------------- */
226         DEG_OPCODE_LIGHT_PROBE_EVAL,
227         DEG_OPCODE_SPEAKER_EVAL,
228
229         /* Pose. ---------------------------------------------------------------- */
230         /* Init pose, clear flags, etc. */
231         DEG_OPCODE_POSE_INIT,
232         /* Initialize IK solver related pose stuff. */
233         DEG_OPCODE_POSE_INIT_IK,
234         /* Pose is evaluated, and runtime data can be freed. */
235         DEG_OPCODE_POSE_CLEANUP,
236         /* Pose has been fully evaluated and ready to be used by others. */
237         DEG_OPCODE_POSE_DONE,
238         /* IK/Spline Solvers */
239         DEG_OPCODE_POSE_IK_SOLVER,
240         DEG_OPCODE_POSE_SPLINE_IK_SOLVER,
241
242         /* Bone. ---------------------------------------------------------------- */
243         /* Bone local transforms - entry point */
244         DEG_OPCODE_BONE_LOCAL,
245         /* Pose-space conversion (includes parent + restpose, */
246         DEG_OPCODE_BONE_POSE_PARENT,
247         /* Constraints */
248         DEG_OPCODE_BONE_CONSTRAINTS,
249         /* Bone transforms are ready
250          *
251          * - "READY"  This (internal, noop is used to signal that all pre-IK
252          *            operations are done. Its role is to help mediate situations
253          *            where cyclic relations may otherwise form (i.e. one bone in
254          *            chain targeting another in same chain,
255          *
256          * - "DONE"   This noop is used to signal that the bone's final pose
257          *            transform can be read by others
258          */
259         // TODO: deform mats could get calculated in the final_transform ops...
260         DEG_OPCODE_BONE_READY,
261         DEG_OPCODE_BONE_DONE,
262         /* B-Bone segment shape computation (after DONE) */
263         DEG_OPCODE_BONE_SEGMENTS,
264
265         /* Particle System. ----------------------------------------------------- */
266         DEG_OPCODE_PARTICLE_SYSTEM_INIT,
267         DEG_OPCODE_PARTICLE_SYSTEM_EVAL,
268         DEG_OPCODE_PARTICLE_SYSTEM_DONE,
269
270         /* Particle Settings. --------------------------------------------------- */
271         DEG_OPCODE_PARTICLE_SETTINGS_INIT,
272         DEG_OPCODE_PARTICLE_SETTINGS_EVAL,
273         DEG_OPCODE_PARTICLE_SETTINGS_RESET,
274
275         /* Point Cache. --------------------------------------------------------- */
276         DEG_OPCODE_POINT_CACHE_RESET,
277
278         /* Collections. --------------------------------------------------------- */
279         DEG_OPCODE_VIEW_LAYER_EVAL,
280
281         /* Copy on Write. ------------------------------------------------------- */
282         DEG_OPCODE_COPY_ON_WRITE,
283
284         /* Shading. ------------------------------------------------------------- */
285         DEG_OPCODE_SHADING,
286         DEG_OPCODE_MATERIAL_UPDATE,
287         DEG_OPCODE_WORLD_UPDATE,
288
289         /* Batch caches. -------------------------------------------------------- */
290         DEG_OPCODE_GEOMETRY_SELECT_UPDATE,
291
292         /* Masks. --------------------------------------------------------------- */
293         DEG_OPCODE_MASK_ANIMATION,
294         DEG_OPCODE_MASK_EVAL,
295
296         /* Movie clips. --------------------------------------------------------- */
297         DEG_OPCODE_MOVIECLIP_EVAL,
298         DEG_OPCODE_MOVIECLIP_SELECT_UPDATE,
299
300         /* Synchronization clips. ----------------------------------------------- */
301         DEG_OPCODE_SYNCHRONIZE_TO_ORIGINAL,
302
303         /* Generic datablock ---------------------------------------------------- */
304         DEG_OPCODE_GENERIC_DATABLOCK_UPDATE,
305
306         DEG_NUM_OPCODES,
307 } eDepsOperation_Code;
308 const char *operationCodeAsString(eDepsOperation_Code opcode);
309
310 /* Source of the dependency graph node update tag.
311  *
312  * NOTE: This is a bit mask, so accumulation of sources is possible.
313  */
314 typedef enum eUpdateSource {
315         /* Update is caused by a time change. */
316         DEG_UPDATE_SOURCE_TIME       = (1 << 0),
317         /* Update caused by user directly or indirectly influencing the node. */
318         DEG_UPDATE_SOURCE_USER_EDIT  = (1 << 1),
319         /* Update is happening as a special response for the relations update. */
320         DEG_UPDATE_SOURCE_RELATIONS  = (1 << 2),
321         /* Update is happening due to visibility change. */
322         DEG_UPDATE_SOURCE_VISIBILITY = (1 << 3),
323 } eUpdateSource;
324
325 }  // namespace DEG