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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
/*
* ***** 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): Based on original depsgraph.c code - Blender Foundation (2005-2013)
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file blender/depsgraph/intern/depsgraph_build.cc
* \ingroup depsgraph
*
* Methods for constructing depsgraph.
*/
#include "MEM_guardedalloc.h"
// #define DEBUG_TIME
#include "BLI_utildefines.h"
#include "BLI_ghash.h"
#ifdef DEBUG_TIME
# include "PIL_time.h"
# include "PIL_time_utildefines.h"
#endif
extern "C" {
#include "DNA_cachefile_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_object_force.h"
#include "BKE_main.h"
#include "BKE_collision.h"
#include "BKE_effect.h"
#include "BKE_modifier.h"
} /* extern "C" */
#include "DEG_depsgraph.h"
#include "DEG_depsgraph_debug.h"
#include "DEG_depsgraph_build.h"
#include "builder/deg_builder.h"
#include "builder/deg_builder_cycle.h"
#include "builder/deg_builder_nodes.h"
#include "builder/deg_builder_relations.h"
#include "builder/deg_builder_transitive.h"
#include "intern/nodes/deg_node.h"
#include "intern/nodes/deg_node_component.h"
#include "intern/nodes/deg_node_operation.h"
#include "intern/depsgraph_types.h"
#include "intern/depsgraph_intern.h"
#include "util/deg_util_foreach.h"
/* ****************** */
/* External Build API */
static DEG::eDepsNode_Type deg_build_scene_component_type(
eDepsSceneComponentType component)
{
switch (component) {
case DEG_SCENE_COMP_PARAMETERS: return DEG::DEG_NODE_TYPE_PARAMETERS;
case DEG_SCENE_COMP_ANIMATION: return DEG::DEG_NODE_TYPE_ANIMATION;
case DEG_SCENE_COMP_SEQUENCER: return DEG::DEG_NODE_TYPE_SEQUENCER;
}
return DEG::DEG_NODE_TYPE_UNDEFINED;
}
static DEG::eDepsNode_Type deg_build_object_component_type(
eDepsObjectComponentType component)
{
switch (component) {
case DEG_OB_COMP_PARAMETERS: return DEG::DEG_NODE_TYPE_PARAMETERS;
case DEG_OB_COMP_PROXY: return DEG::DEG_NODE_TYPE_PROXY;
case DEG_OB_COMP_ANIMATION: return DEG::DEG_NODE_TYPE_ANIMATION;
case DEG_OB_COMP_TRANSFORM: return DEG::DEG_NODE_TYPE_TRANSFORM;
case DEG_OB_COMP_GEOMETRY: return DEG::DEG_NODE_TYPE_GEOMETRY;
case DEG_OB_COMP_EVAL_POSE: return DEG::DEG_NODE_TYPE_EVAL_POSE;
case DEG_OB_COMP_BONE: return DEG::DEG_NODE_TYPE_BONE;
case DEG_OB_COMP_EVAL_PARTICLES: return DEG::DEG_NODE_TYPE_EVAL_PARTICLES;
case DEG_OB_COMP_SHADING: return DEG::DEG_NODE_TYPE_SHADING;
case DEG_OB_COMP_CACHE: return DEG::DEG_NODE_TYPE_CACHE;
}
return DEG::DEG_NODE_TYPE_UNDEFINED;
}
static DEG::DepsNodeHandle *get_handle(DepsNodeHandle *handle)
{
return reinterpret_cast<DEG::DepsNodeHandle *>(handle);
}
void DEG_add_scene_relation(DepsNodeHandle *handle,
Scene *scene,
eDepsSceneComponentType component,
const char *description)
{
DEG::eDepsNode_Type type = deg_build_scene_component_type(component);
DEG::ComponentKey comp_key(&scene->id, type);
DEG::DepsNodeHandle *deg_handle = get_handle(handle);
deg_handle->builder->add_node_handle_relation(comp_key,
deg_handle,
description);
}
void DEG_add_object_relation(DepsNodeHandle *handle,
Object *ob,
eDepsObjectComponentType component,
const char *description)
{
DEG::eDepsNode_Type type = deg_build_object_component_type(component);
DEG::ComponentKey comp_key(&ob->id, type);
DEG::DepsNodeHandle *deg_handle = get_handle(handle);
deg_handle->builder->add_node_handle_relation(comp_key,
deg_handle,
description);
}
void DEG_add_object_cache_relation(DepsNodeHandle *handle,
CacheFile *cache_file,
eDepsObjectComponentType component,
const char *description)
{
DEG::eDepsNode_Type type = deg_build_object_component_type(component);
DEG::ComponentKey comp_key(&cache_file->id, type);
DEG::DepsNodeHandle *deg_handle = get_handle(handle);
deg_handle->builder->add_node_handle_relation(comp_key,
deg_handle,
description);
}
void DEG_add_bone_relation(DepsNodeHandle *handle,
Object *ob,
const char *bone_name,
eDepsObjectComponentType component,
const char *description)
{
DEG::eDepsNode_Type type = deg_build_object_component_type(component);
DEG::ComponentKey comp_key(&ob->id, type, bone_name);
DEG::DepsNodeHandle *deg_handle = get_handle(handle);
/* XXX: "Geometry Eval" might not always be true, but this only gets called
* from modifier building now.
*/
deg_handle->builder->add_node_handle_relation(comp_key,
deg_handle,
description);
}
struct Depsgraph *DEG_get_graph_from_handle(struct DepsNodeHandle *handle)
{
DEG::DepsNodeHandle *deg_handle = get_handle(handle);
DEG::DepsgraphRelationBuilder *relation_builder = deg_handle->builder;
return reinterpret_cast<Depsgraph *>(relation_builder->getGraph());
}
void DEG_add_special_eval_flag(Depsgraph *graph, ID *id, short flag)
{
DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
if (graph == NULL) {
BLI_assert(!"Graph should always be valid");
return;
}
DEG::IDDepsNode *id_node = deg_graph->find_id_node(id);
if (id_node == NULL) {
BLI_assert(!"ID should always be valid");
return;
}
id_node->eval_flags |= flag;
}
/* ******************** */
/* Graph Building API's */
/* Build depsgraph for the given scene, and dump results in given
* graph container.
*/
/* XXX: assume that this is called from outside, given the current scene as
* the "main" scene.
*/
void DEG_graph_build_from_scene(Depsgraph *graph, Main *bmain, Scene *scene)
{
#ifdef DEBUG_TIME
TIMEIT_START(DEG_graph_build_from_scene);
#endif
DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
/* 1) Generate all the nodes in the graph first */
DEG::DepsgraphNodeBuilder node_builder(bmain, deg_graph);
/* create root node for scene first
* - this way it should be the first in the graph,
* reflecting its role as the entrypoint
*/
node_builder.begin_build(bmain);
node_builder.add_root_node();
node_builder.build_scene(bmain, scene);
/* 2) Hook up relationships between operations - to determine evaluation
* order.
*/
DEG::DepsgraphRelationBuilder relation_builder(deg_graph);
/* Hook scene up to the root node as entrypoint to graph. */
/* XXX what does this relation actually mean?
* it doesnt add any operations anyway and is not clear what part of the
* scene is to be connected.
*/
relation_builder.begin_build(bmain);
relation_builder.build_scene(bmain, scene);
/* Detect and solve cycles. */
DEG::deg_graph_detect_cycles(deg_graph);
/* 3) Simplify the graph by removing redundant relations (to optimize
* traversal later). */
/* TODO: it would be useful to have an option to disable this in cases where
* it is causing trouble.
*/
if (G.debug_value == 799) {
DEG::deg_graph_transitive_reduction(deg_graph);
}
/* 4) Flush visibility layer and re-schedule nodes for update. */
DEG::deg_graph_build_finalize(deg_graph);
#if 0
if (!DEG_debug_consistency_check(deg_graph)) {
printf("Consistency validation failed, ABORTING!\n");
abort();
}
#endif
#ifdef DEBUG_TIME
TIMEIT_END(DEG_graph_build_from_scene);
#endif
}
/* Tag graph relations for update. */
void DEG_graph_tag_relations_update(Depsgraph *graph)
{
DEG::Depsgraph *deg_graph = reinterpret_cast<DEG::Depsgraph *>(graph);
deg_graph->need_update = true;
}
/* Tag all relations for update. */
void DEG_relations_tag_update(Main *bmain)
{
for (Scene *scene = (Scene *)bmain->scene.first;
scene != NULL;
scene = (Scene *)scene->id.next)
{
if (scene->depsgraph != NULL) {
DEG_graph_tag_relations_update(scene->depsgraph);
}
}
}
/* Create new graph if didn't exist yet,
* or update relations if graph was tagged for update.
*/
void DEG_scene_relations_update(Main *bmain, Scene *scene)
{
if (scene->depsgraph == NULL) {
/* Rebuild graph from scratch and exit. */
scene->depsgraph = DEG_graph_new();
DEG_graph_build_from_scene(scene->depsgraph, bmain, scene);
return;
}
DEG::Depsgraph *graph = reinterpret_cast<DEG::Depsgraph *>(scene->depsgraph);
if (!graph->need_update) {
/* Graph is up to date, nothing to do. */
return;
}
/* Clear all previous nodes and operations. */
graph->clear_all_nodes();
graph->operations.clear();
BLI_gset_clear(graph->entry_tags, NULL);
/* Build new nodes and relations. */
DEG_graph_build_from_scene(reinterpret_cast< ::Depsgraph * >(graph),
bmain,
scene);
graph->need_update = false;
}
/* Rebuild dependency graph only for a given scene. */
void DEG_scene_relations_rebuild(Main *bmain, Scene *scene)
{
if (scene->depsgraph != NULL) {
DEG_graph_tag_relations_update(scene->depsgraph);
}
DEG_scene_relations_update(bmain, scene);
}
void DEG_scene_graph_free(Scene *scene)
{
if (scene->depsgraph) {
DEG_graph_free(scene->depsgraph);
scene->depsgraph = NULL;
}
}
void DEG_add_collision_relations(DepsNodeHandle *handle,
Scene *scene,
Object *ob,
Group *group,
unsigned int modifier_type,
DEG_CollobjFilterFunction fn,
bool dupli,
const char *name)
{
unsigned int numcollobj;
Object **collobjs = get_collisionobjects_ext(scene, ob, group, &numcollobj, modifier_type, dupli);
for (unsigned int i = 0; i < numcollobj; i++) {
Object *ob1 = collobjs[i];
if (!fn || fn(ob1, modifiers_findByType(ob1, (ModifierType)modifier_type))) {
DEG_add_object_relation(handle, ob1, DEG_OB_COMP_TRANSFORM, name);
DEG_add_object_relation(handle, ob1, DEG_OB_COMP_GEOMETRY, name);
}
}
if (collobjs)
MEM_freeN(collobjs);
}
void DEG_add_forcefield_relations(DepsNodeHandle *handle,
Scene *scene,
Object *ob,
EffectorWeights *effector_weights,
bool add_absorption,
int skip_forcefield,
const char *name)
{
ListBase *effectors = pdInitEffectors(scene, ob, NULL, effector_weights, false);
if (effectors) {
for (EffectorCache *eff = (EffectorCache*)effectors->first; eff; eff = eff->next) {
if (eff->ob != ob && eff->pd->forcefield != skip_forcefield) {
DEG_add_object_relation(handle, eff->ob, DEG_OB_COMP_TRANSFORM, name);
if (eff->psys) {
DEG_add_object_relation(handle, eff->ob, DEG_OB_COMP_EVAL_PARTICLES, name);
/* TODO: remove this when/if EVAL_PARTICLES is sufficient
* for up to date particles.
*/
DEG_add_object_relation(handle, eff->ob, DEG_OB_COMP_GEOMETRY, name);
}
if (eff->pd->forcefield == PFIELD_SMOKEFLOW && eff->pd->f_source) {
DEG_add_object_relation(handle,
eff->pd->f_source,
DEG_OB_COMP_TRANSFORM,
"Smoke Force Domain");
DEG_add_object_relation(handle,
eff->pd->f_source,
DEG_OB_COMP_GEOMETRY,
"Smoke Force Domain");
}
if (add_absorption && (eff->pd->flag & PFIELD_VISIBILITY)) {
DEG_add_collision_relations(handle,
scene,
ob,
NULL,
eModifierType_Collision,
NULL,
true,
"Force Absorption");
}
}
}
}
pdEndEffectors(&effectors);
}
|