Blender V5.3
blender::nodes::SocketDeclarationBuilder< SocketDecl > Class Template Reference

#include <NOD_node_declaration.hh>

Inherits blender::nodes::BaseSocketDeclarationBuilder.

Inherited by blender::nodes::decl::IDSocketDeclarationBuilder< Object >, blender::nodes::decl::IDSocketDeclarationBuilder< Material >, blender::nodes::decl::IDSocketDeclarationBuilder< Collection >, blender::nodes::decl::IDSocketDeclarationBuilder< Texture >, blender::nodes::decl::IDSocketDeclarationBuilder< Image >, blender::nodes::decl::IDSocketDeclarationBuilder< Font >, blender::nodes::decl::IDSocketDeclarationBuilder< Scene >, blender::nodes::decl::IDSocketDeclarationBuilder< Text >, blender::nodes::decl::IDSocketDeclarationBuilder< Mask >, and blender::nodes::decl::IDSocketDeclarationBuilder< Sound >.

Protected Types

using Self = typename SocketDecl::Builder

Protected Attributes

SocketDecl * decl_
Protected Attributes inherited from blender::nodes::BaseSocketDeclarationBuilder
NodeDeclarationBuilder * node_decl_builder_ = nullptr
SocketDeclaration * decl_base_ = nullptr
bool propagate_all_input_references_ = false
bool propagate_all_input_data_ = false
bool propagate_all_input_data_from_geometry_ = false
bool input_reference_used_on_all_data_ = false
bool output_reference_available_on_all_data_ = false

Friends

class NodeDeclarationBuilder
class DeclarationListBuilder
class FlatBundleTypeBuilder

Additional Inherited Members

Public Member Functions inherited from blender::nodes::BaseSocketDeclarationBuilder
virtual ~BaseSocketDeclarationBuilder ()=default
BaseSocketDeclarationBuilder & optional_label (bool value=true)
BaseSocketDeclarationBuilder & hide_value (bool value=true)
BaseSocketDeclarationBuilder & multi_input (bool value=true)
BaseSocketDeclarationBuilder & compact (bool value=true)
BaseSocketDeclarationBuilder & short_label (UString value)
BaseSocketDeclarationBuilder & description (std::string value="")
BaseSocketDeclarationBuilder & translation_context (std::optional< std::string > value=std::nullopt)
BaseSocketDeclarationBuilder & no_muted_links (bool value=true)
BaseSocketDeclarationBuilder & available (bool value=true)
BaseSocketDeclarationBuilder & is_attribute_name (bool value=true)
BaseSocketDeclarationBuilder & is_default_link_socket (bool value=true)
BaseSocketDeclarationBuilder & default_input_type (NodeDefaultInputType value)
BaseSocketDeclarationBuilder & evaluated_geometry_field ()
BaseSocketDeclarationBuilder & evaluated_geometry_field (Span< int > geometry_input_indices)
BaseSocketDeclarationBuilder & anonymous_attribute_output ()
BaseSocketDeclarationBuilder & anonymous_attribute_output (Span< int > geometry_output_indices)
BaseSocketDeclarationBuilder & references_other_outputs ()
BaseSocketDeclarationBuilder & references_other_outputs (Span< int > output_indices)
BaseSocketDeclarationBuilder & inferred_structure_type ()
BaseSocketDeclarationBuilder & inferred_structure_type (Span< int > input_indices)
BaseSocketDeclarationBuilder & propagate_references ()
BaseSocketDeclarationBuilder & propagate_references (Span< int > input_indices)
BaseSocketDeclarationBuilder & propagate_all ()
BaseSocketDeclarationBuilder & propagate_all (Span< int > input_indices)
BaseSocketDeclarationBuilder & propagate_all_geometry ()
BaseSocketDeclarationBuilder & compositor_realization_mode (CompositorInputRealizationMode value)
BaseSocketDeclarationBuilder & compositor_domain_priority (int priority)
BaseSocketDeclarationBuilder & make_available (std::function< void(bNode &)> fn)
BaseSocketDeclarationBuilder & custom_draw (CustomSocketDrawFn fn)
BaseSocketDeclarationBuilder & usage_inference (SocketUsageInferenceFn fn)
BaseSocketDeclarationBuilder & label_fn (CustomSocketLabelFn fn)
BaseSocketDeclarationBuilder & usage_by_single_menu (const int menu_value)
BaseSocketDeclarationBuilder & usage_by_menu (const UString menu_input_identifier, const int menu_value)
BaseSocketDeclarationBuilder & usage_by_menu (const UString menu_input_identifier, const Array< int > menu_values)
BaseSocketDeclarationBuilder & usage_by_bool (UString bool_input_identifier, bool value)
BaseSocketDeclarationBuilder & usage_by_panel_toggle ()
BaseSocketDeclarationBuilder & align_with_previous (bool value=true)
BaseSocketDeclarationBuilder & socket_name_ptr (PointerRNA ptr, StringRef property_name)
BaseSocketDeclarationBuilder & socket_name_ptr (const ID *id, const StructRNA *srna, const void *data, StringRef property_name)
BaseSocketDeclarationBuilder & panel_toggle (bool value=true)
BaseSocketDeclarationBuilder & structure_type (StructureType structure_type)
BaseSocketDeclarationBuilder & is_layer_name (bool value=true)
BaseSocketDeclarationBuilder & is_volume_grid_name (bool value=true)
virtual BaseSocketDeclarationBuilder & try_copy_ui_data (const SocketDeclaration &other_decl)
int index () const
bool is_input () const
bool is_output () const

Detailed Description

template<typename SocketDecl>
class blender::nodes::SocketDeclarationBuilder< SocketDecl >

Wraps a SocketDeclaration and provides methods to set it up correctly. This is separate from SocketDeclaration, because it allows separating the API used by nodes to declare themselves from how the declaration is stored internally.

Definition at line 477 of file NOD_node_declaration.hh.

Member Typedef Documentation

◆ Self

template<typename SocketDecl>
using blender::nodes::SocketDeclarationBuilder< SocketDecl >::Self = typename SocketDecl::Builder
protected

Definition at line 479 of file NOD_node_declaration.hh.

◆ DeclarationListBuilder

template<typename SocketDecl>
friend class DeclarationListBuilder
friend

Definition at line 484 of file NOD_node_declaration.hh.

References DeclarationListBuilder.

Referenced by DeclarationListBuilder.

◆ FlatBundleTypeBuilder

template<typename SocketDecl>
friend class FlatBundleTypeBuilder
friend

Definition at line 485 of file NOD_node_declaration.hh.

References FlatBundleTypeBuilder.

Referenced by FlatBundleTypeBuilder.

◆ NodeDeclarationBuilder

template<typename SocketDecl>
friend class NodeDeclarationBuilder
friend

Definition at line 483 of file NOD_node_declaration.hh.

References NodeDeclarationBuilder.

Referenced by NodeDeclarationBuilder.

Member Data Documentation

◆ decl_

template<typename SocketDecl>
SocketDecl* blender::nodes::SocketDeclarationBuilder< SocketDecl >::decl_
protected

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