81a63153d0
The depsgraph CoW mechanism is a bit of a misnomer. It creates an evaluated copy for data-blocks regardless of whether the copy will actually be written to. The point is to have physical separation between original and evaluated data. This is in contrast to the commonly used performance improvement of keeping a user count and copying data implicitly when it needs to be changed. In Blender code we call this "implicit sharing" instead. Importantly, the dependency graph has no idea about the _actual_ CoW behavior in Blender. Renaming this functionality in the despgraph removes some of the confusion that comes up when talking about this, and will hopefully make the depsgraph less confusing to understand initially too. Wording like "the evaluated copy" (as opposed to the original data-block) has also become common anyway. Pull Request: https://projects.blender.org/blender/blender/pulls/118338
283 lines
8.8 KiB
C++
283 lines
8.8 KiB
C++
/* SPDX-FileCopyrightText: 2013 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup depsgraph
|
|
*/
|
|
|
|
#include "intern/node/deg_node_operation.hh"
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "intern/depsgraph.hh"
|
|
#include "intern/node/deg_node_component.hh"
|
|
#include "intern/node/deg_node_factory.hh"
|
|
#include "intern/node/deg_node_id.hh"
|
|
|
|
namespace blender::deg {
|
|
|
|
const char *operationCodeAsString(OperationCode opcode)
|
|
{
|
|
switch (opcode) {
|
|
/* Generic Operations. */
|
|
case OperationCode::OPERATION:
|
|
return "OPERATION";
|
|
case OperationCode::ID_PROPERTY:
|
|
return "ID_PROPERTY";
|
|
case OperationCode::PARAMETERS_ENTRY:
|
|
return "PARAMETERS_ENTRY";
|
|
case OperationCode::PARAMETERS_EVAL:
|
|
return "PARAMETERS_EVAL";
|
|
case OperationCode::PARAMETERS_EXIT:
|
|
return "PARAMETERS_EXIT";
|
|
case OperationCode::VISIBILITY:
|
|
return "VISIBILITY";
|
|
/* Hierarchy. */
|
|
case OperationCode::HIERARCHY:
|
|
return "HIERARCHY";
|
|
/* Animation, Drivers, etc. */
|
|
case OperationCode::ANIMATION_ENTRY:
|
|
return "ANIMATION_ENTRY";
|
|
case OperationCode::ANIMATION_EVAL:
|
|
return "ANIMATION_EVAL";
|
|
case OperationCode::ANIMATION_EXIT:
|
|
return "ANIMATION_EXIT";
|
|
case OperationCode::DRIVER:
|
|
return "DRIVER";
|
|
/* Scene related. */
|
|
case OperationCode::SCENE_EVAL:
|
|
return "SCENE_EVAL";
|
|
case OperationCode::AUDIO_ENTRY:
|
|
return "AUDIO_ENTRY";
|
|
case OperationCode::AUDIO_VOLUME:
|
|
return "AUDIO_VOLUME";
|
|
/* Object related. */
|
|
case OperationCode::OBJECT_FROM_LAYER_ENTRY:
|
|
return "OBJECT_FROM_LAYER_ENTRY";
|
|
case OperationCode::OBJECT_BASE_FLAGS:
|
|
return "OBJECT_BASE_FLAGS";
|
|
case OperationCode::OBJECT_FROM_LAYER_EXIT:
|
|
return "OBJECT_FROM_LAYER_EXIT";
|
|
case OperationCode::DIMENSIONS:
|
|
return "DIMENSIONS";
|
|
/* Transform. */
|
|
case OperationCode::TRANSFORM_INIT:
|
|
return "TRANSFORM_INIT";
|
|
case OperationCode::TRANSFORM_LOCAL:
|
|
return "TRANSFORM_LOCAL";
|
|
case OperationCode::TRANSFORM_PARENT:
|
|
return "TRANSFORM_PARENT";
|
|
case OperationCode::TRANSFORM_CONSTRAINTS:
|
|
return "TRANSFORM_CONSTRAINTS";
|
|
case OperationCode::TRANSFORM_FINAL:
|
|
return "TRANSFORM_FINAL";
|
|
case OperationCode::TRANSFORM_EVAL:
|
|
return "TRANSFORM_EVAL";
|
|
case OperationCode::TRANSFORM_SIMULATION_INIT:
|
|
return "TRANSFORM_SIMULATION_INIT";
|
|
/* Rigid body. */
|
|
case OperationCode::RIGIDBODY_REBUILD:
|
|
return "RIGIDBODY_REBUILD";
|
|
case OperationCode::RIGIDBODY_SIM:
|
|
return "RIGIDBODY_SIM";
|
|
case OperationCode::RIGIDBODY_TRANSFORM_COPY:
|
|
return "RIGIDBODY_TRANSFORM_COPY";
|
|
/* Geometry. */
|
|
case OperationCode::GEOMETRY_EVAL_INIT:
|
|
return "GEOMETRY_EVAL_INIT";
|
|
case OperationCode::MODIFIER:
|
|
return "MODIFIER";
|
|
case OperationCode::GEOMETRY_EVAL:
|
|
return "GEOMETRY_EVAL";
|
|
case OperationCode::GEOMETRY_EVAL_DONE:
|
|
return "GEOMETRY_EVAL_DONE";
|
|
case OperationCode::GEOMETRY_SHAPEKEY:
|
|
return "GEOMETRY_SHAPEKEY";
|
|
/* Object data. */
|
|
case OperationCode::LIGHT_PROBE_EVAL:
|
|
return "LIGHT_PROBE_EVAL";
|
|
case OperationCode::SPEAKER_EVAL:
|
|
return "SPEAKER_EVAL";
|
|
case OperationCode::SOUND_EVAL:
|
|
return "SOUND_EVAL";
|
|
case OperationCode::ARMATURE_EVAL:
|
|
return "ARMATURE_EVAL";
|
|
/* Pose. */
|
|
case OperationCode::POSE_INIT:
|
|
return "POSE_INIT";
|
|
case OperationCode::POSE_INIT_IK:
|
|
return "POSE_INIT_IK";
|
|
case OperationCode::POSE_CLEANUP:
|
|
return "POSE_CLEANUP";
|
|
case OperationCode::POSE_DONE:
|
|
return "POSE_DONE";
|
|
case OperationCode::POSE_IK_SOLVER:
|
|
return "POSE_IK_SOLVER";
|
|
case OperationCode::POSE_SPLINE_IK_SOLVER:
|
|
return "POSE_SPLINE_IK_SOLVER";
|
|
/* Bone. */
|
|
case OperationCode::BONE_LOCAL:
|
|
return "BONE_LOCAL";
|
|
case OperationCode::BONE_POSE_PARENT:
|
|
return "BONE_POSE_PARENT";
|
|
case OperationCode::BONE_CONSTRAINTS:
|
|
return "BONE_CONSTRAINTS";
|
|
case OperationCode::BONE_READY:
|
|
return "BONE_READY";
|
|
case OperationCode::BONE_DONE:
|
|
return "BONE_DONE";
|
|
case OperationCode::BONE_SEGMENTS:
|
|
return "BONE_SEGMENTS";
|
|
/* Particle System. */
|
|
case OperationCode::PARTICLE_SYSTEM_INIT:
|
|
return "PARTICLE_SYSTEM_INIT";
|
|
case OperationCode::PARTICLE_SYSTEM_EVAL:
|
|
return "PARTICLE_SYSTEM_EVAL";
|
|
case OperationCode::PARTICLE_SYSTEM_DONE:
|
|
return "PARTICLE_SYSTEM_DONE";
|
|
/* Particles Settings. */
|
|
case OperationCode::PARTICLE_SETTINGS_INIT:
|
|
return "PARTICLE_SETTINGS_INIT";
|
|
case OperationCode::PARTICLE_SETTINGS_EVAL:
|
|
return "PARTICLE_SETTINGS_EVAL";
|
|
case OperationCode::PARTICLE_SETTINGS_RESET:
|
|
return "PARTICLE_SETTINGS_RESET";
|
|
/* Point Cache. */
|
|
case OperationCode::POINT_CACHE_RESET:
|
|
return "POINT_CACHE_RESET";
|
|
/* File cache. */
|
|
case OperationCode::FILE_CACHE_UPDATE:
|
|
return "FILE_CACHE_UPDATE";
|
|
/* Batch cache. */
|
|
case OperationCode::GEOMETRY_SELECT_UPDATE:
|
|
return "GEOMETRY_SELECT_UPDATE";
|
|
/* Masks. */
|
|
case OperationCode::MASK_ANIMATION:
|
|
return "MASK_ANIMATION";
|
|
case OperationCode::MASK_EVAL:
|
|
return "MASK_EVAL";
|
|
/* Collections. */
|
|
case OperationCode::VIEW_LAYER_EVAL:
|
|
return "VIEW_LAYER_EVAL";
|
|
/* Copy on eval. */
|
|
case OperationCode::COPY_ON_EVAL:
|
|
return "COPY_ON_EVAL";
|
|
/* Shading. */
|
|
case OperationCode::SHADING:
|
|
return "SHADING";
|
|
case OperationCode::SHADING_DONE:
|
|
return "SHADING_DONE";
|
|
case OperationCode::MATERIAL_UPDATE:
|
|
return "MATERIAL_UPDATE";
|
|
case OperationCode::LIGHT_UPDATE:
|
|
return "LIGHT_UPDATE";
|
|
case OperationCode::WORLD_UPDATE:
|
|
return "WORLD_UPDATE";
|
|
/* Light linking. */
|
|
case OperationCode::LIGHT_LINKING_UPDATE:
|
|
return "LIGHT_LINKING_UPDATE";
|
|
/* Node Tree. */
|
|
case OperationCode::NTREE_OUTPUT:
|
|
return "NTREE_OUTPUT";
|
|
case OperationCode::NTREE_GEOMETRY_PREPROCESS:
|
|
return "NTREE_GEOMETRY_PREPROCESS";
|
|
/* Movie clip. */
|
|
case OperationCode::MOVIECLIP_EVAL:
|
|
return "MOVIECLIP_EVAL";
|
|
/* Image. */
|
|
case OperationCode::IMAGE_ANIMATION:
|
|
return "IMAGE_ANIMATION";
|
|
/* Synchronization. */
|
|
case OperationCode::SYNCHRONIZE_TO_ORIGINAL:
|
|
return "SYNCHRONIZE_TO_ORIGINAL";
|
|
/* Generic datablock. */
|
|
case OperationCode::GENERIC_DATABLOCK_UPDATE:
|
|
return "GENERIC_DATABLOCK_UPDATE";
|
|
/* Sequencer. */
|
|
case OperationCode::SEQUENCES_EVAL:
|
|
return "SEQUENCES_EVAL";
|
|
/* instancing. */
|
|
case OperationCode::INSTANCER:
|
|
return "INSTANCER";
|
|
case OperationCode::INSTANCE:
|
|
return "INSTANCE";
|
|
}
|
|
BLI_assert_msg(0, "Unhandled operation code, should never happen.");
|
|
return "UNKNOWN";
|
|
}
|
|
|
|
OperationNode::OperationNode() : name_tag(-1), flag(0) {}
|
|
|
|
string OperationNode::identifier() const
|
|
{
|
|
return string(operationCodeAsString(opcode)) + "(" + name + ")";
|
|
}
|
|
|
|
string OperationNode::full_identifier() const
|
|
{
|
|
string owner_str = owner->owner->name;
|
|
if (owner->type == NodeType::BONE || !owner->name.empty()) {
|
|
owner_str += "/" + owner->name;
|
|
}
|
|
return owner_str + "/" + identifier();
|
|
}
|
|
|
|
void OperationNode::tag_update(Depsgraph *graph, eUpdateSource source)
|
|
{
|
|
/* Ensure that there is an entry tag for this update.
|
|
*
|
|
* Note that the node might already be tagged for an update due invisible state of the node
|
|
* during previous dependency evaluation. Here the node gets re-tagged, so we need to give
|
|
* the evaluated clues that evaluation needs to happen again. */
|
|
graph->add_entry_tag(this);
|
|
|
|
/* Enforce dynamic visibility code-path update.
|
|
* This ensures visibility flags are consistently propagated throughout the dependency graph when
|
|
* there is no animated visibility in the graph.
|
|
*
|
|
* For example this ensures that graph is updated properly when manually toggling non-animated
|
|
* modifier visibility. */
|
|
if (opcode == OperationCode::VISIBILITY) {
|
|
graph->need_update_nodes_visibility = true;
|
|
}
|
|
|
|
/* Tag for update, but also note that this was the source of an update. */
|
|
flag |= (DEPSOP_FLAG_NEEDS_UPDATE | DEPSOP_FLAG_DIRECTLY_MODIFIED);
|
|
switch (source) {
|
|
case DEG_UPDATE_SOURCE_TIME:
|
|
case DEG_UPDATE_SOURCE_RELATIONS:
|
|
case DEG_UPDATE_SOURCE_VISIBILITY:
|
|
case DEG_UPDATE_SOURCE_SIDE_EFFECT_REQUEST:
|
|
/* Currently nothing. */
|
|
break;
|
|
case DEG_UPDATE_SOURCE_USER_EDIT:
|
|
flag |= DEPSOP_FLAG_USER_MODIFIED;
|
|
break;
|
|
}
|
|
}
|
|
|
|
void OperationNode::set_as_entry()
|
|
{
|
|
BLI_assert(owner != nullptr);
|
|
owner->set_entry_operation(this);
|
|
}
|
|
|
|
void OperationNode::set_as_exit()
|
|
{
|
|
BLI_assert(owner != nullptr);
|
|
owner->set_exit_operation(this);
|
|
}
|
|
|
|
DEG_DEPSNODE_DEFINE(OperationNode, NodeType::OPERATION, "Operation");
|
|
static DepsNodeFactoryImpl<OperationNode> DNTI_OPERATION;
|
|
|
|
void deg_register_operation_depsnodes()
|
|
{
|
|
register_node_typeinfo(&DNTI_OPERATION);
|
|
}
|
|
|
|
} // namespace blender::deg
|