Blender V5.0
deg_node_operation.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2013 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "intern/node/deg_node_operation.hh"
10
11#include "intern/depsgraph.hh"
12#include "intern/node/deg_node_component.hh"
13#include "intern/node/deg_node_factory.hh"
14#include "intern/node/deg_node_id.hh"
15
16namespace blender::deg {
17
18const char *operationCodeAsString(OperationCode opcode)
19{
20 switch (opcode) {
21 /* Generic Operations. */
22 case OperationCode::OPERATION:
23 return "OPERATION";
24 case OperationCode::ID_PROPERTY:
25 return "ID_PROPERTY";
26 case OperationCode::PARAMETERS_ENTRY:
27 return "PARAMETERS_ENTRY";
28 case OperationCode::PARAMETERS_EVAL:
29 return "PARAMETERS_EVAL";
30 case OperationCode::PARAMETERS_EXIT:
31 return "PARAMETERS_EXIT";
32 case OperationCode::VISIBILITY:
33 return "VISIBILITY";
34 /* Hierarchy. */
35 case OperationCode::HIERARCHY:
36 return "HIERARCHY";
37 /* Animation, Drivers, etc. */
38 case OperationCode::ANIMATION_ENTRY:
39 return "ANIMATION_ENTRY";
40 case OperationCode::ANIMATION_EVAL:
41 return "ANIMATION_EVAL";
42 case OperationCode::ANIMATION_EXIT:
43 return "ANIMATION_EXIT";
44 case OperationCode::DRIVER:
45 return "DRIVER";
46 case OperationCode::DRIVER_UNSHARE:
47 return "DRIVER_UNSHARE";
48 /* Scene related. */
49 case OperationCode::SCENE_EVAL:
50 return "SCENE_EVAL";
51 case OperationCode::AUDIO_ENTRY:
52 return "AUDIO_ENTRY";
53 case OperationCode::AUDIO_VOLUME:
54 return "AUDIO_VOLUME";
55 /* Object related. */
56 case OperationCode::OBJECT_FROM_LAYER_ENTRY:
57 return "OBJECT_FROM_LAYER_ENTRY";
58 case OperationCode::OBJECT_BASE_FLAGS:
59 return "OBJECT_BASE_FLAGS";
60 case OperationCode::OBJECT_FROM_LAYER_EXIT:
61 return "OBJECT_FROM_LAYER_EXIT";
62 case OperationCode::DIMENSIONS:
63 return "DIMENSIONS";
64 /* Transform. */
65 case OperationCode::TRANSFORM_INIT:
66 return "TRANSFORM_INIT";
67 case OperationCode::TRANSFORM_LOCAL:
68 return "TRANSFORM_LOCAL";
69 case OperationCode::TRANSFORM_PARENT:
70 return "TRANSFORM_PARENT";
71 case OperationCode::TRANSFORM_CONSTRAINTS:
72 return "TRANSFORM_CONSTRAINTS";
73 case OperationCode::TRANSFORM_FINAL:
74 return "TRANSFORM_FINAL";
75 case OperationCode::TRANSFORM_EVAL:
76 return "TRANSFORM_EVAL";
77 case OperationCode::TRANSFORM_SIMULATION_INIT:
78 return "TRANSFORM_SIMULATION_INIT";
79 /* Rigid body. */
80 case OperationCode::RIGIDBODY_REBUILD:
81 return "RIGIDBODY_REBUILD";
82 case OperationCode::RIGIDBODY_SIM:
83 return "RIGIDBODY_SIM";
84 case OperationCode::RIGIDBODY_TRANSFORM_COPY:
85 return "RIGIDBODY_TRANSFORM_COPY";
86 /* Geometry. */
87 case OperationCode::GEOMETRY_EVAL_INIT:
88 return "GEOMETRY_EVAL_INIT";
89 case OperationCode::MODIFIER:
90 return "MODIFIER";
91 case OperationCode::GEOMETRY_EVAL:
92 return "GEOMETRY_EVAL";
93 case OperationCode::GEOMETRY_EVAL_DONE:
94 return "GEOMETRY_EVAL_DONE";
95 case OperationCode::GEOMETRY_SHAPEKEY:
96 return "GEOMETRY_SHAPEKEY";
97 /* Object data. */
98 case OperationCode::LIGHT_PROBE_EVAL:
99 return "LIGHT_PROBE_EVAL";
100 case OperationCode::SPEAKER_EVAL:
101 return "SPEAKER_EVAL";
102 case OperationCode::SOUND_EVAL:
103 return "SOUND_EVAL";
104 case OperationCode::ARMATURE_EVAL:
105 return "ARMATURE_EVAL";
106 /* Pose. */
107 case OperationCode::POSE_INIT:
108 return "POSE_INIT";
109 case OperationCode::POSE_INIT_IK:
110 return "POSE_INIT_IK";
111 case OperationCode::POSE_CLEANUP:
112 return "POSE_CLEANUP";
113 case OperationCode::POSE_DONE:
114 return "POSE_DONE";
115 case OperationCode::POSE_IK_SOLVER:
116 return "POSE_IK_SOLVER";
117 case OperationCode::POSE_SPLINE_IK_SOLVER:
118 return "POSE_SPLINE_IK_SOLVER";
119 /* Bone. */
120 case OperationCode::BONE_LOCAL:
121 return "BONE_LOCAL";
122 case OperationCode::BONE_POSE_PARENT:
123 return "BONE_POSE_PARENT";
124 case OperationCode::BONE_CONSTRAINTS:
125 return "BONE_CONSTRAINTS";
126 case OperationCode::BONE_READY:
127 return "BONE_READY";
128 case OperationCode::BONE_DONE:
129 return "BONE_DONE";
130 case OperationCode::BONE_SEGMENTS:
131 return "BONE_SEGMENTS";
132 /* Particle System. */
133 case OperationCode::PARTICLE_SYSTEM_INIT:
134 return "PARTICLE_SYSTEM_INIT";
135 case OperationCode::PARTICLE_SYSTEM_EVAL:
136 return "PARTICLE_SYSTEM_EVAL";
137 case OperationCode::PARTICLE_SYSTEM_DONE:
138 return "PARTICLE_SYSTEM_DONE";
139 /* Particles Settings. */
140 case OperationCode::PARTICLE_SETTINGS_INIT:
141 return "PARTICLE_SETTINGS_INIT";
142 case OperationCode::PARTICLE_SETTINGS_EVAL:
143 return "PARTICLE_SETTINGS_EVAL";
144 case OperationCode::PARTICLE_SETTINGS_RESET:
145 return "PARTICLE_SETTINGS_RESET";
146 /* Point Cache. */
147 case OperationCode::POINT_CACHE_RESET:
148 return "POINT_CACHE_RESET";
149 /* File cache. */
150 case OperationCode::FILE_CACHE_UPDATE:
151 return "FILE_CACHE_UPDATE";
152 /* Batch cache. */
153 case OperationCode::GEOMETRY_SELECT_UPDATE:
154 return "GEOMETRY_SELECT_UPDATE";
155 /* Masks. */
156 case OperationCode::MASK_ANIMATION:
157 return "MASK_ANIMATION";
158 case OperationCode::MASK_EVAL:
159 return "MASK_EVAL";
160 /* Collections. */
161 case OperationCode::VIEW_LAYER_EVAL:
162 return "VIEW_LAYER_EVAL";
163 /* Copy on eval. */
164 case OperationCode::COPY_ON_EVAL:
165 return "COPY_ON_EVAL";
166 /* Shading. */
167 case OperationCode::SHADING:
168 return "SHADING";
169 case OperationCode::SHADING_DONE:
170 return "SHADING_DONE";
171 case OperationCode::MATERIAL_UPDATE:
172 return "MATERIAL_UPDATE";
173 case OperationCode::LIGHT_UPDATE:
174 return "LIGHT_UPDATE";
175 case OperationCode::WORLD_UPDATE:
176 return "WORLD_UPDATE";
177 /* Light linking. */
178 case OperationCode::LIGHT_LINKING_UPDATE:
179 return "LIGHT_LINKING_UPDATE";
180 /* Node Tree. */
181 case OperationCode::NTREE_OUTPUT:
182 return "NTREE_OUTPUT";
183 case OperationCode::NTREE_GEOMETRY_PREPROCESS:
184 return "NTREE_GEOMETRY_PREPROCESS";
185 /* Movie clip. */
186 case OperationCode::MOVIECLIP_EVAL:
187 return "MOVIECLIP_EVAL";
188 /* Image. */
189 case OperationCode::IMAGE_ANIMATION:
190 return "IMAGE_ANIMATION";
191 /* Synchronization. */
192 case OperationCode::SYNCHRONIZE_TO_ORIGINAL:
193 return "SYNCHRONIZE_TO_ORIGINAL";
194 /* Generic datablock. */
195 case OperationCode::GENERIC_DATABLOCK_UPDATE:
196 return "GENERIC_DATABLOCK_UPDATE";
197 /* Sequencer. */
198 case OperationCode::SEQUENCES_EVAL:
199 return "SEQUENCES_EVAL";
200 /* instancing. */
201 case OperationCode::INSTANCER:
202 return "INSTANCER";
203 case OperationCode::INSTANCE:
204 return "INSTANCE";
205 case OperationCode::INSTANCE_GEOMETRY:
206 return "INSTANCE_GEOMETRY";
207 }
208 BLI_assert_msg(0, "Unhandled operation code, should never happen.");
209 return "UNKNOWN";
210}
211
212OperationNode::OperationNode() : name_tag(-1), flag(0) {}
213
214std::string OperationNode::identifier() const
215{
216 return std::string(operationCodeAsString(opcode)) + "(" + name + ")";
217}
218
219std::string OperationNode::full_identifier() const
220{
221 std::string owner_str = owner->owner->name;
222 if (owner->type == NodeType::BONE || !owner->name.empty()) {
223 owner_str += "/" + owner->name;
224 }
225 return owner_str + "/" + identifier();
226}
227
228void OperationNode::tag_update(Depsgraph *graph, eUpdateSource source)
229{
230 /* Ensure that there is an entry tag for this update.
231 *
232 * Note that the node might already be tagged for an update due invisible state of the node
233 * during previous dependency evaluation. Here the node gets re-tagged, so we need to give
234 * the evaluated clues that evaluation needs to happen again. */
235 graph->add_entry_tag(this);
236
237 /* Enforce dynamic visibility code-path update.
238 * This ensures visibility flags are consistently propagated throughout the dependency graph when
239 * there is no animated visibility in the graph.
240 *
241 * For example this ensures that graph is updated properly when manually toggling non-animated
242 * modifier visibility. */
243 if (opcode == OperationCode::VISIBILITY) {
244 graph->need_update_nodes_visibility = true;
245 }
246
247 /* Tag for update, but also note that this was the source of an update. */
248 flag |= (DEPSOP_FLAG_NEEDS_UPDATE | DEPSOP_FLAG_DIRECTLY_MODIFIED);
249 switch (source) {
250 case DEG_UPDATE_SOURCE_TIME:
251 case DEG_UPDATE_SOURCE_RELATIONS:
252 case DEG_UPDATE_SOURCE_VISIBILITY:
253 case DEG_UPDATE_SOURCE_SIDE_EFFECT_REQUEST:
254 /* Currently nothing. */
255 break;
256 case DEG_UPDATE_SOURCE_USER_EDIT:
257 flag |= DEPSOP_FLAG_USER_MODIFIED;
258 break;
259 }
260}
261
262void OperationNode::set_as_entry()
263{
264 BLI_assert(owner != nullptr);
265 owner->set_entry_operation(this);
266}
267
268void OperationNode::set_as_exit()
269{
270 BLI_assert(owner != nullptr);
271 owner->set_exit_operation(this);
272}
273
274DEG_DEPSNODE_DEFINE(OperationNode, NodeType::OPERATION, "Operation");
275static DepsNodeFactoryImpl<OperationNode> DNTI_OPERATION;
276
281
282} // namespace blender::deg
BLI_assert
#define BLI_assert(a)
Definition BLI_assert.h:46
BLI_assert_msg
#define BLI_assert_msg(a, msg)
Definition BLI_assert.h:53
DEG_DEPSNODE_DEFINE
#define DEG_DEPSNODE_DEFINE(NodeType, type_, tname_)
Definition deg_node.hh:219
deg_node_component.hh
deg_node_factory.hh
deg_node_id.hh
deg_node_operation.hh
blender::deg::register_node_typeinfo
void register_node_typeinfo(DepsNodeFactory *factory)
Definition deg_node_factory.cc:16
blender::deg::operationCodeAsString
const char * operationCodeAsString(OperationCode opcode)
Definition deg_node_operation.cc:18
blender::deg::DNTI_OPERATION
static DepsNodeFactoryImpl< OperationNode > DNTI_OPERATION
Definition deg_node_operation.cc:275
blender::deg::deg_register_operation_depsnodes
void deg_register_operation_depsnodes()
Definition deg_node_operation.cc:277
blender::deg::DEG_UPDATE_SOURCE_SIDE_EFFECT_REQUEST
@ DEG_UPDATE_SOURCE_SIDE_EFFECT_REQUEST
Definition depsgraph_type.hh:45
blender::deg::Depsgraph::add_entry_tag
void add_entry_tag(OperationNode *node)
Definition depsgraph.cc:224
blender::deg::Node::name
std::string name
Definition deg_node.hh:180
blender::deg::OperationNode::full_identifier
std::string full_identifier() const
Definition deg_node_operation.cc:219
blender::deg::OperationNode::tag_update
void tag_update(Depsgraph *graph, eUpdateSource source) override
Definition deg_node_operation.cc:228
blender::deg::OperationNode::identifier
std::string identifier() const override
Definition deg_node_operation.cc:214
Generated on for Blender by  doxygen 1.16.1