blender::nodes::decl::BundleBuilder Class Reference

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclarationBuilder< Bundle >.

Public Member Functions
#Bundle
BundleBuilder &	pass_through_input_index (std::optional< int > index)
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 (std::string 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 &	supports_field ()
BaseSocketDeclarationBuilder &	field_on_all ()
BaseSocketDeclarationBuilder &	field_source ()
BaseSocketDeclarationBuilder &	implicit_field (NodeDefaultInputType default_input)
BaseSocketDeclarationBuilder &	implicit_field_on_all (NodeDefaultInputType default_input)
BaseSocketDeclarationBuilder &	implicit_field_on (NodeDefaultInputType default_input, 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 &	propagate_all_instance_attributes ()
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 (InputSocketUsageInferenceFn fn)
BaseSocketDeclarationBuilder &	usage_by_single_menu (const int menu_value)
BaseSocketDeclarationBuilder &	usage_by_menu (const StringRef menu_input_identifier, const int menu_value)
BaseSocketDeclarationBuilder &	usage_by_menu (const StringRef menu_input_identifier, const Array< int > menu_values)
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)
int	index () const
bool	is_input () const
bool	is_output () const

Additional Inherited Members
Protected Types inherited from blender::nodes::SocketDeclarationBuilder< Bundle >
using	Self
Protected Attributes inherited from blender::nodes::SocketDeclarationBuilder< Bundle >
Bundle *	decl_
Protected Attributes inherited from blender::nodes::BaseSocketDeclarationBuilder
bool	reference_pass_all_ = false
bool	field_on_all_ = false
bool	propagate_from_all_ = false
NodeDeclarationBuilder *	node_decl_builder_ = nullptr
SocketDeclaration *	decl_base_ = nullptr

Detailed Description

Definition at line 280 of file NOD_socket_declarations.hh.

Member Function Documentation

pass_through_input_index()

BundleBuilder & blender::nodes::decl::BundleBuilder::pass_through_input_index

(

std::optional< int >

index

)

On output sockets, indicate that the bundle structure is passed through from an input.

Definition at line 679 of file node_socket_declarations.cc.

References BLI_assert, blender::nodes::SocketDeclarationBuilder< Bundle >::decl_, blender::nodes::BaseSocketDeclarationBuilder::index(), and blender::nodes::BaseSocketDeclarationBuilder::is_output().

---

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

• NOD_socket_declarations.hh
• node_socket_declarations.cc