source/blender/depsgraph/intern/builder/deg_builder_relations.cc

   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): Based on original depsgraph.c code - Blender Foundation (2005-2013)
  23  *
  24  * ***** END GPL LICENSE BLOCK *****
  25  */
  26
  27 /** \file blender/depsgraph/intern/builder/deg_builder_relations.cc
  28  *  \ingroup depsgraph
  29  *
  30  * Methods for constructing depsgraph
  31  */
  32
  33 #include "intern/builder/deg_builder_relations.h"
  34
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <cstring>  /* required for STREQ later on. */
  38
  39 #include "MEM_guardedalloc.h"
  40
  41 #include "BLI_utildefines.h"
  42 #include "BLI_blenlib.h"
  43
  44 extern "C" {
  45 #include "DNA_action_types.h"
  46 #include "DNA_anim_types.h"
  47 #include "DNA_armature_types.h"
  48 #include "DNA_camera_types.h"
  49 #include "DNA_cachefile_types.h"
  50 #include "DNA_constraint_types.h"
  51 #include "DNA_curve_types.h"
  52 #include "DNA_effect_types.h"
  53 #include "DNA_gpencil_types.h"
  54 #include "DNA_group_types.h"
  55 #include "DNA_key_types.h"
  56 #include "DNA_lamp_types.h"
  57 #include "DNA_material_types.h"
  58 #include "DNA_mask_types.h"
  59 #include "DNA_mesh_types.h"
  60 #include "DNA_meta_types.h"
  61 #include "DNA_movieclip_types.h"
  62 #include "DNA_node_types.h"
  63 #include "DNA_particle_types.h"
  64 #include "DNA_lightprobe_types.h"
  65 #include "DNA_object_types.h"
  66 #include "DNA_rigidbody_types.h"
  67 #include "DNA_scene_types.h"
  68 #include "DNA_texture_types.h"
  69 #include "DNA_world_types.h"
  70 #include "DNA_object_force.h"
  71
  72 #include "BKE_action.h"
  73 #include "BKE_armature.h"
  74 #include "BKE_animsys.h"
  75 #include "BKE_constraint.h"
  76 #include "BKE_curve.h"
  77 #include "BKE_effect.h"
  78 #include "BKE_collision.h"
  79 #include "BKE_fcurve.h"
  80 #include "BKE_group.h"
  81 #include "BKE_key.h"
  82 #include "BKE_library.h"
  83 #include "BKE_main.h"
  84 #include "BKE_material.h"
  85 #include "BKE_mball.h"
  86 #include "BKE_modifier.h"
  87 #include "BKE_node.h"
  88 #include "BKE_object.h"
  89 #include "BKE_particle.h"
  90 #include "BKE_rigidbody.h"
  91 #include "BKE_sound.h"
  92 #include "BKE_tracking.h"
  93 #include "BKE_world.h"
  94
  95 #include "RNA_access.h"
  96 #include "RNA_types.h"
  97 } /* extern "C" */
  98
  99 #include "DEG_depsgraph.h"
 100 #include "DEG_depsgraph_build.h"
 101
 102 #include "intern/builder/deg_builder.h"
 103 #include "intern/builder/deg_builder_pchanmap.h"
 104
 105 #include "intern/nodes/deg_node.h"
 106 #include "intern/nodes/deg_node_component.h"
 107 #include "intern/nodes/deg_node_operation.h"
 108
 109 #include "intern/depsgraph_intern.h"
 110 #include "intern/depsgraph_types.h"
 111
 112 #include "util/deg_util_foreach.h"
 113
 114 namespace DEG {
 115
 116 namespace {
 117
 118 struct BuilderWalkUserData {
 119         DepsgraphRelationBuilder *builder;
 120 };
 121
 122 void modifier_walk(void *user_data,
 123                    struct Object * /*object*/,
 124                    struct Object **obpoin,
 125                    int /*cb_flag*/)
 126 {
 127         BuilderWalkUserData *data = (BuilderWalkUserData *)user_data;
 128         if (*obpoin) {
 129                 data->builder->build_object(NULL, *obpoin);
 130         }
 131 }
 132
 133 void constraint_walk(bConstraint * /*con*/,
 134                      ID **idpoin,
 135                      bool /*is_reference*/,
 136                      void *user_data)
 137 {
 138         BuilderWalkUserData *data = (BuilderWalkUserData *)user_data;
 139         if (*idpoin) {
 140                 ID *id = *idpoin;
 141                 if (GS(id->name) == ID_OB) {
 142                         data->builder->build_object(NULL, (Object *)id);
 143                 }
 144         }
 145 }
 146
 147 }  /* namespace */
 148
 149 /* ***************** */
 150 /* Relations Builder */
 151
 152 /* TODO(sergey): This is somewhat weak, but we don't want neither false-positive
 153  * time dependencies nor special exceptions in the depsgraph evaluation.
 154  */
 155 static bool python_driver_depends_on_time(ChannelDriver *driver)
 156 {
 157         if (driver->expression[0] == '\0') {
 158                 /* Empty expression depends on nothing. */
 159                 return false;
 160         }
 161         if (strchr(driver->expression, '(') != NULL) {
 162                 /* Function calls are considered dependent on a time. */
 163                 return true;
 164         }
 165         if (strstr(driver->expression, "frame") != NULL) {
 166                 /* Variable `frame` depends on time. */
 167                 /* TODO(sergey): This is a bit weak, but not sure about better way of
 168                  * handling this.
 169                  */
 170                 return true;
 171         }
 172         /* Possible indirect time relation s should be handled via variable
 173          * targets.
 174          */
 175         return false;
 176 }
 177
 178 static bool particle_system_depends_on_time(ParticleSystem *psys)
 179 {
 180         ParticleSettings *part = psys->part;
 181         /* Non-hair particles we always consider dependent on time. */
 182         if (part->type != PART_HAIR) {
 183                 return true;
 184         }
 185         /* Dynamics always depends on time. */
 186         if (psys->flag & PSYS_HAIR_DYNAMICS) {
 187                 return true;
 188         }
 189         /* TODO(sergey): Check what else makes hair dependent on time. */
 190         return false;
 191 }
 192
 193 static bool object_particles_depends_on_time(Object *object)
 194 {
 195         LINKLIST_FOREACH (ParticleSystem *, psys, &object->particlesystem) {
 196                 if (particle_system_depends_on_time(psys)) {
 197                         return true;
 198                 }
 199         }
 200         return false;
 201 }
 202
 203 /* **** General purpose functions ****  */
 204
 205 DepsgraphRelationBuilder::DepsgraphRelationBuilder(Main *bmain,
 206                                                    Depsgraph *graph)
 207     : bmain_(bmain),
 208       graph_(graph),
 209       scene_(NULL)
 210 {
 211 }
 212
 213 TimeSourceDepsNode *DepsgraphRelationBuilder::get_node(
 214         const TimeSourceKey &key) const
 215 {
 216         if (key.id) {
 217                 /* XXX TODO */
 218                 return NULL;
 219         }
 220         else {
 221                 return graph_->time_source;
 222         }
 223 }
 224
 225 ComponentDepsNode *DepsgraphRelationBuilder::get_node(
 226         const ComponentKey &key) const
 227 {
 228         IDDepsNode *id_node = graph_->find_id_node(key.id);
 229         if (!id_node) {
 230                 fprintf(stderr, "find_node component: Could not find ID %s\n",
 231                         (key.id != NULL) ? key.id->name : "<null>");
 232                 return NULL;
 233         }
 234
 235         ComponentDepsNode *node = id_node->find_component(key.type, key.name);
 236         return node;
 237 }
 238
 239 OperationDepsNode *DepsgraphRelationBuilder::get_node(
 240         const OperationKey &key) const
 241 {
 242         OperationDepsNode *op_node = find_node(key);
 243         if (op_node == NULL) {
 244                 fprintf(stderr, "find_node_operation: Failed for (%s, '%s')\n",
 245                         DEG_OPNAMES[key.opcode], key.name);
 246         }
 247         return op_node;
 248 }
 249
 250 DepsNode *DepsgraphRelationBuilder::get_node(const RNAPathKey &key) const
 251 {
 252         return graph_->find_node_from_pointer(&key.ptr, key.prop);
 253 }
 254
 255 OperationDepsNode *DepsgraphRelationBuilder::find_node(
 256         const OperationKey &key) const
 257 {
 258         IDDepsNode *id_node = graph_->find_id_node(key.id);
 259         if (!id_node) {
 260                 return NULL;
 261         }
 262         ComponentDepsNode *comp_node = id_node->find_component(key.component_type,
 263                                                                key.component_name);
 264         if (!comp_node) {
 265                 return NULL;
 266         }
 267         return comp_node->find_operation(key.opcode, key.name, key.name_tag);
 268 }
 269
 270 bool DepsgraphRelationBuilder::has_node(const OperationKey &key) const
 271 {
 272         return find_node(key) != NULL;
 273 }
 274
 275 void DepsgraphRelationBuilder::add_time_relation(TimeSourceDepsNode *timesrc,
 276                                                  DepsNode *node_to,
 277                                                  const char *description,
 278                                                  bool check_unique)
 279 {
 280         if (timesrc && node_to) {
 281                 graph_->add_new_relation(timesrc, node_to, description, check_unique);
 282         }
 283         else {
 284                 DEG_DEBUG_PRINTF("add_time_relation(%p = %s, %p = %s, %s) Failed\n",
 285                                  timesrc,   (timesrc) ? timesrc->identifier().c_str() : "<None>",
 286                                  node_to,   (node_to) ? node_to->identifier().c_str() : "<None>",
 287                                  description);
 288         }
 289 }
 290
 291 void DepsgraphRelationBuilder::add_operation_relation(
 292         OperationDepsNode *node_from,
 293         OperationDepsNode *node_to,
 294         const char *description,
 295         bool check_unique)
 296 {
 297         if (node_from && node_to) {
 298                 graph_->add_new_relation(node_from, node_to, description, check_unique);
 299         }
 300         else {
 301                 DEG_DEBUG_PRINTF("add_operation_relation(%p = %s, %p = %s, %s) Failed\n",
 302                                  node_from, (node_from) ? node_from->identifier().c_str() : "<None>",
 303                                  node_to,   (node_to)   ? node_to->identifier().c_str() : "<None>",
 304                                  description);
 305         }
 306 }
 307
 308 void DepsgraphRelationBuilder::add_collision_relations(
 309         const OperationKey &key,
 310         Scene *scene,
 311         Object *object,
 312         Group *group,
 313         bool dupli,
 314         const char *name)
 315 {
 316         unsigned int numcollobj;
 317         Object **collobjs = get_collisionobjects_ext(scene,
 318                                                      object,
 319                                                      group,
 320                                                      &numcollobj,
 321                                                      eModifierType_Collision,
 322                                                      dupli);
 323         for (unsigned int i = 0; i < numcollobj; i++) {
 324                 Object *ob1 = collobjs[i];
 325
 326                 ComponentKey trf_key(&ob1->id, DEG_NODE_TYPE_TRANSFORM);
 327                 add_relation(trf_key, key, name);
 328
 329                 ComponentKey coll_key(&ob1->id, DEG_NODE_TYPE_GEOMETRY);
 330                 add_relation(coll_key, key, name);
 331         }
 332         if (collobjs != NULL) {
 333                 MEM_freeN(collobjs);
 334         }
 335 }
 336
 337 void DepsgraphRelationBuilder::add_forcefield_relations(
 338         const OperationKey &key,
 339         Scene *scene,
 340         Object *object,
 341         ParticleSystem *psys,
 342         EffectorWeights *eff,
 343         bool add_absorption,
 344         const char *name)
 345 {
 346         ListBase *effectors = pdInitEffectors(NULL, scene, object, psys, eff, false);
 347         if (effectors != NULL) {
 348                 LINKLIST_FOREACH(EffectorCache *, eff, effectors) {
 349                         if (eff->ob != object) {
 350                                 ComponentKey eff_key(&eff->ob->id, DEG_NODE_TYPE_TRANSFORM);
 351                                 add_relation(eff_key, key, name);
 352                         }
 353                         if (eff->psys != NULL) {
 354                                 if (eff->ob != object) {
 355                                         ComponentKey eff_key(&eff->ob->id, DEG_NODE_TYPE_EVAL_PARTICLES);
 356                                         add_relation(eff_key, key, name);
 357
 358                                         /* TODO: remove this when/if EVAL_PARTICLES is sufficient
 359                                          * for up to date particles.
 360                                          */
 361                                         ComponentKey mod_key(&eff->ob->id, DEG_NODE_TYPE_GEOMETRY);
 362                                         add_relation(mod_key, key, name);
 363                                 }
 364                                 else if (eff->psys != psys) {
 365                                         OperationKey eff_key(&eff->ob->id,
 366                                                              DEG_NODE_TYPE_EVAL_PARTICLES,
 367                                                              DEG_OPCODE_PARTICLE_SYSTEM_EVAL,
 368                                                              eff->psys->name);
 369                                         add_relation(eff_key, key, name);
 370                                 }
 371                         }
 372                         if (eff->pd->forcefield == PFIELD_SMOKEFLOW && eff->pd->f_source) {
 373                                 ComponentKey trf_key(&eff->pd->f_source->id,
 374                                                      DEG_NODE_TYPE_TRANSFORM);
 375                                 add_relation(trf_key, key, "Smoke Force Domain");
 376
 377                                 ComponentKey eff_key(&eff->pd->f_source->id,
 378                                                      DEG_NODE_TYPE_GEOMETRY);
 379                                 add_relation(eff_key, key, "Smoke Force Domain");
 380                         }
 381                         if (add_absorption && (eff->pd->flag & PFIELD_VISIBILITY)) {
 382                                 add_collision_relations(key,
 383                                                         scene,
 384                                                         object,
 385                                                         NULL,
 386                                                         true,
 387                                                         "Force Absorption");
 388                         }
 389                 }
 390         }
 391
 392         pdEndEffectors(&effectors);
 393 }
 394
 395 Depsgraph *DepsgraphRelationBuilder::getGraph()
 396 {
 397         return graph_;
 398 }
 399
 400 /* **** Functions to build relations between entities  **** */
 401
 402 void DepsgraphRelationBuilder::begin_build()
 403 {
 404         /* LIB_TAG_DOIT is used to indicate whether node for given ID was already
 405          * created or not.
 406          */
 407         BKE_main_id_tag_all(bmain_, LIB_TAG_DOIT, false);
 408         /* XXX nested node trees are notr included in tag-clearing above,
 409          * so we need to do this manually.
 410          */
 411         FOREACH_NODETREE(bmain_, nodetree, id)
 412         {
 413                 if (id != (ID *)nodetree) {
 414                         nodetree->id.tag &= ~LIB_TAG_DOIT;
 415                 }
 416         }
 417         FOREACH_NODETREE_END
 418 }
 419
 420 void DepsgraphRelationBuilder::build_group(Object *object, Group *group)
 421 {
 422         ID *group_id = &group->id;
 423         bool group_done = (group_id->tag & LIB_TAG_DOIT) != 0;
 424         OperationKey object_local_transform_key(&object->id,
 425                                                 DEG_NODE_TYPE_TRANSFORM,
 426                                                 DEG_OPCODE_TRANSFORM_LOCAL);
 427
 428         if (!group_done) {
 429                 LINKLIST_FOREACH(Base *, base, &group->view_layer->object_bases) {
 430                         build_object(NULL, base->object);
 431                 }
 432
 433                 build_view_layer_collections(&group->id, group->view_layer);
 434                 group_id->tag |= LIB_TAG_DOIT;
 435         }
 436
 437         LINKLIST_FOREACH (Base *, base, &group->view_layer->object_bases) {
 438                 ComponentKey dupli_transform_key(&base->object->id, DEG_NODE_TYPE_TRANSFORM);
 439                 add_relation(dupli_transform_key, object_local_transform_key, "Dupligroup");
 440         }
 441 }
 442
 443 void DepsgraphRelationBuilder::build_object(Base *base, Object *object)
 444 {
 445         if (object->id.tag & LIB_TAG_DOIT) {
 446                 if (base != NULL) {
 447                         build_object_flags(base, object);
 448                 }
 449                 return;
 450         }
 451         object->id.tag |= LIB_TAG_DOIT;
 452         /* Object Transforms */
 453         eDepsOperation_Code base_op = (object->parent) ? DEG_OPCODE_TRANSFORM_PARENT
 454                                                        : DEG_OPCODE_TRANSFORM_LOCAL;
 455         OperationKey base_op_key(&object->id, DEG_NODE_TYPE_TRANSFORM, base_op);
 456         OperationKey local_transform_key(&object->id,
 457                                          DEG_NODE_TYPE_TRANSFORM,
 458                                          DEG_OPCODE_TRANSFORM_LOCAL);
 459         OperationKey parent_transform_key(&object->id,
 460                                           DEG_NODE_TYPE_TRANSFORM,
 461                                           DEG_OPCODE_TRANSFORM_PARENT);
 462         OperationKey final_transform_key(&object->id,
 463                                          DEG_NODE_TYPE_TRANSFORM,
 464                                          DEG_OPCODE_TRANSFORM_FINAL);
 465         OperationKey ob_ubereval_key(&object->id,
 466                                      DEG_NODE_TYPE_TRANSFORM,
 467                                      DEG_OPCODE_TRANSFORM_OBJECT_UBEREVAL);
 468         /* Various flags, flushing from bases/collections. */
 469         build_object_flags(base, object);
 470         /* Parenting. */
 471         if (object->parent != NULL) {
 472                 /* Parent relationship. */
 473                 build_object_parent(object);
 474                 /* Local -> parent. */
 475                 add_relation(local_transform_key,
 476                              parent_transform_key,
 477                              "ObLocal -> ObParent");
 478         }
 479         /* Modifiers. */
 480         if (object->modifiers.first != NULL) {
 481                 BuilderWalkUserData data;
 482                 data.builder = this;
 483                 modifiers_foreachObjectLink(object, modifier_walk, &data);
 484         }
 485         /* Constraints. */
 486         if (object->constraints.first != NULL) {
 487                 BuilderWalkUserData data;
 488                 data.builder = this;
 489                 BKE_constraints_id_loop(&object->constraints, constraint_walk, &data);
 490         }
 491         /* Object constraints. */
 492         if (object->constraints.first != NULL) {
 493                 OperationKey constraint_key(&object->id,
 494                                             DEG_NODE_TYPE_TRANSFORM,
 495                                             DEG_OPCODE_TRANSFORM_CONSTRAINTS);
 496                 /* Constraint relations. */
 497                 build_constraints(&object->id,
 498                                   DEG_NODE_TYPE_TRANSFORM,
 499                                   "",
 500                                   &object->constraints,
 501                                   NULL);
 502                 /* operation order */
 503                 add_relation(base_op_key, constraint_key, "ObBase-> Constraint Stack");
 504                 add_relation(constraint_key, final_transform_key, "ObConstraints -> Done");
 505                 // XXX
 506                 add_relation(constraint_key, ob_ubereval_key, "Temp Ubereval");
 507                 add_relation(ob_ubereval_key, final_transform_key, "Temp Ubereval");
 508         }
 509         else {
 510                 /* NOTE: Keep an eye here, we skip some relations here to "streamline"
 511                  * dependencies and avoid transitive relations which causes overhead.
 512                  * But once we get rid of uber eval node this will need reconsideration.
 513                  */
 514                 if (object->rigidbody_object == NULL) {
 515                         /* Rigid body will hook up another node inbetween, so skip
 516                          * relation here to avoid transitive relation.
 517                          */
 518                         add_relation(base_op_key, ob_ubereval_key, "Temp Ubereval");
 519                 }
 520                 add_relation(ob_ubereval_key, final_transform_key, "Temp Ubereval");
 521         }
 522         /* Animation data */
 523         build_animdata(&object->id);
 524         /* Object data. */
 525         build_object_data(object);
 526         /* Particle systems. */
 527         if (object->particlesystem.first != NULL) {
 528                 build_particles(object);
 529         }
 530         /* Grease pencil. */
 531         if (object->gpd != NULL) {
 532                 build_gpencil(object->gpd);
 533         }
 534         /* Object that this is a proxy for. */
 535         if (object->proxy != NULL) {
 536                 object->proxy->proxy_from = object;
 537                 build_object(NULL, object->proxy);
 538                 /* TODO(sergey): This is an inverted relation, matches old depsgraph
 539                  * behavior and need to be investigated if it still need to be inverted.
 540                  */
 541                 ComponentKey ob_pose_key(&object->id, DEG_NODE_TYPE_EVAL_POSE);
 542                 ComponentKey proxy_pose_key(&object->proxy->id, DEG_NODE_TYPE_EVAL_POSE);
 543                 add_relation(ob_pose_key, proxy_pose_key, "Proxy");
 544         }
 545         /* Object dupligroup. */
 546         if (object->dup_group != NULL) {
 547                 build_group(object, object->dup_group);
 548         }
 549 }
 550
 551 void DepsgraphRelationBuilder::build_object_flags(Base *base, Object *object)
 552 {
 553         if (base == NULL) {
 554                 return;
 555         }
 556         OperationKey view_layer_done_key(&scene_->id,
 557                                          DEG_NODE_TYPE_LAYER_COLLECTIONS,
 558                                          DEG_OPCODE_VIEW_LAYER_DONE);
 559         OperationKey object_flags_key(&object->id,
 560                                       DEG_NODE_TYPE_LAYER_COLLECTIONS,
 561                                       DEG_OPCODE_OBJECT_BASE_FLAGS);
 562         add_relation(view_layer_done_key, object_flags_key, "Base flags flush");
 563 }
 564
 565 void DepsgraphRelationBuilder::build_object_data(Object *object)
 566 {
 567         if (object->data == NULL) {
 568                 return;
 569         }
 570         ID *obdata_id = (ID *)object->data;
 571         /* Object data animation. */
 572         build_animdata(obdata_id);
 573         /* type-specific data. */
 574         switch (object->type) {
 575                 case OB_MESH:
 576                 case OB_CURVE:
 577                 case OB_FONT:
 578                 case OB_SURF:
 579                 case OB_MBALL:
 580                 case OB_LATTICE:
 581                 {
 582                         build_obdata_geom(object);
 583                         break;
 584                 }
 585                 case OB_ARMATURE:
 586                         if (ID_IS_LINKED(object) && object->proxy_from != NULL) {
 587                                 build_proxy_rig(object);
 588                         }
 589                         else {
 590                                 build_rig(object);
 591                         }
 592                         break;
 593                 case OB_LAMP:
 594                         build_lamp(object);
 595                         break;
 596                 case OB_CAMERA:
 597                         build_camera(object);
 598                         break;
 599                 case OB_LIGHTPROBE:
 600                         build_lightprobe(object);
 601                         break;
 602         }
 603         Key *key = BKE_key_from_object(object);
 604         if (key != NULL) {
 605                 ComponentKey geometry_key((ID *)object->data, DEG_NODE_TYPE_GEOMETRY);
 606                 ComponentKey key_key(&key->id, DEG_NODE_TYPE_GEOMETRY);
 607                 add_relation(key_key, geometry_key, "Shapekeys");
 608         }
 609 }
 610
 611 void DepsgraphRelationBuilder::build_object_parent(Object *object)
 612 {
 613         /* XXX: for now, need to use the component key (not just direct to the parent op),
 614          * or else the matrix doesn't get reset/
 615          */
 616         // XXX: @sergey - it would be good if we got that backwards flushing working
 617         // when tagging for updates.
 618         //OperationKey ob_key(&object->id, DEG_NODE_TYPE_TRANSFORM, DEG_OPCODE_TRANSFORM_PARENT);
 619         ComponentKey ob_key(&object->id, DEG_NODE_TYPE_TRANSFORM);
 620
 621         /* type-specific links */
 622         switch (object->partype) {
 623                 case PARSKEL:  /* Armature Deform (Virtual Modifier) */
 624                 {
 625                         ComponentKey parent_key(&object->parent->id, DEG_NODE_TYPE_TRANSFORM);
 626                         add_relation(parent_key, ob_key, "Armature Deform Parent");
 627                         break;
 628                 }
 629
 630                 case PARVERT1: /* Vertex Parent */
 631                 case PARVERT3:
 632                 {
 633                         ComponentKey parent_key(&object->parent->id, DEG_NODE_TYPE_GEOMETRY);
 634                         add_relation(parent_key, ob_key, "Vertex Parent");
 635
 636                         /* XXX not sure what this is for or how you could be done properly - lukas */
 637                         OperationDepsNode *parent_node = find_operation_node(parent_key);
 638                         if (parent_node != NULL) {
 639                                 parent_node->customdata_mask |= CD_MASK_ORIGINDEX;
 640                         }
 641
 642                         ComponentKey transform_key(&object->parent->id, DEG_NODE_TYPE_TRANSFORM);
 643                         add_relation(transform_key, ob_key, "Vertex Parent TFM");
 644                         break;
 645                 }
 646
 647                 case PARBONE: /* Bone Parent */
 648                 {
 649                         ComponentKey parent_bone_key(&object->parent->id,
 650                                                      DEG_NODE_TYPE_BONE,
 651                                                      object->parsubstr);
 652                         OperationKey parent_transform_key(&object->parent->id,
 653                                                           DEG_NODE_TYPE_TRANSFORM,
 654                                                           DEG_OPCODE_TRANSFORM_FINAL);
 655                         add_relation(parent_bone_key, ob_key, "Bone Parent");
 656                         add_relation(parent_transform_key, ob_key, "Armature Parent");
 657                         break;
 658                 }
 659
 660                 default:
 661                 {
 662                         if (object->parent->type == OB_LATTICE) {
 663                                 /* Lattice Deform Parent - Virtual Modifier */
 664                                 // XXX: no virtual modifiers should be left!
 665                                 ComponentKey parent_key(&object->parent->id, DEG_NODE_TYPE_TRANSFORM);
 666                                 ComponentKey geom_key(&object->parent->id, DEG_NODE_TYPE_GEOMETRY);
 667
 668                                 add_relation(parent_key, ob_key, "Lattice Deform Parent");
 669                                 add_relation(geom_key, ob_key, "Lattice Deform Parent Geom");
 670                         }
 671                         else if (object->parent->type == OB_CURVE) {
 672                                 Curve *cu = (Curve *)object->parent->data;
 673
 674                                 if (cu->flag & CU_PATH) {
 675                                         /* Follow Path */
 676                                         ComponentKey parent_key(&object->parent->id, DEG_NODE_TYPE_GEOMETRY);
 677                                         add_relation(parent_key, ob_key, "Curve Follow Parent");
 678
 679                                         ComponentKey transform_key(&object->parent->id, DEG_NODE_TYPE_TRANSFORM);
 680                                         add_relation(transform_key, ob_key, "Curve Follow TFM");
 681                                 }
 682                                 else {
 683                                         /* Standard Parent */
 684                                         ComponentKey parent_key(&object->parent->id, DEG_NODE_TYPE_TRANSFORM);
 685                                         add_relation(parent_key, ob_key, "Curve Parent");
 686                                 }
 687                         }
 688                         else {
 689                                 /* Standard Parent */
 690                                 ComponentKey parent_key(&object->parent->id, DEG_NODE_TYPE_TRANSFORM);
 691                                 add_relation(parent_key, ob_key, "Parent");
 692                         }
 693                         break;
 694                 }
 695         }
 696
 697         /* exception case: parent is duplivert */
 698         if ((object->type == OB_MBALL) && (object->parent->transflag & OB_DUPLIVERTS)) {
 699                 //dag_add_relation(dag, node2, node, DAG_RL_DATA_DATA | DAG_RL_OB_OB, "Duplivert");
 700         }
 701 }
 702
 703 void DepsgraphRelationBuilder::build_constraints(ID *id,
 704                                                  eDepsNode_Type component_type,
 705                                                  const char *component_subdata,
 706                                                  ListBase *constraints,
 707                                                  RootPChanMap *root_map)
 708 {
 709         OperationKey constraint_op_key(
 710                 id,
 711                 component_type,
 712                 component_subdata,
 713                 (component_type == DEG_NODE_TYPE_BONE)
 714                         ? DEG_OPCODE_BONE_CONSTRAINTS
 715                         : DEG_OPCODE_TRANSFORM_CONSTRAINTS);
 716         /* Add dependencies for each constraint in turn. */
 717         for (bConstraint *con = (bConstraint *)constraints->first; con; con = con->next) {
 718                 const bConstraintTypeInfo *cti = BKE_constraint_typeinfo_get(con);
 719                 /* Invalid constraint type. */
 720                 if (cti == NULL) {
 721                         continue;
 722                 }
 723                 /* Special case for camera tracking -- it doesn't use targets to
 724                  * define relations.
 725                  */
 726                 /* TODO: we can now represent dependencies in a much richer manner,
 727                  * so review how this is done.
 728                  */
 729                 if (ELEM(cti->type,
 730                          CONSTRAINT_TYPE_FOLLOWTRACK,
 731                          CONSTRAINT_TYPE_CAMERASOLVER,
 732                          CONSTRAINT_TYPE_OBJECTSOLVER))
 733                 {
 734                         bool depends_on_camera = false;
 735                         if (cti->type == CONSTRAINT_TYPE_FOLLOWTRACK) {
 736                                 bFollowTrackConstraint *data = (bFollowTrackConstraint *)con->data;
 737                                 if (((data->clip) ||
 738                                      (data->flag & FOLLOWTRACK_ACTIVECLIP)) && data->track[0])
 739                                 {
 740                                         depends_on_camera = true;
 741                                 }
 742                                 if (data->depth_ob) {
 743                                         ComponentKey depth_transform_key(&data->depth_ob->id,
 744                                                                          DEG_NODE_TYPE_TRANSFORM);
 745                                         ComponentKey depth_geometry_key(&data->depth_ob->id,
 746                                                                         DEG_NODE_TYPE_GEOMETRY);
 747                                         add_relation(depth_transform_key, constraint_op_key, cti->name);
 748                                         add_relation(depth_geometry_key, constraint_op_key, cti->name);
 749                                 }
 750                         }
 751                         else if (cti->type == CONSTRAINT_TYPE_OBJECTSOLVER) {
 752                                 depends_on_camera = true;
 753                         }
 754                         if (depends_on_camera && scene_->camera != NULL) {
 755                                 ComponentKey camera_key(&scene_->camera->id, DEG_NODE_TYPE_TRANSFORM);
 756                                 add_relation(camera_key, constraint_op_key, cti->name);
 757                         }
 758                         /* TODO(sergey): This is more a TimeSource -> MovieClip ->
 759                          * Constraint dependency chain.
 760                          */
 761                         TimeSourceKey time_src_key;
 762                         add_relation(time_src_key, constraint_op_key, "TimeSrc -> Animation");
 763                 }
 764                 else if (cti->type == CONSTRAINT_TYPE_TRANSFORM_CACHE) {
 765                         /* TODO(kevin): This is more a TimeSource -> CacheFile -> Constraint
 766                          * dependency chain.
 767                          */
 768                         TimeSourceKey time_src_key;
 769                         add_relation(time_src_key, constraint_op_key, "TimeSrc -> Animation");
 770                         bTransformCacheConstraint *data = (bTransformCacheConstraint *)con->data;
 771                         if (data->cache_file) {
 772                                 ComponentKey cache_key(&data->cache_file->id, DEG_NODE_TYPE_CACHE);
 773                                 add_relation(cache_key, constraint_op_key, cti->name);
 774                         }
 775                 }
 776                 else if (cti->get_constraint_targets) {
 777                         ListBase targets = {NULL, NULL};
 778                         cti->get_constraint_targets(con, &targets);
 779                         LINKLIST_FOREACH (bConstraintTarget *, ct, &targets) {
 780                                 if (ct->tar == NULL) {
 781                                         continue;
 782                                 }
 783                                 if (ELEM(con->type,
 784                                          CONSTRAINT_TYPE_KINEMATIC,
 785                                          CONSTRAINT_TYPE_SPLINEIK))
 786                                 {
 787                                         /* Ignore IK constraints - these are handled separately
 788                                          * (on pose level).
 789                                          */
 790                                 }
 791                                 else if (ELEM(con->type,
 792                                               CONSTRAINT_TYPE_FOLLOWPATH,
 793                                               CONSTRAINT_TYPE_CLAMPTO))
 794                                 {
 795                                         /* These constraints require path geometry data. */
 796                                         ComponentKey target_key(&ct->tar->id, DEG_NODE_TYPE_GEOMETRY);
 797                                         add_relation(target_key, constraint_op_key, cti->name);
 798                                         ComponentKey target_transform_key(&ct->tar->id,
 799                                                                           DEG_NODE_TYPE_TRANSFORM);
 800                                         add_relation(target_transform_key, constraint_op_key, cti->name);
 801                                 }
 802                                 else if ((ct->tar->type == OB_ARMATURE) && (ct->subtarget[0])) {
 803                                         /* bone */
 804                                         if (&ct->tar->id == id) {
 805                                                 /* same armature  */
 806                                                 eDepsOperation_Code target_key_opcode;
 807                                                 /* Using "done" here breaks in-chain deps, while using
 808                                                  * "ready" here breaks most production rigs instead.
 809                                                  * So, we do a compromise here, and only do this when an
 810                                                  * IK chain conflict may occur.
 811                                                  */
 812                                                 if (root_map->has_common_root(component_subdata,
 813                                                                               ct->subtarget))
 814                                                 {
 815                                                         target_key_opcode = DEG_OPCODE_BONE_READY;
 816                                                 }
 817                                                 else {
 818                                                         target_key_opcode = DEG_OPCODE_BONE_DONE;
 819                                                 }
 820                                                 OperationKey target_key(&ct->tar->id,
 821                                                                         DEG_NODE_TYPE_BONE,
 822                                                                         ct->subtarget,
 823                                                                         target_key_opcode);
 824                                                 add_relation(target_key, constraint_op_key, cti->name);
 825                                         }
 826                                         else {
 827                                                 /* Different armature - we can safely use the result
 828                                                  * of that.
 829                                                  */
 830                                                 OperationKey target_key(&ct->tar->id,
 831                                                                         DEG_NODE_TYPE_BONE,
 832                                                                         ct->subtarget,
 833                                                                         DEG_OPCODE_BONE_DONE);
 834                                                 add_relation(target_key, constraint_op_key, cti->name);
 835                                         }
 836                                 }
 837                                 else if (ELEM(ct->tar->type, OB_MESH, OB_LATTICE) &&
 838                                          (ct->subtarget[0]))
 839                                 {
 840                                         /* Vertex group. */
 841                                         /* NOTE: for now, we don't need to represent vertex groups
 842                                          * separately.
 843                                          */
 844                                         ComponentKey target_key(&ct->tar->id, DEG_NODE_TYPE_GEOMETRY);
 845                                         add_relation(target_key, constraint_op_key, cti->name);
 846                                         if (ct->tar->type == OB_MESH) {
 847                                                 OperationDepsNode *node2 = find_operation_node(target_key);
 848                                                 if (node2 != NULL) {
 849                                                         node2->customdata_mask |= CD_MASK_MDEFORMVERT;
 850                                                 }
 851                                         }
 852                                 }
 853                                 else if (con->type == CONSTRAINT_TYPE_SHRINKWRAP) {
 854                                         /* Constraints which requires the target object surface. */
 855                                         ComponentKey target_key(&ct->tar->id, DEG_NODE_TYPE_GEOMETRY);
 856                                         add_relation(target_key, constraint_op_key, cti->name);
 857                                         /* NOTE: obdata eval now doesn't necessarily depend on the
 858                                          * object's transform.
 859                                          */
 860                                         ComponentKey target_transform_key(&ct->tar->id,
 861                                                                           DEG_NODE_TYPE_TRANSFORM);
 862                                         add_relation(target_transform_key, constraint_op_key, cti->name);
 863                                 }
 864                                 else {
 865                                         /* Standard object relation. */
 866                                         // TODO: loc vs rot vs scale?
 867                                         if (&ct->tar->id == id) {
 868                                                 /* Constraint targetting own object:
 869                                                  * - This case is fine IFF we're dealing with a bone
 870                                                  *   constraint pointing to its own armature. In that
 871                                                  *   case, it's just transform -> bone.
 872                                                  * - If however it is a real self targetting case, just
 873                                                  *   make it depend on the previous constraint (or the
 874                                                  *   pre-constraint state).
 875                                                  */
 876                                                 if ((ct->tar->type == OB_ARMATURE) &&
 877                                                     (component_type == DEG_NODE_TYPE_BONE))
 878                                                 {
 879                                                         OperationKey target_key(&ct->tar->id,
 880                                                                                 DEG_NODE_TYPE_TRANSFORM,
 881                                                                                 DEG_OPCODE_TRANSFORM_FINAL);
 882                                                         add_relation(target_key, constraint_op_key, cti->name);
 883                                                 }
 884                                                 else {
 885                                                         OperationKey target_key(&ct->tar->id,
 886                                                                                 DEG_NODE_TYPE_TRANSFORM,
 887                                                                                 DEG_OPCODE_TRANSFORM_LOCAL);
 888                                                         add_relation(target_key, constraint_op_key, cti->name);
 889                                                 }
 890                                         }
 891                                         else {
 892                                                 /* Normal object dependency. */
 893                                                 OperationKey target_key(&ct->tar->id,
 894                                                                         DEG_NODE_TYPE_TRANSFORM,
 895                                                                         DEG_OPCODE_TRANSFORM_FINAL);
 896                                                 add_relation(target_key, constraint_op_key, cti->name);
 897                                         }
 898                                 }
 899                                 /* Constraints which needs world's matrix for transform.
 900                                  * TODO(sergey): More constraints here?
 901                                  */
 902                                 if (ELEM(con->type,
 903                                          CONSTRAINT_TYPE_ROTLIKE,
 904                                          CONSTRAINT_TYPE_SIZELIKE,
 905                                          CONSTRAINT_TYPE_LOCLIKE,
 906                                          CONSTRAINT_TYPE_TRANSLIKE))
 907                                 {
 908                                         /* TODO(sergey): Add used space check. */
 909                                         ComponentKey target_transform_key(&ct->tar->id,
 910                                                                           DEG_NODE_TYPE_TRANSFORM);
 911                                         add_relation(target_transform_key, constraint_op_key, cti->name);
 912                                 }
 913                         }
 914                         if (cti->flush_constraint_targets) {
 915                                 cti->flush_constraint_targets(con, &targets, 1);
 916                         }
 917                 }
 918         }
 919 }
 920
 921 void DepsgraphRelationBuilder::build_animdata(ID *id)
 922 {
 923         /* Animation curves and NLA. */
 924         build_animdata_curves(id);
 925         /* Drivers. */
 926         build_animdata_drievrs(id);
 927 }
 928
 929 void DepsgraphRelationBuilder::build_animdata_curves(ID *id)
 930 {
 931         AnimData *adt = BKE_animdata_from_id(id);
 932         if (adt == NULL) {
 933                 return;
 934         }
 935         if (adt->action == NULL && adt->nla_tracks.first == NULL) {
 936                 return;
 937         }
 938         /* Wire up dependency to time source. */
 939         ComponentKey adt_key(id, DEG_NODE_TYPE_ANIMATION);
 940         TimeSourceKey time_src_key;
 941         add_relation(time_src_key, adt_key, "TimeSrc -> Animation");
 942         /* Build relations from animation operation to properties it changes. */
 943         build_animdata_curves_targets(id);
 944 }
 945
 946 void DepsgraphRelationBuilder::build_animdata_curves_targets(ID *id)
 947 {
 948         AnimData *adt = BKE_animdata_from_id(id);
 949         if (adt == NULL || adt->action == NULL) {
 950                 return;
 951         }
 952         /* Get source operation. */
 953         ComponentKey adt_key(id, DEG_NODE_TYPE_ANIMATION);
 954         DepsNode *node_from = get_node(adt_key);
 955         BLI_assert(node_from != NULL);
 956         if (node_from == NULL) {
 957                 return;
 958         }
 959         OperationDepsNode *operation_from = node_from->get_exit_operation();
 960         BLI_assert(operation_from != NULL);
 961         /* Iterate over all curves and build relations. */
 962         PointerRNA id_ptr;
 963         RNA_id_pointer_create(id, &id_ptr);
 964         LINKLIST_FOREACH(FCurve *, fcu, &adt->action->curves) {
 965                 PointerRNA ptr;
 966                 PropertyRNA *prop;
 967                 int index;
 968                 if (!RNA_path_resolve_full(&id_ptr, fcu->rna_path,
 969                                            &ptr, &prop, &index))
 970                 {
 971                         continue;
 972                 }
 973                 DepsNode *node_to = graph_->find_node_from_pointer(&ptr, prop);
 974                 if (node_to == NULL) {
 975                         continue;
 976                 }
 977                 OperationDepsNode *operation_to = node_to->get_entry_operation();
 978                 /* NOTE: Special case for bones, avoid relation from animation to
 979                  * each of the bones. Bone evaluation could only start from pose
 980                  * init anyway.
 981                  */
 982                 if (operation_to->opcode == DEG_OPCODE_BONE_LOCAL) {
 983                         OperationKey pose_init_key(id,
 984                                                    DEG_NODE_TYPE_EVAL_POSE,
 985                                                    DEG_OPCODE_POSE_INIT);
 986                         add_relation(adt_key, pose_init_key, "Animation -> Prop", true);
 987                         continue;
 988                 }
 989                 graph_->add_new_relation(operation_from, operation_to,
 990                                          "Animation -> Prop",
 991                                          true);
 992         }
 993 }
 994
 995 void DepsgraphRelationBuilder::build_animdata_drievrs(ID *id)
 996 {
 997         AnimData *adt = BKE_animdata_from_id(id);
 998         if (adt == NULL) {
 999                 return;
1000         }
1001         ComponentKey adt_key(id, DEG_NODE_TYPE_ANIMATION);
1002         LINKLIST_FOREACH (FCurve *, fcu, &adt->drivers) {
1003                 OperationKey driver_key(id,
1004                                         DEG_NODE_TYPE_PARAMETERS,
1005                                         DEG_OPCODE_DRIVER,
1006                                         fcu->rna_path ? fcu->rna_path : "",
1007                                         fcu->array_index);
1008
1009                 /* create the driver's relations to targets */
1010                 build_driver(id, fcu);
1011
1012                 /* Special case for array drivers: we can not multithread them because
1013                  * of the way how they work internally: animation system will write the
1014                  * whole array back to RNA even when changing individual array value.
1015                  *
1016                  * Some tricky things here:
1017                  * - array_index is -1 for single channel drivers, meaning we only have
1018                  *   to do some magic when array_index is not -1.
1019                  * - We do relation from next array index to a previous one, so we don't
1020                  *   have to deal with array index 0.
1021                  *
1022                  * TODO(sergey): Avoid liner lookup somehow.
1023                  */
1024                 if (fcu->array_index > 0) {
1025                         FCurve *fcu_prev = NULL;
1026                         LINKLIST_FOREACH (FCurve *, fcu_candidate, &adt->drivers) {
1027                                 /* Writing to different RNA paths is  */
1028                                 const char *rna_path = fcu->rna_path ? fcu->rna_path : "";
1029                                 if (!STREQ(fcu_candidate->rna_path, rna_path)) {
1030                                         continue;
1031                                 }
1032                                 /* We only do relation from previous fcurve to previous one. */
1033                                 if (fcu_candidate->array_index >= fcu->array_index) {
1034                                         continue;
1035                                 }
1036                                 /* Choose fcurve with highest possible array index. */
1037                                 if (fcu_prev == NULL ||
1038                                     fcu_candidate->array_index > fcu_prev->array_index)
1039                                 {
1040                                         fcu_prev = fcu_candidate;
1041                                 }
1042                         }
1043                         if (fcu_prev != NULL) {
1044                                 OperationKey prev_driver_key(id,
1045                                                              DEG_NODE_TYPE_PARAMETERS,
1046                                                              DEG_OPCODE_DRIVER,
1047                                                              fcu_prev->rna_path ? fcu_prev->rna_path : "",
1048                                                              fcu_prev->array_index);
1049                                 OperationKey driver_key(id,
1050                                                         DEG_NODE_TYPE_PARAMETERS,
1051                                                         DEG_OPCODE_DRIVER,
1052                                                         fcu->rna_path ? fcu->rna_path : "",
1053                                                         fcu->array_index);
1054                                 add_relation(prev_driver_key, driver_key, "Driver Order");
1055                         }
1056                 }
1057
1058                 /* prevent driver from occurring before own animation... */
1059                 if (adt->action || adt->nla_tracks.first) {
1060                         add_relation(adt_key, driver_key, "AnimData Before Drivers");
1061                 }
1062         }
1063 }
1064
1065 void DepsgraphRelationBuilder::build_driver(ID *id, FCurve *fcu)
1066 {
1067         ChannelDriver *driver = fcu->driver;
1068         OperationKey driver_key(id,
1069                                 DEG_NODE_TYPE_PARAMETERS,
1070                                 DEG_OPCODE_DRIVER,
1071                                 fcu->rna_path ? fcu->rna_path : "",
1072                                 fcu->array_index);
1073         /* Driver -> data components (for interleaved evaluation
1074          * bones/constraints/modifiers).
1075          */
1076         build_driver_data(id, fcu);
1077         /* Loop over variables to get the target relationships. */
1078         build_driver_variables(id, fcu);
1079         /* It's quite tricky to detect if the driver actually depends on time or
1080          * not, so for now we'll be quite conservative here about optimization and
1081          * consider all python drivers to be depending on time.
1082          */
1083         if ((driver->type == DRIVER_TYPE_PYTHON) &&
1084             python_driver_depends_on_time(driver))
1085         {
1086                 TimeSourceKey time_src_key;
1087                 add_relation(time_src_key, driver_key, "TimeSrc -> Driver");
1088         }
1089 }
1090
1091 void DepsgraphRelationBuilder::build_driver_data(ID *id, FCurve *fcu)
1092 {
1093         OperationKey driver_key(id,
1094                                 DEG_NODE_TYPE_PARAMETERS,
1095                                 DEG_OPCODE_DRIVER,
1096                                 fcu->rna_path ? fcu->rna_path : "",
1097                                 fcu->array_index);
1098         const char *rna_path = fcu->rna_path ? fcu->rna_path : "";
1099         const RNAPathKey self_key(id, rna_path);
1100         if (GS(id->name) == ID_AR && strstr(rna_path, "bones[")) {
1101                 /* Drivers on armature-level bone settings (i.e. bbone stuff),
1102                  * which will affect the evaluation of corresponding pose bones.
1103                  */
1104                 IDDepsNode *arm_node = graph_->find_id_node(id);
1105                 char *bone_name = BLI_str_quoted_substrN(rna_path, "bones[");
1106                 if (arm_node != NULL && bone_name != NULL) {
1107                         /* Find objects which use this, and make their eval callbacks
1108                          * depend on this.
1109                          */
1110                         foreach (DepsRelation *rel, arm_node->outlinks) {
1111                                 IDDepsNode *to_node = (IDDepsNode *)rel->to;
1112                                 /* We only care about objects with pose data which use this. */
1113                                 if (GS(to_node->id_orig->name) == ID_OB) {
1114                                         Object *object = (Object *)to_node->id_orig;
1115                                         // NOTE: object->pose may be NULL
1116                                         bPoseChannel *pchan = BKE_pose_channel_find_name(object->pose,
1117                                                                                          bone_name);
1118                                         if (pchan != NULL) {
1119                                                 OperationKey bone_key(&object->id,
1120                                                                       DEG_NODE_TYPE_BONE,
1121                                                                       pchan->name,
1122                                                                       DEG_OPCODE_BONE_LOCAL);
1123                                                 add_relation(driver_key,
1124                                                              bone_key,
1125                                                              "Arm Bone -> Driver -> Bone");
1126                                         }
1127                                 }
1128                         }
1129                         /* Free temp data. */
1130                         MEM_freeN(bone_name);
1131                         bone_name = NULL;
1132                 }
1133                 else {
1134                         fprintf(stderr,
1135                                 "Couldn't find armature bone name for driver path - '%s'\n",
1136                                 rna_path);
1137                 }
1138         }
1139         else {
1140                 RNAPathKey target_key(id, rna_path);
1141                 add_relation(driver_key, target_key, "Driver -> Target");
1142         }
1143 }
1144
1145 void DepsgraphRelationBuilder::build_driver_variables(ID *id, FCurve *fcu)
1146 {
1147         ChannelDriver *driver = fcu->driver;
1148         OperationKey driver_key(id,
1149                                 DEG_NODE_TYPE_PARAMETERS,
1150                                 DEG_OPCODE_DRIVER,
1151                                 fcu->rna_path ? fcu->rna_path : "",
1152                                 fcu->array_index);
1153         const char *rna_path = fcu->rna_path ? fcu->rna_path : "";
1154         const RNAPathKey self_key(id, rna_path);
1155
1156         LINKLIST_FOREACH (DriverVar *, dvar, &driver->variables) {
1157                 /* Only used targets. */
1158                 DRIVER_TARGETS_USED_LOOPER(dvar)
1159                 {
1160                         if (dtar->id == NULL) {
1161                                 continue;
1162                         }
1163                         /* Special handling for directly-named bones. */
1164                         if ((dtar->flag & DTAR_FLAG_STRUCT_REF) &&
1165                             (((Object *)dtar->id)->type == OB_ARMATURE) &&
1166                             (dtar->pchan_name[0]))
1167                         {
1168                                 Object *object = (Object *)dtar->id;
1169                                 bPoseChannel *target_pchan =
1170                                         BKE_pose_channel_find_name(object->pose,
1171                                                                    dtar->pchan_name);
1172                                 if (target_pchan == NULL) {
1173                                         continue;
1174                                 }
1175                                 OperationKey variable_key(dtar->id,
1176                                                         DEG_NODE_TYPE_BONE,
1177                                                         target_pchan->name,
1178                                                         DEG_OPCODE_BONE_DONE);
1179                                 if (is_same_bone_dependency(variable_key, self_key)) {
1180                                         continue;
1181                                 }
1182                                 add_relation(variable_key, driver_key, "Bone Target -> Driver");
1183                         }
1184                         else if (dtar->flag & DTAR_FLAG_STRUCT_REF) {
1185                                 /* Get node associated with the object's transforms. */
1186                                 if (dtar->id == id) {
1187                                         /* Ignore input dependency if we're driving properties of
1188                                          * the same ID, otherwise we'll be ending up in a cyclic
1189                                          * dependency here.
1190                                          */
1191                                         continue;
1192                                 }
1193                                 OperationKey target_key(dtar->id,
1194                                                         DEG_NODE_TYPE_TRANSFORM,
1195                                                         DEG_OPCODE_TRANSFORM_FINAL);
1196                                 add_relation(target_key, driver_key, "Target -> Driver");
1197                         }
1198                         else if (dtar->rna_path) {
1199                                 RNAPathKey variable_key(dtar->id, dtar->rna_path);
1200                                 if (RNA_pointer_is_null(&variable_key.ptr)) {
1201                                         continue;
1202                                 }
1203                                 if (is_same_bone_dependency(variable_key, self_key)) {
1204                                         continue;
1205                                 }
1206                                 add_relation(variable_key, driver_key, "RNA Bone -> Driver");
1207                         }
1208                         else {
1209                                 if (dtar->id == id) {
1210                                         /* Ignore input dependency if we're driving properties of
1211                                          * the same ID, otherwise we'll be ending up in a cyclic
1212                                          * dependency here.
1213                                          */
1214                                         continue;
1215                                 }
1216                                 /* Resolve path to get node. */
1217                                 RNAPathKey target_key(dtar->id,
1218                                                       dtar->rna_path ? dtar->rna_path : "");
1219                                 add_relation(target_key, driver_key, "RNA Target -> Driver");
1220                         }
1221                 }
1222                 DRIVER_TARGETS_LOOPER_END
1223         }
1224 }
1225
1226 void DepsgraphRelationBuilder::build_world(World *world)
1227 {
1228         ID *world_id = &world->id;
1229         if (world_id->tag & LIB_TAG_DOIT) {
1230                 return;
1231         }
1232         world_id->tag |= LIB_TAG_DOIT;
1233
1234         build_animdata(world_id);
1235
1236         /* TODO: other settings? */
1237
1238         /* textures */
1239         build_texture_stack(world->mtex);
1240
1241         /* world's nodetree */
1242         if (world->nodetree != NULL) {
1243                 build_nodetree(world->nodetree);
1244                 ComponentKey ntree_key(&world->nodetree->id, DEG_NODE_TYPE_SHADING);
1245                 ComponentKey world_key(world_id, DEG_NODE_TYPE_SHADING);
1246                 add_relation(ntree_key, world_key, "NTree->World Shading Update");
1247         }
1248 }
1249
1250 void DepsgraphRelationBuilder::build_rigidbody(Scene *scene)
1251 {
1252         RigidBodyWorld *rbw = scene->rigidbody_world;
1253
1254         OperationKey init_key(&scene->id, DEG_NODE_TYPE_TRANSFORM, DEG_OPCODE_RIGIDBODY_REBUILD);
1255         OperationKey sim_key(&scene->id, DEG_NODE_TYPE_TRANSFORM, DEG_OPCODE_RIGIDBODY_SIM);
1256
1257         /* rel between the two sim-nodes */
1258         add_relation(init_key, sim_key, "Rigidbody [Init -> SimStep]");
1259
1260         /* set up dependencies between these operations and other builtin nodes --------------- */
1261
1262         /* time dependency */
1263         TimeSourceKey time_src_key;
1264         add_relation(time_src_key, init_key, "TimeSrc -> Rigidbody Reset/Rebuild (Optional)");
1265
1266         /* objects - simulation participants */
1267         if (rbw->group) {
1268                 LINKLIST_FOREACH (Base *, base, &rbw->group->view_layer->object_bases) {
1269                         Object *object = base->object;
1270                         if (object == NULL || object->type != OB_MESH) {
1271                                 continue;
1272                         }
1273
1274                         /* hook up evaluation order...
1275                          * 1) flushing rigidbody results follows base transforms being applied
1276                          * 2) rigidbody flushing can only be performed after simulation has been run
1277                          *
1278                          * 3) simulation needs to know base transforms to figure out what to do
1279                          *    XXX: there's probably a difference between passive and active
1280                          *         - passive don't change, so may need to know full transform...
1281                          */
1282                         OperationKey rbo_key(&object->id, DEG_NODE_TYPE_TRANSFORM, DEG_OPCODE_RIGIDBODY_TRANSFORM_COPY);
1283
1284                         eDepsOperation_Code trans_opcode = object->parent ? DEG_OPCODE_TRANSFORM_PARENT : DEG_OPCODE_TRANSFORM_LOCAL;
1285                         OperationKey trans_op(&object->id, DEG_NODE_TYPE_TRANSFORM, trans_opcode);
1286
1287                         add_relation(sim_key, rbo_key, "Rigidbody Sim Eval -> RBO Sync");
1288
1289                         /* if constraints exist, those depend on the result of the rigidbody sim
1290                          * - This allows constraints to modify the result of the sim (i.e. clamping)
1291                          *   while still allowing the sim to depend on some changes to the objects.
1292                          *   Also, since constraints are hooked up to the final nodes, this link
1293                          *   means that we can also fit in there too...
1294                          * - Later, it might be good to include a constraint in the stack allowing us
1295                          *   to control whether rigidbody eval gets interleaved into the constraint stack
1296                          */
1297                         if (object->constraints.first) {
1298                                 OperationKey constraint_key(&object->id,
1299                                                             DEG_NODE_TYPE_TRANSFORM,
1300                                                             DEG_OPCODE_TRANSFORM_CONSTRAINTS);
1301                                 add_relation(rbo_key, constraint_key, "RBO Sync -> Ob Constraints");
1302                         }
1303                         else {
1304                                 /* Final object transform depends on rigidbody.
1305                                  *
1306                                  * NOTE: Currently we consider final here an ubereval node.
1307                                  * If it is gone we'll need to reconsider relation here.
1308                                  */
1309                                 OperationKey uber_key(&object->id,
1310                                                       DEG_NODE_TYPE_TRANSFORM,
1311                                                       DEG_OPCODE_TRANSFORM_OBJECT_UBEREVAL);
1312                                 add_relation(rbo_key, uber_key, "RBO Sync -> Uber (Temp)");
1313                         }
1314
1315                         /* Needed to get correct base values. */
1316                         add_relation(trans_op, sim_key, "Base Ob Transform -> Rigidbody Sim Eval");
1317                 }
1318         }
1319
1320         /* constraints */
1321         if (rbw->constraints) {
1322                 LINKLIST_FOREACH (Base *, base, &rbw->constraints->view_layer->object_bases) {
1323                         Object *object = base->object;
1324                         if (object == NULL || !object->rigidbody_constraint) {
1325                                 continue;
1326                         }
1327
1328                         RigidBodyCon *rbc = object->rigidbody_constraint;
1329
1330                         /* final result of the constraint object's transform controls how the
1331                          * constraint affects the physics sim for these objects
1332                          */
1333                         ComponentKey trans_key(&object->id, DEG_NODE_TYPE_TRANSFORM);
1334                         OperationKey ob1_key(&rbc->ob1->id, DEG_NODE_TYPE_TRANSFORM, DEG_OPCODE_RIGIDBODY_TRANSFORM_COPY);
1335                         OperationKey ob2_key(&rbc->ob2->id, DEG_NODE_TYPE_TRANSFORM, DEG_OPCODE_RIGIDBODY_TRANSFORM_COPY);
1336
1337                         /* - constrained-objects sync depends on the constraint-holder */
1338                         add_relation(trans_key, ob1_key, "RigidBodyConstraint -> RBC.Object_1");
1339                         add_relation(trans_key, ob2_key, "RigidBodyConstraint -> RBC.Object_2");
1340
1341                         /* - ensure that sim depends on this constraint's transform */
1342                         add_relation(trans_key, sim_key, "RigidBodyConstraint Transform -> RB Simulation");
1343                 }
1344         }
1345 }
1346
1347 void DepsgraphRelationBuilder::build_particles(Object *object)
1348 {
1349         TimeSourceKey time_src_key;
1350         OperationKey obdata_ubereval_key(&object->id,
1351                                          DEG_NODE_TYPE_GEOMETRY,
1352                                          DEG_OPCODE_GEOMETRY_UBEREVAL);
1353         OperationKey eval_init_key(&object->id,
1354                                    DEG_NODE_TYPE_EVAL_PARTICLES,
1355                                    DEG_OPCODE_PARTICLE_SYSTEM_EVAL_INIT);
1356         if (object_particles_depends_on_time(object)) {
1357                 add_relation(time_src_key, eval_init_key, "TimeSrc -> PSys");
1358         }
1359
1360         /* particle systems */
1361         LINKLIST_FOREACH (ParticleSystem *, psys, &object->particlesystem) {
1362                 ParticleSettings *part = psys->part;
1363
1364                 /* Build particle settings relations.
1365                  *
1366                  * NOTE: The call itself ensures settings are only build once.
1367                  */
1368                 build_particle_settings(part);
1369
1370                 /* This particle system. */
1371                 OperationKey psys_key(&object->id,
1372                                       DEG_NODE_TYPE_EVAL_PARTICLES,
1373                                       DEG_OPCODE_PARTICLE_SYSTEM_EVAL,
1374                                       psys->name);
1375
1376                 /* Update particle system when settings changes. */
1377                 OperationKey particle_settings_key(&part->id,
1378                                                    DEG_NODE_TYPE_PARAMETERS,
1379                                                    DEG_OPCODE_PARTICLE_SETTINGS_EVAL);
1380                 OperationKey particle_settings_recalc_clear_key(
1381                         &part->id,
1382                         DEG_NODE_TYPE_PARAMETERS,
1383                         DEG_OPCODE_PARTICLE_SETTINGS_RECALC_CLEAR);
1384                 OperationKey psys_settings_key(&object->id,
1385                                                DEG_NODE_TYPE_EVAL_PARTICLES,
1386                                                DEG_OPCODE_PARTICLE_SETTINGS_EVAL,
1387                                                psys->name);
1388                 add_relation(particle_settings_key, psys_settings_key, "Particle Settings Change");
1389                 add_relation(psys_settings_key, psys_key, "Particle Settings Update");
1390                 add_relation(psys_key,
1391                              particle_settings_recalc_clear_key,
1392                              "Particle Settings Recalc Clear");
1393
1394                 /* XXX: if particle system is later re-enabled, we must do full rebuild? */
1395                 if (!psys_check_enabled(object, psys, G.is_rendering))
1396                         continue;
1397
1398                 add_relation(eval_init_key, psys_key, "Init -> PSys");
1399
1400                 /* TODO(sergey): Currently particle update is just a placeholder,
1401                  * hook it to the ubereval node so particle system is getting updated
1402                  * on playback.
1403                  */
1404                 add_relation(psys_key, obdata_ubereval_key, "PSys -> UberEval");
1405
1406                 /* collisions */
1407                 if (part->type != PART_HAIR) {
1408                         add_collision_relations(psys_key,
1409                                                 scene_,
1410                                                 object,
1411                                                 part->collision_group,
1412                                                 true,
1413                                                 "Particle Collision");
1414                 }
1415                 else if ((psys->flag & PSYS_HAIR_DYNAMICS) &&
1416                          psys->clmd != NULL &&
1417                          psys->clmd->coll_parms != NULL)
1418                 {
1419                         add_collision_relations(psys_key,
1420                                                 scene_,
1421                                                 object,
1422                                                 psys->clmd->coll_parms->group,
1423                                                 true,
1424                                                 "Hair Collision");
1425                 }
1426
1427                 /* effectors */
1428                 add_forcefield_relations(psys_key,
1429                                          scene_,
1430                                          object,
1431                                          psys,
1432                                          part->effector_weights,
1433                                          part->type == PART_HAIR,
1434                                          "Particle Field");
1435
1436                 /* boids */
1437                 if (part->boids) {
1438                         LINKLIST_FOREACH (BoidState *, state, &part->boids->states) {
1439                                 LINKLIST_FOREACH (BoidRule *, rule, &state->rules) {
1440                                         Object *ruleob = NULL;
1441                                         if (rule->type == eBoidRuleType_Avoid)
1442                                                 ruleob = ((BoidRuleGoalAvoid *)rule)->ob;
1443                                         else if (rule->type == eBoidRuleType_FollowLeader)
1444                                                 ruleob = ((BoidRuleFollowLeader *)rule)->ob;
1445
1446                                         if (ruleob) {
1447                                                 ComponentKey ruleob_key(&ruleob->id, DEG_NODE_TYPE_TRANSFORM);
1448                                                 add_relation(ruleob_key, psys_key, "Boid Rule");
1449                                         }
1450                                 }
1451                         }
1452                 }
1453
1454                 if (part->ren_as == PART_DRAW_OB && part->dup_ob) {
1455                         ComponentKey dup_ob_key(&part->dup_ob->id, DEG_NODE_TYPE_TRANSFORM);
1456                         add_relation(dup_ob_key, psys_key, "Particle Object Visualization");
1457                 }
1458         }
1459
1460         /* Particle depends on the object transform, so that channel is to be ready
1461          * first.
1462          *
1463          * TODO(sergey): This relation should be altered once real granular update
1464          * is implemented.
1465          */
1466         ComponentKey transform_key(&object->id, DEG_NODE_TYPE_TRANSFORM);
1467         add_relation(transform_key, obdata_ubereval_key, "Partcile Eval");
1468
1469         /* TODO(sergey): Do we need a point cache operations here? */
1470 }
1471
1472 void DepsgraphRelationBuilder::build_particle_settings(ParticleSettings *part)
1473 {
1474         ID *part_id = &part->id;
1475         if (part_id->tag & LIB_TAG_DOIT) {
1476                 return;
1477         }
1478         part_id->tag |= LIB_TAG_DOIT;
1479
1480         /* Animation data relations. */
1481         build_animdata(&part->id);
1482
1483         OperationKey eval_key(part_id,
1484                               DEG_NODE_TYPE_PARAMETERS,
1485                               DEG_OPCODE_PARTICLE_SETTINGS_EVAL);
1486         OperationKey recalc_clear_key(part_id,
1487                                      DEG_NODE_TYPE_PARAMETERS,
1488                                      DEG_OPCODE_PARTICLE_SETTINGS_RECALC_CLEAR);
1489         add_relation(eval_key, recalc_clear_key, "Particle Settings Clear Recalc");
1490 }
1491
1492 void DepsgraphRelationBuilder::build_cloth(Object *object,
1493                                            ModifierData * /*md*/)
1494 {
1495         OperationKey cache_key(&object->id,
1496                                DEG_NODE_TYPE_CACHE,
1497                                DEG_OPCODE_GEOMETRY_CLOTH_MODIFIER);
1498         /* Cache component affects on modifier. */
1499         OperationKey modifier_key(&object->id,
1500                                   DEG_NODE_TYPE_GEOMETRY,
1501                                   DEG_OPCODE_GEOMETRY_UBEREVAL);
1502         add_relation(cache_key, modifier_key, "Cloth Cache -> Cloth");
1503 }
1504
1505 /* Shapekeys */
1506 void DepsgraphRelationBuilder::build_shapekeys(ID *obdata, Key *key)
1507 {
1508         ComponentKey obdata_key(obdata, DEG_NODE_TYPE_GEOMETRY);
1509
1510         /* attach animdata to geometry */
1511         build_animdata(&key->id);
1512
1513         if (key->adt) {
1514                 // TODO: this should really be handled in build_animdata, since many of these cases will need it
1515                 if (key->adt->action || key->adt->nla_tracks.first) {
1516                         ComponentKey adt_key(&key->id, DEG_NODE_TYPE_ANIMATION);
1517                         add_relation(adt_key, obdata_key, "Animation");
1518                 }
1519
1520                 /* NOTE: individual shapekey drivers are handled above already */
1521         }
1522
1523         /* attach to geometry */
1524         // XXX: aren't shapekeys now done as a pseudo-modifier on object?
1525         //ComponentKey key_key(&key->id, DEG_NODE_TYPE_GEOMETRY); // FIXME: this doesn't exist
1526         //add_relation(key_key, obdata_key, "Shapekeys");
1527 }
1528
1529 /**
1530  * ObData Geometry Evaluation
1531  * ==========================
1532  *
1533  * The evaluation of geometry on objects is as follows:
1534  * - The actual evaluated of the derived geometry (e.g. DerivedMesh, DispList, etc.)
1535  *   occurs in the Geometry component of the object which references this. This includes
1536  *   modifiers, and the temporary "ubereval" for geometry.
1537  * - Therefore, each user of a piece of shared geometry data ends up evaluating its own
1538  *   version of the stuff, complete with whatever modifiers it may use.
1539  *
1540  * - The datablocks for the geometry data - "obdata" (e.g. ID_ME, ID_CU, ID_LT, etc.) are used for
1541  *     1) calculating the bounding boxes of the geometry data,
1542  *     2) aggregating inward links from other objects (e.g. for text on curve, etc.)
1543  *        and also for the links coming from the shapekey datablocks
1544  * - Animation/Drivers affecting the parameters of the geometry are made to trigger
1545  *   updates on the obdata geometry component, which then trigger downstream
1546  *   re-evaluation of the individual instances of this geometry.
1547  */
1548 // TODO: Materials and lighting should probably get their own component, instead of being lumped under geometry?
1549 void DepsgraphRelationBuilder::build_obdata_geom(Object *object)
1550 {
1551         ID *obdata = (ID *)object->data;
1552
1553         /* Init operation of object-level geometry evaluation. */
1554         OperationKey geom_init_key(&object->id, DEG_NODE_TYPE_GEOMETRY, DEG_OPCODE_PLACEHOLDER, "Eval Init");
1555
1556         /* get nodes for result of obdata's evaluation, and geometry evaluation on object */
1557         ComponentKey obdata_geom_key(obdata, DEG_NODE_TYPE_GEOMETRY);
1558         ComponentKey geom_key(&object->id, DEG_NODE_TYPE_GEOMETRY);
1559
1560         /* link components to each other */
1561         add_relation(obdata_geom_key, geom_key, "Object Geometry Base Data");
1562
1563         OperationKey obdata_ubereval_key(&object->id,
1564                                          DEG_NODE_TYPE_GEOMETRY,
1565                                          DEG_OPCODE_GEOMETRY_UBEREVAL);
1566
1567         /* Special case: modifiers and DerivedMesh creation queries scene for various
1568          * things like data mask to be used. We add relation here to ensure object is
1569          * never evaluated prior to Scene's CoW is ready.
1570          */
1571         OperationKey scene_key(&scene_->id,
1572                                DEG_NODE_TYPE_PARAMETERS,
1573                                DEG_OPCODE_PLACEHOLDER,
1574                                "Scene Eval");
1575         add_relation(scene_key, obdata_ubereval_key, "CoW Relation");
1576
1577         /* Modifiers */
1578         if (object->modifiers.first != NULL) {
1579                 LINKLIST_FOREACH (ModifierData *, md, &object->modifiers) {
1580                         const ModifierTypeInfo *mti = modifierType_getInfo((ModifierType)md->type);
1581                         if (mti->updateDepsgraph) {
1582                                 DepsNodeHandle handle = create_node_handle(obdata_ubereval_key);
1583                                 mti->updateDepsgraph(
1584                                         md,
1585                                         bmain_,
1586                                         scene_,
1587                                         object,
1588                                         reinterpret_cast< ::DepsNodeHandle* >(&handle));
1589                         }
1590                         if (BKE_object_modifier_use_time(object, md)) {
1591                                 TimeSourceKey time_src_key;
1592                                 add_relation(time_src_key, obdata_ubereval_key, "Time Source");
1593                         }
1594                         if (md->type == eModifierType_Cloth) {
1595                                 build_cloth(object, md);
1596                         }
1597                 }
1598         }
1599
1600         /* materials */
1601         if (object->totcol) {
1602                 for (int a = 1; a <= object->totcol; a++) {
1603                         Material *ma = give_current_material(object, a);
1604                         if (ma != NULL) {
1605                                 build_material(ma);
1606
1607                                 if (object->type == OB_MESH) {
1608                                         OperationKey material_key(&ma->id,
1609                                                                   DEG_NODE_TYPE_SHADING,
1610                                                                   DEG_OPCODE_MATERIAL_UPDATE);
1611                                         OperationKey shading_key(&object->id, DEG_NODE_TYPE_SHADING, DEG_OPCODE_SHADING);
1612                                         add_relation(material_key, shading_key, "Material Update");
1613                                 }
1614                         }
1615                 }
1616         }
1617
1618         /* geometry collision */
1619         if (ELEM(object->type, OB_MESH, OB_CURVE, OB_LATTICE)) {
1620                 // add geometry collider relations
1621         }
1622
1623         /* Make sure uber update is the last in the dependencies.
1624          *
1625          * TODO(sergey): Get rid of this node.
1626          */
1627         if (object->type != OB_ARMATURE) {
1628                 /* Armatures does no longer require uber node. */
1629                 OperationKey obdata_ubereval_key(&object->id, DEG_NODE_TYPE_GEOMETRY, DEG_OPCODE_GEOMETRY_UBEREVAL);
1630                 add_relation(geom_init_key, obdata_ubereval_key, "Object Geometry UberEval");
1631         }
1632
1633         if (obdata->tag & LIB_TAG_DOIT) {
1634                 return;
1635         }
1636         obdata->tag |= LIB_TAG_DOIT;
1637
1638         /* Link object data evaluation node to exit operation. */
1639         OperationKey obdata_geom_eval_key(obdata, DEG_NODE_TYPE_GEOMETRY, DEG_OPCODE_PLACEHOLDER, "Geometry Eval");
1640         OperationKey obdata_geom_done_key(obdata, DEG_NODE_TYPE_GEOMETRY, DEG_OPCODE_PLACEHOLDER, "Eval Done");
1641         add_relation(obdata_geom_eval_key, obdata_geom_done_key, "ObData Geom Eval Done");
1642
1643         /* type-specific node/links */
1644         switch (object->type) {
1645                 case OB_MESH:
1646                         /* NOTE: This is compatibility code to support particle systems
1647                          *
1648                          * for viewport being properly rendered in final render mode.
1649                          * This relation is similar to what dag_object_time_update_flags()
1650                          * was doing for mesh objects with particle system.
1651                          *
1652                          * Ideally we need to get rid of this relation.
1653                          */
1654                         if (object_particles_depends_on_time(object)) {
1655                                 TimeSourceKey time_key;
1656                                 OperationKey obdata_ubereval_key(&object->id,
1657                                                                  DEG_NODE_TYPE_GEOMETRY,
1658                                                                  DEG_OPCODE_GEOMETRY_UBEREVAL);
1659                                 add_relation(time_key, obdata_ubereval_key, "Legacy particle time");
1660                         }
1661                         break;
1662
1663                 case OB_MBALL:
1664                 {
1665                         Object *mom = BKE_mball_basis_find(scene_, object);
1666                         ComponentKey mom_geom_key(&mom->id, DEG_NODE_TYPE_GEOMETRY);
1667                         /* motherball - mom depends on children! */
1668                         if (mom == object) {
1669                                 ComponentKey mom_transform_key(&mom->id,
1670                                                                DEG_NODE_TYPE_TRANSFORM);
1671                                 add_relation(mom_transform_key,
1672                                              mom_geom_key,
1673                                              "Metaball Motherball Transform -> Geometry");
1674                         }
1675                         else {
1676                                 ComponentKey transform_key(&object->id, DEG_NODE_TYPE_TRANSFORM);
1677                                 add_relation(geom_key, mom_geom_key, "Metaball Motherball");
1678                                 add_relation(transform_key, mom_geom_key, "Metaball Motherball");
1679                         }
1680                         break;
1681                 }
1682
1683                 case OB_CURVE:
1684                 case OB_FONT:
1685                 {
1686                         Curve *cu = (Curve *)obdata;
1687
1688                         /* curve's dependencies */
1689                         // XXX: these needs geom data, but where is geom stored?
1690                         if (cu->bevobj) {
1691                                 ComponentKey bevob_key(&cu->bevobj->id, DEG_NODE_TYPE_GEOMETRY);
1692                                 build_object(NULL, cu->bevobj);
1693                                 add_relation(bevob_key, geom_key, "Curve Bevel");
1694                         }
1695                         if (cu->taperobj) {
1696                                 ComponentKey taperob_key(&cu->taperobj->id, DEG_NODE_TYPE_GEOMETRY);
1697                                 build_object(NULL, cu->taperobj);
1698                                 add_relation(taperob_key, geom_key, "Curve Taper");
1699                         }
1700                         if (object->type == OB_FONT) {
1701                                 if (cu->textoncurve) {
1702                                         ComponentKey textoncurve_key(&cu->textoncurve->id, DEG_NODE_TYPE_GEOMETRY);
1703                                         build_object(NULL, cu->textoncurve);
1704                                         add_relation(textoncurve_key, geom_key, "Text on Curve");
1705                                 }
1706                         }
1707                         break;
1708                 }
1709
1710                 case OB_SURF: /* Nurbs Surface */
1711                 {
1712                         break;
1713                 }
1714
1715                 case OB_LATTICE: /* Lattice */
1716                 {
1717                         break;
1718                 }
1719         }
1720
1721         /* ShapeKeys */
1722         Key *key = BKE_key_from_object(object);
1723         if (key) {
1724                 build_shapekeys(obdata, key);
1725         }
1726 }
1727
1728 /* Cameras */
1729 // TODO: Link scene-camera links in somehow...
1730 void DepsgraphRelationBuilder::build_camera(Object *object)
1731 {
1732         Camera *cam = (Camera *)object->data;
1733         ID *camera_id = &cam->id;
1734         if (camera_id->tag & LIB_TAG_DOIT) {
1735                 return;
1736         }
1737         camera_id->tag |= LIB_TAG_DOIT;
1738
1739         ComponentKey object_parameters_key(&object->id, DEG_NODE_TYPE_PARAMETERS);
1740         ComponentKey camera_parameters_key(camera_id, DEG_NODE_TYPE_PARAMETERS);
1741
1742         add_relation(camera_parameters_key, object_parameters_key,
1743                      "Camera -> Object");
1744
1745         /* DOF */
1746         if (cam->dof_ob != NULL) {
1747                 ComponentKey dof_ob_key(&cam->dof_ob->id, DEG_NODE_TYPE_TRANSFORM);
1748                 add_relation(dof_ob_key, object_parameters_key, "Camera DOF");
1749         }
1750 }
1751
1752 /* Lamps */
1753 void DepsgraphRelationBuilder::build_lamp(Object *object)
1754 {
1755         Lamp *la = (Lamp *)object->data;
1756         ID *lamp_id = &la->id;
1757         if (lamp_id->tag & LIB_TAG_DOIT) {
1758                 return;
1759         }
1760         lamp_id->tag |= LIB_TAG_DOIT;
1761
1762         ComponentKey object_parameters_key(&object->id, DEG_NODE_TYPE_PARAMETERS);
1763         ComponentKey lamp_parameters_key(lamp_id, DEG_NODE_TYPE_PARAMETERS);
1764
1765         add_relation(lamp_parameters_key, object_parameters_key,
1766                      "Lamp -> Object");
1767
1768         /* lamp's nodetree */
1769         if (la->nodetree != NULL) {
1770                 build_nodetree(la->nodetree);
1771                 ComponentKey nodetree_key(&la->nodetree->id, DEG_NODE_TYPE_SHADING);
1772                 add_relation(nodetree_key, lamp_parameters_key, "NTree->Lamp Parameters");
1773         }
1774         /* textures */
1775         build_texture_stack(la->mtex);
1776
1777         if (DEG_depsgraph_use_copy_on_write()) {
1778                 /* Make sure copy on write of lamp data is always properly updated for
1779                  * visible lamps.
1780                  */
1781                 OperationKey ob_copy_on_write_key(&object->id,
1782                                                   DEG_NODE_TYPE_COPY_ON_WRITE,
1783                                                   DEG_OPCODE_COPY_ON_WRITE);
1784                 OperationKey lamp_copy_on_write_key(lamp_id,
1785                                                     DEG_NODE_TYPE_COPY_ON_WRITE,
1786                                                     DEG_OPCODE_COPY_ON_WRITE);
1787                 add_relation(lamp_copy_on_write_key, ob_copy_on_write_key, "Eval Order");
1788         }
1789 }
1790
1791 void DepsgraphRelationBuilder::build_nodetree(bNodeTree *ntree)
1792 {
1793         if (ntree == NULL) {
1794                 return;
1795         }
1796         ID *ntree_id = &ntree->id;
1797         build_animdata(ntree_id);
1798         ComponentKey shading_key(ntree_id, DEG_NODE_TYPE_SHADING);
1799         /* nodetree's nodes... */
1800         LINKLIST_FOREACH (bNode *, bnode, &ntree->nodes) {
1801                 ID *id = bnode->id;
1802                 if (id == NULL) {
1803                         continue;
1804                 }
1805                 ID_Type id_type = GS(id->name);
1806                 if (id_type == ID_MA) {
1807                         build_material((Material *)bnode->id);
1808                 }
1809                 else if (id_type == ID_TE) {
1810                         build_texture((Tex *)bnode->id);
1811                 }
1812                 else if (id_type == ID_IM) {
1813                         /* nothing for now. */
1814                 }
1815                 else if (id_type == ID_OB) {
1816                         build_object(NULL, (Object *)id);
1817                 }
1818                 else if (id_type == ID_SCE) {
1819                         /* Scenes are used by compositor trees, and handled by render
1820                          * pipeline. No need to build dependencies for them here.
1821                          */
1822                 }
1823                 else if (id_type == ID_TXT) {
1824                         /* Ignore script nodes. */
1825                 }
1826                 else if (bnode->type == NODE_GROUP) {
1827                         bNodeTree *group_ntree = (bNodeTree *)id;
1828                         if ((group_ntree->id.tag & LIB_TAG_DOIT) == 0) {
1829                                 build_nodetree(group_ntree);
1830                                 group_ntree->id.tag |= LIB_TAG_DOIT;
1831                         }
1832                         ComponentKey group_shading_key(&group_ntree->id,
1833                                                        DEG_NODE_TYPE_SHADING);
1834                         add_relation(group_shading_key, shading_key, "Group Node");
1835                 }
1836                 else {
1837                         BLI_assert(!"Unknown ID type used for node");
1838                 }
1839         }
1840
1841         OperationKey shading_update_key(ntree_id,
1842                                         DEG_NODE_TYPE_SHADING,
1843                                         DEG_OPCODE_MATERIAL_UPDATE);
1844         OperationKey shading_parameters_key(ntree_id,
1845                                             DEG_NODE_TYPE_SHADING_PARAMETERS,
1846                                             DEG_OPCODE_MATERIAL_UPDATE);
1847         add_relation(shading_parameters_key, shading_update_key, "NTree Shading Parameters");
1848 }
1849
1850 /* Recursively build graph for material */
1851 void DepsgraphRelationBuilder::build_material(Material *ma)
1852 {
1853         ID *ma_id = &ma->id;
1854         if (ma_id->tag & LIB_TAG_DOIT) {
1855                 return;
1856         }
1857         ma_id->tag |= LIB_TAG_DOIT;
1858
1859         /* animation */
1860         build_animdata(ma_id);
1861
1862         /* textures */
1863         build_texture_stack(ma->mtex);
1864
1865         /* material's nodetree */
1866         if (ma->nodetree != NULL) {
1867                 build_nodetree(ma->nodetree);
1868                 OperationKey ntree_key(&ma->nodetree->id,
1869                                        DEG_NODE_TYPE_SHADING,
1870                                        DEG_OPCODE_MATERIAL_UPDATE);
1871                 OperationKey material_key(&ma->id,
1872                                           DEG_NODE_TYPE_SHADING,
1873                                           DEG_OPCODE_MATERIAL_UPDATE);
1874                 add_relation(ntree_key, material_key, "Material's NTree");
1875         }
1876 }
1877
1878 /* Recursively build graph for texture */
1879 void DepsgraphRelationBuilder::build_texture(Tex *tex)
1880 {
1881         ID *tex_id = &tex->id;
1882         if (tex_id->tag & LIB_TAG_DOIT) {
1883                 return;
1884         }
1885         tex_id->tag |= LIB_TAG_DOIT;
1886
1887         /* texture itself */
1888         build_animdata(tex_id);
1889
1890         /* texture's nodetree */
1891         build_nodetree(tex->nodetree);
1892 }
1893
1894 /* Texture-stack attached to some shading datablock */
1895 void DepsgraphRelationBuilder::build_texture_stack(MTex **texture_stack)
1896 {
1897         int i;
1898
1899         /* for now assume that all texture-stacks have same number of max items */
1900         for (i = 0; i < MAX_MTEX; i++) {
1901                 MTex *mtex = texture_stack[i];
1902                 if (mtex && mtex->tex)
1903                         build_texture(mtex->tex);
1904         }
1905 }
1906
1907 void DepsgraphRelationBuilder::build_compositor(Scene *scene)
1908 {
1909         /* For now, just a plain wrapper? */
1910         build_nodetree(scene->nodetree);
1911 }
1912
1913 void DepsgraphRelationBuilder::build_gpencil(bGPdata *gpd)
1914 {
1915         /* animation */
1916         build_animdata(&gpd->id);
1917
1918         // TODO: parent object (when that feature is implemented)
1919 }
1920
1921 void DepsgraphRelationBuilder::build_cachefile(CacheFile *cache_file) {
1922         /* Animation. */
1923         build_animdata(&cache_file->id);
1924 }
1925
1926 void DepsgraphRelationBuilder::build_mask(Mask *mask)
1927 {
1928         ID *mask_id = &mask->id;
1929         /* F-Curve animation. */
1930         build_animdata(mask_id);
1931         /* Own mask animation. */
1932         OperationKey mask_animation_key(mask_id,
1933                                         DEG_NODE_TYPE_ANIMATION,
1934                                         DEG_OPCODE_MASK_ANIMATION);
1935         TimeSourceKey time_src_key;
1936         add_relation(time_src_key, mask_animation_key, "TimeSrc -> Mask Animation");
1937         /* Final mask evaluation. */
1938         ComponentKey parameters_key(mask_id, DEG_NODE_TYPE_PARAMETERS);
1939         add_relation(mask_animation_key, parameters_key, "Mask Animation -> Mask Eval");
1940 }
1941
1942 void DepsgraphRelationBuilder::build_movieclip(MovieClip *clip)
1943 {
1944         /* Animation. */
1945         build_animdata(&clip->id);
1946 }
1947
1948 void DepsgraphRelationBuilder::build_lightprobe(Object *object)
1949 {
1950         LightProbe *probe = (LightProbe *)object->data;
1951         ID *probe_id = &probe->id;
1952         if (probe_id->tag & LIB_TAG_DOIT) {
1953                 return;
1954         }
1955         probe_id->tag |= LIB_TAG_DOIT;
1956         build_animdata(&probe->id);
1957
1958         OperationKey probe_key(probe_id,
1959                                DEG_NODE_TYPE_PARAMETERS,
1960                                DEG_OPCODE_PLACEHOLDER,
1961                                "LightProbe Eval");
1962         OperationKey object_key(&object->id,
1963                                 DEG_NODE_TYPE_PARAMETERS,
1964                                 DEG_OPCODE_PLACEHOLDER,
1965                                 "LightProbe Eval");
1966         add_relation(probe_key, object_key, "LightProbe Update");
1967 }
1968
1969 void DepsgraphRelationBuilder::build_copy_on_write_relations()
1970 {
1971         foreach (IDDepsNode *id_node, graph_->id_nodes) {
1972                 build_copy_on_write_relations(id_node);
1973         }
1974 }
1975
1976 void DepsgraphRelationBuilder::build_copy_on_write_relations(IDDepsNode *id_node)
1977 {
1978         ID *id_orig = id_node->id_orig;
1979
1980         TimeSourceKey time_source_key;
1981         OperationKey copy_on_write_key(id_orig,
1982                                        DEG_NODE_TYPE_COPY_ON_WRITE,
1983                                        DEG_OPCODE_COPY_ON_WRITE);
1984         /* XXX: This is a quick hack to make Alt-A to work. */
1985         // add_relation(time_source_key, copy_on_write_key, "Fluxgate capacitor hack");
1986         /* Resat of code is using rather low level trickery, so need to get some
1987          * explicit pointers.
1988          */
1989         DepsNode *node_cow = find_node(copy_on_write_key);
1990         OperationDepsNode *op_cow = node_cow->get_exit_operation();
1991         /* Plug any other components to this one. */
1992         GHASH_FOREACH_BEGIN(ComponentDepsNode *, comp_node, id_node->components)
1993         {
1994                 if (comp_node->type == DEG_NODE_TYPE_COPY_ON_WRITE) {
1995                         /* Copy-on-write component never depends on itself. */
1996                         continue;
1997                 }
1998                 if (!comp_node->depends_on_cow()) {
1999                         /* Component explicitly requests to not add relation. */
2000                         continue;
2001                 }
2002                 /* All entry operations of each component should wait for a proper
2003                  * copy of ID.
2004                  */
2005                 OperationDepsNode *op_entry = comp_node->get_entry_operation();
2006                 if (op_entry != NULL) {
2007                         graph_->add_new_relation(op_cow, op_entry, "CoW Dependency");
2008                 }
2009                 /* All dangling operations should also be executed after copy-on-write. */
2010                 GHASH_FOREACH_BEGIN(OperationDepsNode *, op_node, comp_node->operations_map)
2011                 {
2012                         if (op_node->inlinks.size() == 0) {
2013                                 graph_->add_new_relation(op_cow, op_node, "CoW Dependency");
2014                         }
2015                 }
2016                 GHASH_FOREACH_END();
2017                 /* NOTE: We currently ignore implicit relations to an external
2018                  * datablocks for copy-on-write operations. This means, for example,
2019                  * copy-on-write component of Object will not wait for copy-on-write
2020                  * component of it's Mesh. This is because pointers are all known
2021                  * already so remapping will happen all correct. And then If some object
2022                  * evaluation step needs geometry, it will have transitive dependency
2023                  * to Mesh copy-on-write already.
2024                  */
2025         }
2026         GHASH_FOREACH_END();
2027         /* TODO(sergey): This solves crash for now, but causes too many
2028          * updates potentially.
2029          */
2030         if (GS(id_orig->name) == ID_OB) {
2031                 Object *object = (Object *)id_orig;
2032                 ID *object_data_id = (ID *)object->data;
2033                 if (object_data_id != NULL) {
2034                         OperationKey data_copy_on_write_key(object_data_id,
2035                                                             DEG_NODE_TYPE_COPY_ON_WRITE,
2036                                                             DEG_OPCODE_COPY_ON_WRITE);
2037                         add_relation(data_copy_on_write_key, copy_on_write_key, "Eval Order");
2038                 }
2039                 else {
2040                         BLI_assert(object->type == OB_EMPTY);
2041                 }
2042         }
2043 }
2044
2045 }  // namespace DEG