blender::nodes::NodeDeclarationBuilder Class Reference

#include <NOD_node_declaration.hh>

Public Member Functions
	NodeDeclarationBuilder (NodeDeclaration &declaration, const bNodeTree *ntree=nullptr, const bNode *node=nullptr)
const bNode *	node_or_null () const
const bNodeTree *	tree_or_null () const
void	is_function_node ()
void	finalize ()
void	use_custom_socket_order (bool enable=true)
void	allow_any_socket_order (bool enable=true)
PanelDeclarationBuilder &	add_panel (StringRef name, int identifier=-1)
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 ()
aal::RelationsInNode &	get_anonymous_attribute_relations ()
NodeDeclaration &	declaration ()

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

Detailed Description

Definition at line 525 of file NOD_node_declaration.hh.

Constructor & Destructor Documentation

NodeDeclarationBuilder()

blender::nodes::NodeDeclarationBuilder::NodeDeclarationBuilder	(	NodeDeclaration &	declaration,
		const bNodeTree *	ntree = nullptr,
		const bNode *	node = nullptr )

Definition at line 96 of file node_declaration.cc.

Member Function Documentation

add_input() [1/3]

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

Definition at line 479 of file node_declaration.cc.

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

add_input() [2/3]

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

Definition at line 464 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::NodeDeclarationBuilder::add_input ( StringRef name, StringRef identifier = "" )

inline

Definition at line 692 of file NOD_node_declaration.hh.

References SOCK_IN.

Referenced by add_input(), and add_input().

add_output() [1/3]

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

Definition at line 501 of file node_declaration.cc.

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

add_output() [2/3]

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

Definition at line 486 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::NodeDeclarationBuilder::add_output ( StringRef name, StringRef identifier = "" )

inline

Definition at line 700 of file NOD_node_declaration.hh.

References SOCK_OUT.

Referenced by add_output(), and add_output().

add_panel()

PanelDeclarationBuilder & blender::nodes::NodeDeclarationBuilder::add_panel	(	StringRef	name,
		int	identifier = -1 )

Definition at line 357 of file node_declaration.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::nodes::NodeDeclaration::items, and blender::Vector< T, InlineBufferCapacity, Allocator >::size().

add_separator()

void blender::nodes::NodeDeclarationBuilder::add_separator

(

)

Definition at line 508 of file node_declaration.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), and blender::nodes::NodeDeclaration::items.

Referenced by blender::nodes::PanelDeclarationBuilder::add_separator().

allow_any_socket_order()

void blender::nodes::NodeDeclarationBuilder::allow_any_socket_order

(

bool

enable = true

)

Definition at line 108 of file node_declaration.cc.

References blender::nodes::NodeDeclaration::allow_any_socket_order, BLI_assert, and blender::nodes::NodeDeclaration::use_custom_socket_order.

declaration()

NodeDeclaration & blender::nodes::NodeDeclarationBuilder::declaration ( )

inline

Definition at line 599 of file NOD_node_declaration.hh.

finalize()

void blender::nodes::NodeDeclarationBuilder::finalize

(

)

Definition at line 90 of file node_declaration.cc.

References BLI_assert, and blender::nodes::NodeDeclaration::is_valid().

get_anonymous_attribute_relations()

aal::RelationsInNode & blender::nodes::NodeDeclarationBuilder::get_anonymous_attribute_relations ( )

inline

Definition at line 591 of file NOD_node_declaration.hh.

References blender::nodes::NodeDeclaration::anonymous_attribute_relations_.

Referenced by blender::nodes::BaseSocketDeclarationBuilder::field_on(), and blender::nodes::BaseSocketDeclarationBuilder::reference_pass().

is_function_node()

void blender::nodes::NodeDeclarationBuilder::is_function_node ( )

inline

All inputs support fields, and all outputs are fields if any of the inputs is a field. Calling field status definitions on each socket is unnecessary.

Definition at line 560 of file NOD_node_declaration.hh.

node_or_null()

const bNode * blender::nodes::NodeDeclarationBuilder::node_or_null ( ) const

inline

Definition at line 544 of file NOD_node_declaration.hh.

References blender::nodes::NodeDeclaration::is_context_dependent.

tree_or_null()

const bNodeTree * blender::nodes::NodeDeclarationBuilder::tree_or_null ( ) const

inline

Definition at line 550 of file NOD_node_declaration.hh.

References blender::nodes::NodeDeclaration::is_context_dependent.

use_custom_socket_order()

void blender::nodes::NodeDeclarationBuilder::use_custom_socket_order

(

bool

enable = true

)

Definition at line 103 of file node_declaration.cc.

References blender::nodes::NodeDeclaration::use_custom_socket_order.

---

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

• NOD_node_declaration.hh
• node_declaration.cc