blender::nodes::decl::Bundle Class Reference

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclaration.

Public Types
using	Builder = BundleBuilder

Public Member Functions
#Bundle
bNodeSocket &	build (bNodeTree &ntree, bNode &node) const override
bool	matches (const bNodeSocket &socket) const override
bNodeSocket &	update_or_build (bNodeTree &ntree, bNode &node, bNodeSocket &socket) const override
bool	can_connect (const bNodeSocket &socket) const override
Public Member Functions inherited from blender::nodes::SocketDeclaration
	~SocketDeclaration () override=default
void	make_available (bNode &node) const
const CompositorInputRealizationMode &	compositor_realization_mode () const
int	compositor_domain_priority () const
Public Member Functions inherited from blender::nodes::ItemDeclaration
virtual	~ItemDeclaration ()=default

Public Attributes
std::optional< int >	pass_through_input_index
friend	BundleBuilder
Public Attributes inherited from blender::nodes::SocketDeclaration
std::string	name
std::string	short_label
std::string	identifier
std::string	description
std::optional< std::string >	translation_context
eNodeSocketInOut	in_out
eNodeSocketDatatype	socket_type
bool	optional_label = false
bool	hide_value = false
bool	compact = false
bool	is_multi_input = false
bool	no_mute_links = false
bool	is_available = true
bool	is_attribute_name = false
bool	is_default_link_socket = false
bool	align_with_previous_socket = false
bool	is_panel_toggle = false
bool	is_layer_name = false
bool	is_volume_grid_name = false
int	index = -1
InputSocketFieldType	input_field_type = InputSocketFieldType::None
OutputFieldDependency	output_field_dependency
StructureType	structure_type = StructureType::Single
NodeDefaultInputType	default_input_type = NodeDefaultInputType::NODE_DEFAULT_INPUT_VALUE
std::unique_ptr< SocketNameRNA >	socket_name_rna
std::unique_ptr< CustomSocketDrawFn >	custom_draw_fn
std::unique_ptr< InputSocketUsageInferenceFn >	usage_inference_fn
friend	NodeDeclarationBuilder
Public Attributes inherited from blender::nodes::ItemDeclaration
const PanelDeclaration *	parent = nullptr

Static Public Attributes
static constexpr eNodeSocketDatatype	static_socket_type = SOCK_BUNDLE

Additional Inherited Members
Protected Member Functions inherited from blender::nodes::SocketDeclaration
void	set_common_flags (bNodeSocket &socket) const
bool	matches_common_data (const bNodeSocket &socket) const

Detailed Description

Definition at line 261 of file NOD_socket_declarations.hh.

Member Typedef Documentation

Builder

using blender::nodes::decl::Bundle::Builder = BundleBuilder

Definition at line 272 of file NOD_socket_declarations.hh.

Member Function Documentation

build()

bNodeSocket & blender::nodes::decl::Bundle::build ( bNodeTree & ntree, bNode & node ) const

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 637 of file node_socket_declarations.cc.

References blender::nodes::SocketDeclaration::identifier, blender::nodes::SocketDeclaration::in_out, blender::bke::node_add_static_socket(), PROP_NONE, blender::nodes::SocketDeclaration::set_common_flags(), and SOCK_BUNDLE.

Referenced by update_or_build().

can_connect()

bool blender::nodes::decl::Bundle::can_connect ( const bNodeSocket & socket ) const

overridevirtual

Determine if a new socket described by this declaration could have a valid connection the other socket.

Implements blender::nodes::SocketDeclaration.

Definition at line 661 of file node_socket_declarations.cc.

References ELEM, SOCK_BUNDLE, blender::nodes::decl::sockets_can_connect(), and bNodeSocket::type.

matches()

bool blender::nodes::decl::Bundle::matches ( const bNodeSocket & socket ) const

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 650 of file node_socket_declarations.cc.

References blender::nodes::SocketDeclaration::matches_common_data(), SOCK_BUNDLE, and bNodeSocket::type.

update_or_build()

bNodeSocket & blender::nodes::decl::Bundle::update_or_build ( bNodeTree & ntree, bNode & node, bNodeSocket & socket ) const

overridevirtual

Reimplemented from blender::nodes::SocketDeclaration.

Definition at line 669 of file node_socket_declarations.cc.

References BLI_assert, build(), bNodeSocket::in_out, blender::nodes::SocketDeclaration::set_common_flags(), SOCK_BUNDLE, and bNodeSocket::type.

Member Data Documentation

BundleBuilder

friend blender::nodes::decl::Bundle::BundleBuilder

Definition at line 270 of file NOD_socket_declarations.hh.

pass_through_input_index

std::optional<int> blender::nodes::decl::Bundle::pass_through_input_index

Index of a corresponding input socket. If set, the output is assumed to have the same bundle structure as the input.

Definition at line 268 of file NOD_socket_declarations.hh.

static_socket_type

eNodeSocketDatatype blender::nodes::decl::Bundle::static_socket_type = SOCK_BUNDLE

staticconstexpr

Definition at line 263 of file NOD_socket_declarations.hh.

---

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

• NOD_socket_declarations.hh
• node_socket_declarations.cc