Blender V5.3
compute_contexts.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <ostream>
10
12
13#include "DNA_modifier_types.h"
14#include "DNA_node_types.h"
15
18#include "BKE_lib_id.hh"
19#include "BKE_node.hh"
20#include "BKE_node_runtime.hh"
21
22namespace blender::bke {
23
25 : ComputeContext(parent), id_(&id)
26{
27 if (DEG_is_original(&id)) {
28 orig_session_uid_ = id.session_uid;
29 }
30 else if (const ID *orig_id = DEG_get_original_id(&id)) {
31 orig_session_uid_ = orig_id->session_uid;
32 }
33 else {
35 }
36}
37
46
47ComputeContextHash DataBlockComputeContext::compute_hash() const
48{
49 return ComputeContextHash::from(parent_, "DATABLOCK", orig_session_uid_);
50}
51
52void DataBlockComputeContext::print_current_in_line(std::ostream &stream) const
53{
54 stream << "DataBlock: " << orig_session_uid_;
55 if (id_) {
56 stream << " " << id_->name;
57 }
58}
59
66
72
73ComputeContextHash GeometryNodesModifierComputeContext::compute_hash() const
74{
75 return ComputeContextHash::from(parent_, "MODIFIER", modifier_uid_);
76}
77
78void GeometryNodesModifierComputeContext::print_current_in_line(std::ostream &stream) const
79{
80 if (nmd_) {
81 stream << "Modifier: " << nmd_->modifier.name;
82 }
83}
84
90
91ComputeContextHash SceneCompositorEffectComputeContext::compute_hash() const
92{
93 return ComputeContextHash::from(parent_, "SCENE_COMPOSITOR_EFFECT", effect_.name);
94}
95
96void SceneCompositorEffectComputeContext::print_current_in_line(std::ostream &stream) const
97{
98 stream << "Scene Compositor Effect: " << effect_.name;
99}
100
107
108ComputeContextHash NodeComputeContext::compute_hash() const
109{
110 return ComputeContextHash::from(parent_, "NODE", node_id_);
111}
112
114{
115 if (tree_) {
116 return tree_->node_by_id(node_id_);
117 }
118 return nullptr;
119}
120
121void NodeComputeContext::print_current_in_line(std::ostream &stream) const
122{
123 if (tree_) {
124 if (const bNode *node = tree_->node_by_id(node_id_)) {
125 stream << "Node: " << node_label(*tree_, *node);
126 return;
127 }
128 }
129 stream << "Node ID: " << node_id_;
130}
131
133 const int32_t output_node_id)
134 : ComputeContext(parent), output_node_id_(output_node_id)
135{
136}
137
143
144ComputeContextHash SimulationZoneComputeContext::compute_hash() const
145{
146 return ComputeContextHash::from(parent_, "SIM_ZONE", output_node_id_);
147}
148
149void SimulationZoneComputeContext::print_current_in_line(std::ostream &stream) const
150{
151 stream << "Simulation Zone ID: " << output_node_id_;
152}
153
160
167
168ComputeContextHash RepeatZoneComputeContext::compute_hash() const
169{
170 return ComputeContextHash::from(parent_, "REPEAT_ZONE", output_node_id_, iteration_);
171}
172
173void RepeatZoneComputeContext::print_current_in_line(std::ostream &stream) const
174{
175 stream << "Repeat Zone ID: " << output_node_id_ << ", Iteration: " << iteration_;
176}
177
183
189
190ComputeContextHash ForeachGeometryElementZoneComputeContext::compute_hash() const
191{
192 return ComputeContextHash::from(parent_, "FOREACH_GEOMETRY_ELEMENT", output_node_id_, index_);
193}
194
195void ForeachGeometryElementZoneComputeContext::print_current_in_line(std::ostream &stream) const
196{
197 stream << "Foreach Geometry Element Zone ID: " << output_node_id_;
198}
199
201 const ComputeContext *parent,
203 const bNodeTree *tree,
204 const std::optional<nodes::ClosureSourceLocation> &closure_source_location)
205 : NodeComputeContext(parent, node_id, tree), closure_source_location_(closure_source_location)
206{
207}
208
210{
211 if (!closure_source_location_) {
212 /* Can't determine recursiveness in this case. */
213 return false;
214 }
215 for (const ComputeContext *parent = parent_; parent; parent = parent->parent()) {
216 if (const auto *evaluate_closure_compute_context =
217 dynamic_cast<const EvaluateClosureComputeContext *>(parent))
218 {
219 if (!evaluate_closure_compute_context->closure_source_location_) {
220 continue;
221 }
222 if (evaluate_closure_compute_context->closure_source_location_->tree ==
223 closure_source_location_->tree &&
224 evaluate_closure_compute_context->closure_source_location_->closure_output_node_id ==
225 closure_source_location_->closure_output_node_id)
226 {
227 return true;
228 }
229 }
230 }
231 return false;
232}
233
235 const int32_t node_id,
236 const int list_index)
237 : NodeComputeContext(parent, node_id, nullptr), list_index_(list_index)
238{
239}
240
241ComputeContextHash ClosureToListComputeContext::compute_hash() const
242{
243 return ComputeContextHash::from(parent_, "CLOSURE_TO_LIST", node_id_, list_index_);
244}
245
246void ClosureToListComputeContext::print_current_in_line(std::ostream &stream) const
247{
248 stream << "Closure to List ID: " << node_id_ << ", List Index: " << list_index_;
249}
250
252
257
263
264ComputeContextHash OperatorComputeContext::compute_hash() const
265{
266 return ComputeContextHash::from(parent_, "OPERATOR");
267}
268
269void OperatorComputeContext::print_current_in_line(std::ostream &stream) const
270{
271 stream << "Operator";
272}
273
278
279ComputeContextHash ShaderComputeContext::compute_hash() const
280{
281 return ComputeContextHash::from(parent_, "SHADER");
282}
283
284void ShaderComputeContext::print_current_in_line(std::ostream &stream) const
285{
286 stream << "Shader ";
287 if (tree_) {
288 stream << BKE_id_name(tree_->id);
289 }
290}
291
293 const uint32_t orig_session_uid,
294 const ID *id)
295{
296 return *data_block_contexts_cache_.lookup_or_add_cb(std::pair{parent, orig_session_uid}, [&]() {
297 return &this->for_any_uncached<DataBlockComputeContext>(parent, orig_session_uid, id);
298 });
299}
300
302 const ID &id)
303{
304 uint32_t orig_session_uid = 0;
305 if (DEG_is_original(&id)) {
306 orig_session_uid = id.session_uid;
307 }
308 else {
309 orig_session_uid = DEG_get_original(&id)->session_uid;
310 }
311 return this->for_data_block(parent, orig_session_uid, &id);
312}
313
315 const ComputeContext *parent, const NodesModifierData &nmd)
316{
317 return *geometry_nodes_modifier_contexts_cache_.lookup_or_add_cb(
318 std::pair{parent, nmd.modifier.persistent_uid},
319 [&]() { return &this->for_any_uncached<GeometryNodesModifierComputeContext>(parent, nmd); });
320}
321
323 const ComputeContext *parent, const int modifier_uid)
324{
325 return *geometry_nodes_modifier_contexts_cache_.lookup_or_add_cb(
326 std::pair{parent, modifier_uid}, [&]() {
327 return &this->for_any_uncached<GeometryNodesModifierComputeContext>(parent, modifier_uid);
328 });
329}
330
332 const ComputeContext *parent, const SceneCompositorEffect &effect)
333{
334 return *scene_compositor_effect_contexts_cache_.lookup_or_add_cb(
335 std::pair{parent, effect.name}, [&]() {
336 return &this->for_any_uncached<SceneCompositorEffectComputeContext>(parent, effect);
337 });
338}
339
341{
342 return *operator_contexts_cache_.lookup_or_add_cb(
343 parent, [&]() { return &this->for_any_uncached<OperatorComputeContext>(parent); });
344}
345
347 const bNodeTree &tree)
348{
349 return *operator_contexts_cache_.lookup_or_add_cb(
350 parent, [&]() { return &this->for_any_uncached<OperatorComputeContext>(parent, tree); });
351}
352
354 const bNodeTree *tree)
355{
356 return *shader_contexts_cache_.lookup_or_add_cb(
357 parent, [&]() { return &this->for_any_uncached<ShaderComputeContext>(parent, tree); });
358}
359
361 const int32_t node_id,
362 const bNodeTree *tree)
363{
364 return *group_node_contexts_cache_.lookup_or_add_cb(std::pair{parent, node_id}, [&]() {
365 return &this->for_any_uncached<GroupNodeComputeContext>(parent, node_id, tree);
366 });
367}
368
370 const ComputeContext *parent, int output_node_id)
371{
372 return *simulation_zone_contexts_cache_.lookup_or_add_cb(
373 std::pair{parent, output_node_id}, [&]() {
374 return &this->for_any_uncached<SimulationZoneComputeContext>(parent, output_node_id);
375 });
376}
377
379 const ComputeContext *parent, const bNode &output_node)
380{
381 return *simulation_zone_contexts_cache_.lookup_or_add_cb(
382 std::pair{parent, output_node.identifier}, [&]() {
383 return &this->for_any_uncached<SimulationZoneComputeContext>(parent, output_node);
384 });
385}
386
388 int32_t output_node_id,
389 int iteration)
390{
391 return *repeat_zone_contexts_cache_.lookup_or_add_cb(
392 std::pair{parent, std::pair{output_node_id, iteration}}, [&]() {
394 parent, output_node_id, iteration);
395 });
396}
397
399 const bNode &output_node,
400 int iteration)
401{
402 return *repeat_zone_contexts_cache_.lookup_or_add_cb(
403 std::pair{parent, std::pair{output_node.identifier, iteration}}, [&]() {
404 return &this->for_any_uncached<RepeatZoneComputeContext>(parent, output_node, iteration);
405 });
406}
407
410 int32_t output_node_id,
411 int index)
412{
413 return *foreach_geometry_element_zone_contexts_cache_.lookup_or_add_cb(
414 std::pair{parent, std::pair{output_node_id, index}}, [&]() {
416 parent, output_node_id, index);
417 });
418}
419
422 const bNode &output_node,
423 int index)
424{
425 return *foreach_geometry_element_zone_contexts_cache_.lookup_or_add_cb(
426 std::pair{parent, std::pair{output_node.identifier, index}}, [&]() {
428 parent, output_node, index);
429 });
430}
431
433 const ComputeContext *parent,
434 const int32_t node_id,
435 const bNodeTree *tree,
436 const std::optional<nodes::ClosureSourceLocation> &closure_source_location)
437{
438 return *evaluate_closure_contexts_cache_.lookup_or_add_cb(std::pair{parent, node_id}, [&]() {
440 parent, node_id, tree, closure_source_location);
441 });
442}
443
444} // namespace blender::bke
#define BLI_assert_unreachable()
ComputeContext(const ComputeContext *parent)
const ComputeContext * parent() const
const ComputeContext * parent_
ClosureToListComputeContext(const ComputeContext *parent, int32_t node_id, int list_index)
const EvaluateClosureComputeContext & for_evaluate_closure(const ComputeContext *parent, int32_t node_id, const bNodeTree *tree=nullptr, const std::optional< nodes::ClosureSourceLocation > &closure_source_location=std::nullopt)
const GeometryNodesModifierComputeContext & for_geometry_nodes_modifier(const ComputeContext *parent, const NodesModifierData &nmd)
const GroupNodeComputeContext & for_group_node(const ComputeContext *parent, int32_t node_id, const bNodeTree *tree=nullptr)
const ForeachGeometryElementZoneComputeContext & for_foreach_geometry_element_zone(const ComputeContext *parent, int32_t output_node_id, int index)
const RepeatZoneComputeContext & for_repeat_zone(const ComputeContext *parent, int32_t output_node_id, int iteration)
const DataBlockComputeContext & for_data_block(const ComputeContext *parent, const uint32_t orig_session_uid, const ID *id=nullptr)
const ShaderComputeContext & for_shader(const ComputeContext *parent, const bNodeTree *tree)
const OperatorComputeContext & for_operator(const ComputeContext *parent)
const SimulationZoneComputeContext & for_simulation_zone(const ComputeContext *parent, int output_node_id)
const SceneCompositorEffectComputeContext & for_scene_compositor_effect(const ComputeContext *parent, const SceneCompositorEffect &effect)
DataBlockComputeContext(const ComputeContext *parent, const ID &id)
EvaluateClosureComputeContext(const ComputeContext *parent, int32_t node_id, const bNodeTree *tree=nullptr, const std::optional< nodes::ClosureSourceLocation > &closure_source_location=std::nullopt)
std::optional< nodes::ClosureSourceLocation > closure_source_location() const
ForeachGeometryElementZoneComputeContext(const ComputeContext *parent, int32_t output_node_id, int index)
GeometryNodesModifierComputeContext(const ComputeContext *parent, const NodesModifierData &nmd)
NodeComputeContext(const ComputeContext *parent, int32_t node_id, const bNodeTree *tree=nullptr)
RepeatZoneComputeContext(const ComputeContext *parent, int32_t output_node_id, int iteration)
SceneCompositorEffectComputeContext(const ComputeContext *parent, const SceneCompositorEffect &effect)
ShaderComputeContext(const ComputeContext *parent=nullptr, const bNodeTree *tree=nullptr)
SimulationZoneComputeContext(const ComputeContext *parent, int output_node_id)
std::string node_label(const bNodeTree &ntree, const bNode &node)
Definition node.cc:5732
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
ID * DEG_get_original_id(ID *id)
const char * BKE_id_name(const ID &id)
bool DEG_is_original(const T *id)
unsigned int uint32_t
Definition BKE_text.h:81
T * DEG_get_original(T *id)
signed int int32_t
Definition BKE_text.h:78
static ComputeContextHash from(const ComputeContext *parent, const char(&type_str)[N], Args &&...args)
char name[258]
Definition DNA_ID.h:433
unsigned int session_uid
Definition DNA_ID.h:463