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
222
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2013 Blender Foundation.
* All rights reserved.
*
* Original Author: Joshua Leung
* Contributor(s): None Yet
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file depsgraph/intern/nodes/deg_node.h
* \ingroup depsgraph
*/
#pragma once
#include "intern/depsgraph_types.h"
#include "BLI_utildefines.h"
struct ID;
struct GHash;
struct Scene;
namespace DEG {
struct Depsgraph;
struct DepsRelation;
struct OperationDepsNode;
/* *********************************** */
/* Base-Defines for Nodes in Depsgraph */
/* All nodes in Depsgraph are descended from this. */
struct DepsNode {
/* Helper class for static typeinfo in subclasses. */
struct TypeInfo {
TypeInfo(eDepsNode_Type type, const char *tname);
eDepsNode_Type type;
eDepsNode_Class tclass;
const char *tname;
};
/* Identifier - mainly for debugging purposes. */
const char *name;
/* Structural type of node. */
eDepsNode_Type type;
/* Type of data/behaviour represented by node... */
eDepsNode_Class tclass;
/* 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<DepsRelation *> Relations;
/* Nodes which this one depends on. */
Relations inlinks;
/* Nodes which depend on this one. */
Relations outlinks;
/* Generic tags for traversal algorithms. */
int done;
int tag;
/* Methods. */
DepsNode();
virtual ~DepsNode();
virtual string identifier() const;
string full_identifier() const;
virtual void init(const ID * /*id*/,
const char * /*subdata*/) {}
virtual void tag_update(Depsgraph * /*graph*/) {}
virtual OperationDepsNode *get_entry_operation() { return NULL; }
virtual OperationDepsNode *get_exit_operation() { return NULL; }
};
/* Macros for common static typeinfo. */
#define DEG_DEPSNODE_DECLARE \
static const DepsNode::TypeInfo typeinfo
#define DEG_DEPSNODE_DEFINE(NodeType, type_, tname_) \
const DepsNode::TypeInfo NodeType::typeinfo = DepsNode::TypeInfo(type_, tname_)
/* Generic Nodes ======================= */
struct ComponentDepsNode;
struct IDDepsNode;
/* Time Source Node. */
struct TimeSourceDepsNode : public DepsNode {
/* New "current time". */
float cfra;
/* time-offset relative to the "official" time source that this one has. */
float offset;
// TODO: evaluate() operation needed
void tag_update(Depsgraph *graph);
DEG_DEPSNODE_DECLARE;
};
/* Root Node. */
struct RootDepsNode : public DepsNode {
RootDepsNode();
~RootDepsNode();
TimeSourceDepsNode *add_time_source(const char *name = "");
/* scene that this corresponds to */
Scene *scene;
/* Entrypoint node for time-changed. */
TimeSourceDepsNode *time_source;
DEG_DEPSNODE_DECLARE;
};
/* ID-Block Reference */
struct IDDepsNode : public DepsNode {
struct ComponentIDKey {
ComponentIDKey(eDepsNode_Type type, const char *name = "");
bool operator==(const ComponentIDKey &other) const;
eDepsNode_Type type;
const char *name;
};
void init(const ID *id, const char *subdata);
~IDDepsNode();
ComponentDepsNode *find_component(eDepsNode_Type type,
const char *name = "") const;
ComponentDepsNode *add_component(eDepsNode_Type type,
const char *name = "");
void remove_component(eDepsNode_Type type, const char *name = "");
void clear_components();
void tag_update(Depsgraph *graph);
void finalize_build();
/* ID Block referenced. */
ID *id;
/* Hash to make it faster to look up components. */
GHash *components;
/* Additional flags needed for scene evaluation.
* TODO(sergey): Only needed for until really granular updates
* of all the entities.
*/
int eval_flags;
DEG_DEPSNODE_DECLARE;
};
/* Subgraph Reference. */
struct SubgraphDepsNode : public DepsNode {
void init(const ID *id, const char *subdata);
~SubgraphDepsNode();
/* Instanced graph. */
Depsgraph *graph;
/* ID-block at root of subgraph (if applicable). */
ID *root_id;
/* Number of nodes which use/reference this subgraph - if just 1, it may be
* possible to merge into main,
*/
size_t num_users;
/* (eSubgraphRef_Flag) assorted settings for subgraph node. */
int flag;
DEG_DEPSNODE_DECLARE;
};
/* Flags for subgraph node */
typedef enum eSubgraphRef_Flag {
/* Subgraph referenced is shared with another reference, so shouldn't
* free on exit.
*/
SUBGRAPH_FLAG_SHARED = (1 << 0),
/* Node is first reference to subgraph, so it can be freed when we are
* removed.
*/
SUBGRAPH_FLAG_FIRSTREF = (1 << 1),
} eSubgraphRef_Flag;
void deg_register_base_depsnodes();
} // namespace DEG
|