1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2013 Blender Foundation. All rights reserved. */
/** \file
* \ingroup depsgraph
*/
#pragma once
#include "MEM_guardedalloc.h"
#include "intern/depsgraph_type.h"
#include "BLI_utildefines.h"
#include "DEG_depsgraph_build.h"
struct ID;
struct Scene;
namespace blender {
namespace deg {
struct Depsgraph;
struct OperationNode;
struct Relation;
/* Metatype of Nodes - The general "level" in the graph structure
* the node serves. */
enum class NodeClass {
/* Types generally unassociated with user-visible entities,
* but needed for graph functioning. */
GENERIC = 0,
/* [Outer Node] An "aspect" of evaluating/updating an ID-Block, requiring
* certain types of evaluation behavior. */
COMPONENT = 1,
/* [Inner Node] A glorified function-pointer/callback for scheduling up
* evaluation operations for components, subject to relationship
* requirements. */
OPERATION = 2,
};
const char *nodeClassAsString(NodeClass node_class);
/* Types of Nodes */
enum class NodeType {
/* Fallback type for invalid return value */
UNDEFINED = 0,
/* Inner Node (Operation) */
OPERATION,
/* **** Generic Types **** */
/* Time-Source */
TIMESOURCE,
/* ID-Block reference - used as landmarks/collection point for components,
* but not usually part of main graph. */
ID_REF,
/* **** Outer Types **** */
/* Parameters Component - Default when nothing else fits
* (i.e. just SDNA property setting). */
PARAMETERS,
/* Animation Component */
ANIMATION,
/* Transform Component (Parenting/Constraints) */
TRANSFORM,
/* Geometry Component (#Mesh / #DispList) */
GEOMETRY,
/* Sequencer Component (Scene Only) */
SEQUENCER,
/* Component which contains all operations needed for layer collections
* evaluation. */
LAYER_COLLECTIONS,
/* Entry component of majority of ID nodes: prepares CoW pointers for
* execution. */
COPY_ON_WRITE,
/* Used by all operations which are updating object when something is
* changed in view layer. */
OBJECT_FROM_LAYER,
/* Audio-related evaluation. */
AUDIO,
ARMATURE,
/* Un-interesting data-block, which is a part of dependency graph, but does
* not have very distinctive update procedure. */
GENERIC_DATABLOCK,
/* Component which is used to define visibility relation between IDs, on the ID level.
*
* Consider two ID nodes NodeA and NodeB, with the relation between visibility components going
* as NodeA -> NodeB. If NodeB is considered visible on screen, then the relation will ensure
* that NodeA is also visible. The way how relation is oriented could be seen as a inverted from
* visibility dependency point of view, but it follows the same direction as data dependency
* which simplifies common algorithms which are dealing with relations and visibility.
*
* The fact that the visibility operates on the ID level basically means that all components in
* the NodeA will be considered as affecting directly visible when NodeB's visibility is
* affecting directly visible ID.
*
* This is the way to ensure objects needed for visualization without any actual data dependency
* properly evaluated. Example of this is custom shapes for bones. */
VISIBILITY,
/* **** Evaluation-Related Outer Types (with Subdata) **** */
/* Pose Component - Owner/Container of Bones Eval */
EVAL_POSE,
/* Bone Component - Child/Subcomponent of Pose */
BONE,
/* Particle Systems Component */
PARTICLE_SYSTEM,
PARTICLE_SETTINGS,
/* Material Shading Component */
SHADING,
/* Point cache Component */
POINT_CACHE,
/* Image Animation Component */
IMAGE_ANIMATION,
/* Cache Component */
/* TODO(sergey); Verify that we really need this. */
CACHE,
/* Batch Cache Component.
* TODO(dfelinto/sergey): rename to make it more generic. */
BATCH_CACHE,
/* Duplication system. Used to force duplicated objects visible when
* when duplicator is visible. */
DUPLI,
/* Synchronization back to original datablock. */
SYNCHRONIZATION,
/* Simulation component. */
SIMULATION,
/* Node tree output component. */
NTREE_OUTPUT,
/* Total number of meaningful node types. */
NUM_TYPES,
};
const char *nodeTypeAsString(NodeType type);
NodeType nodeTypeFromSceneComponent(eDepsSceneComponentType component_type);
eDepsSceneComponentType nodeTypeToSceneComponent(NodeType type);
NodeType nodeTypeFromObjectComponent(eDepsObjectComponentType component_type);
eDepsObjectComponentType nodeTypeToObjectComponent(NodeType type);
/* All nodes in Depsgraph are descended from this. */
struct Node {
/* Helper class for static typeinfo in subclasses. */
struct TypeInfo {
TypeInfo(NodeType type, const char *type_name, int id_recalc_tag = 0);
NodeType type;
const char *type_name;
int id_recalc_tag;
};
struct Stats {
Stats();
/* Reset all the counters. Including all stats needed for average
* evaluation time calculation. */
void reset();
/* Reset counters needed for the current graph evaluation, does not
* touch averaging accumulators. */
void reset_current();
/* Time spend on this node during current graph evaluation. */
double current_time;
};
/* Relationships between nodes
* The reason why all depsgraph nodes are descended from this type (apart
* from basic serialization benefits - from the typeinfo) is that we can
* have relationships between these nodes. */
typedef Vector<Relation *> Relations;
string name; /* Identifier - mainly for debugging purposes. */
NodeType type; /* Structural type of node. */
Relations inlinks; /* Nodes which this one depends on. */
Relations outlinks; /* Nodes which depend on this one. */
Stats stats; /* Evaluation statistics. */
/* Generic tags for traversal algorithms and such.
*
* Actual meaning of values depends on a specific area. Every area is to
* clean this before use. */
int custom_flags;
/* Methods. */
Node();
virtual ~Node();
/** Generic identifier for Depsgraph Nodes. */
virtual string identifier() const;
virtual void init(const ID * /*id*/, const char * /*subdata*/)
{
}
virtual void tag_update(Depsgraph * /*graph*/, eUpdateSource /*source*/)
{
}
virtual OperationNode *get_entry_operation()
{
return nullptr;
}
virtual OperationNode *get_exit_operation()
{
return nullptr;
}
virtual NodeClass get_class() const;
MEM_CXX_CLASS_ALLOC_FUNCS("Node");
};
/* Macros for common static typeinfo. */
#define DEG_DEPSNODE_DECLARE static const Node::TypeInfo typeinfo
#define DEG_DEPSNODE_DEFINE(NodeType, type_, tname_) \
const Node::TypeInfo NodeType::typeinfo = Node::TypeInfo(type_, tname_)
void deg_register_base_depsnodes();
} // namespace deg
} // namespace blender
|
