Blender: blender::nodes::PanelDeclarationBuilder Class Reference

Blender V4.3

#include <NOD_node_declaration.hh>

Public Member Functions
Self &	description (std::string value="")

Self &	default_closed (bool closed)

Self &	draw_buttons (PanelDrawButtonsFunction func)

BaseSocketDeclarationBuilder &	add_input (eNodeSocketDatatype socket_type, StringRef name, StringRef identifier="")

BaseSocketDeclarationBuilder &	add_input (eCustomDataType data_type, StringRef name, StringRef identifier="")

BaseSocketDeclarationBuilder &	add_output (eNodeSocketDatatype socket_type, StringRef name, StringRef identifier="")

BaseSocketDeclarationBuilder &	add_output (eCustomDataType data_type, StringRef name, StringRef identifier="")

void	add_separator ()

#PanelDeclarationBuilder Inline Methods
template<typename DeclType >
DeclType::Builder &	add_input (StringRef name, StringRef identifier="")

template<typename DeclType >
DeclType::Builder &	add_output (StringRef name, StringRef identifier="")

Protected Types
using	Self = PanelDeclarationBuilder

Protected Attributes
NodeDeclarationBuilder *	node_decl_builder_ = nullptr

PanelDeclaration *	decl_

bool	is_complete_ = false

Friends
class	NodeDeclarationBuilder

Detailed Description

Definition at line 440 of file NOD_node_declaration.hh.

Member Typedef Documentation

◆ Self

using blender::nodes::PanelDeclarationBuilder::Self = PanelDeclarationBuilder

protected

Definition at line 442 of file NOD_node_declaration.hh.

Member Function Documentation

◆ add_input() [1/3]

BaseSocketDeclarationBuilder & blender::nodes::PanelDeclarationBuilder::add_input	(	eCustomDataType	data_type,
		StringRef	name,
		StringRef	identifier = "" )

Definition at line 528 of file node_declaration.cc.

References add_input(), and blender::bke::custom_data_type_to_socket_type().

◆ add_input() [2/3]

BaseSocketDeclarationBuilder & blender::nodes::PanelDeclarationBuilder::add_input	(	eNodeSocketDatatype	socket_type,
		StringRef	name,
		StringRef	identifier = "" )

Definition at line 513 of file node_declaration.cc.

References add_input(), BLI_assert_unreachable, and blender::nodes::socket_type_to_static_decl_type().

◆ add_input() [3/3]

template<typename DeclType >

DeclType::Builder & blender::nodes::PanelDeclarationBuilder::add_input	(	StringRef	name,
		StringRef	identifier = "" )

Definition at line 639 of file NOD_node_declaration.hh.

References BLI_assert_unreachable, decl_, is_complete_, blender::nodes::PanelDeclaration::num_child_decls, and SOCK_IN.

Referenced by add_input(), add_input(), and blender::nodes::node_shader_bsdf_principled_cc::node_declare().

◆ add_output() [1/3]

BaseSocketDeclarationBuilder & blender::nodes::PanelDeclarationBuilder::add_output	(	eCustomDataType	data_type,
		StringRef	name,
		StringRef	identifier = "" )

Definition at line 550 of file node_declaration.cc.

References add_output(), and blender::bke::custom_data_type_to_socket_type().

◆ add_output() [2/3]

BaseSocketDeclarationBuilder & blender::nodes::PanelDeclarationBuilder::add_output	(	eNodeSocketDatatype	socket_type,
		StringRef	name,
		StringRef	identifier = "" )

Definition at line 535 of file node_declaration.cc.

References add_output(), BLI_assert_unreachable, and blender::nodes::socket_type_to_static_decl_type().

◆ add_output() [3/3]

template<typename DeclType >

DeclType::Builder & blender::nodes::PanelDeclarationBuilder::add_output	(	StringRef	name,
		StringRef	identifier = "" )

Definition at line 652 of file NOD_node_declaration.hh.

References BLI_assert_unreachable, decl_, is_complete_, blender::nodes::PanelDeclaration::num_child_decls, and SOCK_OUT.

Referenced by add_output(), add_output(), and blender::nodes::node_fn_separate_matrix_cc::node_declare().

◆ add_separator()

void blender::nodes::PanelDeclarationBuilder::add_separator ( )

Definition at line 557 of file node_declaration.cc.

References blender::nodes::NodeDeclarationBuilder::add_separator(), BLI_assert_unreachable, decl_, is_complete_, node_decl_builder_, and blender::nodes::PanelDeclaration::num_child_decls.

◆ default_closed()

PanelDeclarationBuilder & blender::nodes::PanelDeclarationBuilder::default_closed ( bool closed )

Definition at line 879 of file node_declaration.cc.

References decl_, and blender::nodes::PanelDeclaration::default_collapsed.

◆ description()

PanelDeclarationBuilder & blender::nodes::PanelDeclarationBuilder::description ( std::string value = "" )

Definition at line 873 of file node_declaration.cc.

References decl_, and blender::nodes::PanelDeclaration::description.

◆ draw_buttons()

PanelDeclarationBuilder & blender::nodes::PanelDeclarationBuilder::draw_buttons ( PanelDrawButtonsFunction func )

Definition at line 885 of file node_declaration.cc.

References decl_, and blender::nodes::PanelDeclaration::draw_buttons.

Friends And Related Symbol Documentation

◆ NodeDeclarationBuilder

friend class NodeDeclarationBuilder

friend

Definition at line 451 of file NOD_node_declaration.hh.

Member Data Documentation

◆ decl_

PanelDeclaration* blender::nodes::PanelDeclarationBuilder::decl_

protected

Definition at line 444 of file NOD_node_declaration.hh.

Referenced by add_input(), add_output(), add_separator(), default_closed(), description(), and draw_buttons().

◆ is_complete_

bool blender::nodes::PanelDeclarationBuilder::is_complete_ = false

protected

Panel is complete once items are added after it. Completed panels are locked and no more items can be added.

Definition at line 449 of file NOD_node_declaration.hh.

Referenced by add_input(), add_output(), and add_separator().

◆ node_decl_builder_

NodeDeclarationBuilder* blender::nodes::PanelDeclarationBuilder::node_decl_builder_ = nullptr

protected

Definition at line 443 of file NOD_node_declaration.hh.

Referenced by add_separator().

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