Blender: blender::nodes::decl::Custom Class Reference

Blender V4.3

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclaration.

Public Types
using	Builder = CustomTypeBuilder

Public Member Functions
#Custom
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
virtual	~SocketDeclaration ()=default

void	make_available (bNode &node) const

const CompositorInputRealizationOptions &	compositor_realization_options () const

int	compositor_domain_priority () const

bool	compositor_expects_single_value () const

Public Member Functions inherited from blender::nodes::ItemDeclaration
virtual	~ItemDeclaration ()=default

Public Attributes
friend	CustomTypeBuilder

const char *	idname_

std::function< void(bNode &node, bNodeSocket &socket, const char *data_path)>	init_socket_fn

Public Attributes inherited from blender::nodes::SocketDeclaration
std::string	name

std::string	short_label

std::string	identifier

std::string	description

std::string	translation_context

eNodeSocketInOut	in_out

eNodeSocketDatatype	socket_type

bool	hide_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

InputSocketFieldType	input_field_type = InputSocketFieldType::None

OutputFieldDependency	output_field_dependency

std::unique_ptr< ImplicitInputValueFn >	implicit_input_fn

std::unique_ptr< SocketNameRNA >	socket_name_rna

friend	NodeDeclarationBuilder

Static Public Attributes
static constexpr eNodeSocketDatatype	static_socket_type = SOCK_CUSTOM

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 341 of file NOD_socket_declarations.hh.

Member Typedef Documentation

◆ Builder

using blender::nodes::decl::Custom::Builder = CustomTypeBuilder

Definition at line 347 of file NOD_socket_declarations.hh.

Member Function Documentation

◆ build()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 795 of file node_socket_declarations.cc.

References idname_, blender::nodes::SocketDeclaration::in_out, init_socket_fn, and blender::bke::node_add_socket().

Referenced by update_or_build().

◆ can_connect()

bool blender::nodes::decl::Custom::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 819 of file node_socket_declarations.cc.

References bNodeSocket::idname, idname_, blender::nodes::decl::sockets_can_connect(), and STREQ.

◆ matches()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 805 of file node_socket_declarations.cc.

References idname_, blender::nodes::SocketDeclaration::matches_common_data(), SOCK_CUSTOM, STREQ, bNodeSocket::type, and bNodeSocket::typeinfo.

◆ update_or_build()

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

overridevirtual

Reimplemented from blender::nodes::SocketDeclaration.

Definition at line 824 of file node_socket_declarations.cc.

References build(), idname_, blender::nodes::SocketDeclaration::set_common_flags(), STREQ, and bNodeSocket::typeinfo.

Member Data Documentation

◆ CustomTypeBuilder

friend blender::nodes::decl::Custom::CustomTypeBuilder

Definition at line 345 of file NOD_socket_declarations.hh.

◆ idname_

const char* blender::nodes::decl::Custom::idname_

Definition at line 349 of file NOD_socket_declarations.hh.

Referenced by build(), can_connect(), matches(), and update_or_build().

◆ init_socket_fn

std::function<void(bNode &node, bNodeSocket &socket, const char *data_path)> blender::nodes::decl::Custom::init_socket_fn

Definition at line 350 of file NOD_socket_declarations.hh.

Referenced by build().

◆ static_socket_type

eNodeSocketDatatype blender::nodes::decl::Custom::static_socket_type = SOCK_CUSTOM

staticconstexpr

Definition at line 343 of file NOD_socket_declarations.hh.

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