Blender V5.3
blender::bke::socket_value_visitor::VisitParams Struct Reference

#include <BKE_node_socket_value_iter.hh>

Static Public Member Functions

static bool needs_edit (const bool value)
static bool continue_check (const bool value)

Public Attributes

bool check_non_editable = false
bool ignore_non_geometry_instances = false
FunctionRef< bool(const AttributeAccessor &)> check_AttributeAccessor
FunctionRef< void(MutableAttributeAccessor &)> edit_AttributeAccessor
FunctionRef< bool(const fn::GField &)> check_GField
FunctionRef< void(fn::GField &)> edit_GField

Detailed Description

Besides general iteration settings, this contains two kinds of callbacks:

  • check_*: Gets readonly access to a value which should return either needs_edit(...) or continue_check(...) depending on the use-case.
  • edit_*: Gets write access to a value which should be edited.

Definition at line 34 of file BKE_node_socket_value_iter.hh.

Member Function Documentation

◆ continue_check()

bool blender::bke::socket_value_visitor::VisitParams::continue_check ( const bool value)
inlinestatic

Used when just scanning all values recursively without the intention to edit them.

Definition at line 41 of file BKE_node_socket_value_iter.hh.

Referenced by blender::bke::socket_value_visitor::tests::TEST_F().

◆ needs_edit()

bool blender::bke::socket_value_visitor::VisitParams::needs_edit ( const bool value)
inlinestatic

Used when this a check function is used to determine whether the value needs to be edited.

Definition at line 36 of file BKE_node_socket_value_iter.hh.

Member Data Documentation

◆ check_AttributeAccessor

FunctionRef<bool(const AttributeAccessor &)> blender::bke::socket_value_visitor::VisitParams::check_AttributeAccessor

◆ check_GField

FunctionRef<bool(const fn::GField &)> blender::bke::socket_value_visitor::VisitParams::check_GField

Definition at line 63 of file BKE_node_socket_value_iter.hh.

◆ check_non_editable

bool blender::bke::socket_value_visitor::VisitParams::check_non_editable = false

Also iterate over:

  • Captured closure values, and closure default inputs.

Definition at line 50 of file BKE_node_socket_value_iter.hh.

◆ edit_AttributeAccessor

FunctionRef<void(MutableAttributeAccessor &)> blender::bke::socket_value_visitor::VisitParams::edit_AttributeAccessor

◆ edit_GField

FunctionRef<void(fn::GField &)> blender::bke::socket_value_visitor::VisitParams::edit_GField

Definition at line 64 of file BKE_node_socket_value_iter.hh.

◆ ignore_non_geometry_instances

bool blender::bke::socket_value_visitor::VisitParams::ignore_non_geometry_instances = false

By default, all instanced objects/collections are also iterated over. Those can optionally be ignored.

Definition at line 55 of file BKE_node_socket_value_iter.hh.


The documentation for this struct was generated from the following file: