blender::nodes::SocketDeclarationBuilder< SocketDecl > Class Template Reference

#include <NOD_node_declaration.hh>

Inherits blender::nodes::BaseSocketDeclarationBuilder.

Protected Types
using	Self = typename SocketDecl::Builder

Protected Attributes
SocketDecl *	decl_
Protected Attributes inherited from blender::nodes::BaseSocketDeclarationBuilder
int	index_ = -1
bool	reference_pass_all_ = false
bool	field_on_all_ = false
bool	propagate_from_all_ = false
NodeDeclarationBuilder *	node_decl_builder_ = nullptr
SocketDeclaration *	decl_base_ = nullptr

Friends
class	NodeDeclarationBuilder

Additional Inherited Members
Public Member Functions inherited from blender::nodes::BaseSocketDeclarationBuilder
virtual	~BaseSocketDeclarationBuilder ()=default
BaseSocketDeclarationBuilder &	hide_label (bool value=true)
BaseSocketDeclarationBuilder &	hide_value (bool value=true)
BaseSocketDeclarationBuilder &	multi_input (bool value=true)
BaseSocketDeclarationBuilder &	short_label (std::string value="")
BaseSocketDeclarationBuilder &	description (std::string value="")
BaseSocketDeclarationBuilder &	translation_context (std::string value=BLT_I18NCONTEXT_DEFAULT)
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 &	supports_field ()
BaseSocketDeclarationBuilder &	field_on_all ()
BaseSocketDeclarationBuilder &	field_source ()
BaseSocketDeclarationBuilder &	implicit_field (ImplicitInputValueFn fn)
BaseSocketDeclarationBuilder &	implicit_field_on_all (ImplicitInputValueFn fn)
BaseSocketDeclarationBuilder &	implicit_field_on (ImplicitInputValueFn fn, Span< int > input_indices)
BaseSocketDeclarationBuilder &	field_on (Span< int > indices)
BaseSocketDeclarationBuilder &	dependent_field ()
BaseSocketDeclarationBuilder &	dependent_field (Vector< int > input_dependencies)
BaseSocketDeclarationBuilder &	field_source_reference_all ()
BaseSocketDeclarationBuilder &	reference_pass (Span< int > input_indices)
BaseSocketDeclarationBuilder &	reference_pass_all ()
BaseSocketDeclarationBuilder &	propagate_all ()
BaseSocketDeclarationBuilder &	compositor_realization_options (CompositorInputRealizationOptions value)
BaseSocketDeclarationBuilder &	compositor_domain_priority (int priority)
BaseSocketDeclarationBuilder &	compositor_expects_single_value (bool value=true)
BaseSocketDeclarationBuilder &	make_available (std::function< void(bNode &)> fn)
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)
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 400 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 402 of file NOD_node_declaration.hh.

Friends And Related Symbol Documentation

NodeDeclarationBuilder

template<typename SocketDecl >

friend class NodeDeclarationBuilder

friend

Definition at line 406 of file NOD_node_declaration.hh.

Member Data Documentation

decl_

template<typename SocketDecl >

SocketDecl* blender::nodes::SocketDeclarationBuilder< SocketDecl >::decl_

protected

Definition at line 404 of file NOD_node_declaration.hh.

---

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

• NOD_node_declaration.hh