Blender: blender::nodes::decl::String Class Reference

Blender V4.3

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclaration.

Public Types
using	Builder = StringBuilder

Public Member Functions
#String
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
std::string	default_value

PropertySubType	subtype = PROP_NONE

friend	StringBuilder

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_STRING

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

Member Typedef Documentation

◆ Builder

using blender::nodes::decl::String::Builder = StringBuilder

Definition at line 202 of file NOD_socket_declarations.hh.

Member Function Documentation

◆ build()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 492 of file node_socket_declarations.cc.

References bNodeSocket::default_value, blender::nodes::SocketDeclaration::in_out, blender::bke::node_add_static_socket(), blender::nodes::SocketDeclaration::set_common_flags(), SOCK_STRING, STRNCPY, and subtype.

Referenced by update_or_build().

◆ can_connect()

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

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

◆ matches()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 506 of file node_socket_declarations.cc.

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

◆ update_or_build()

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

overridevirtual

Reimplemented from blender::nodes::SocketDeclaration.

Definition at line 525 of file node_socket_declarations.cc.

References BLI_assert, build(), bNodeSocket::default_value, bNodeSocket::in_out, blender::nodes::decl::modify_subtype_except_for_storage(), blender::nodes::SocketDeclaration::set_common_flags(), SOCK_STRING, subtype, bNodeSocket::type, and bNodeSocket::typeinfo.

Member Data Documentation

◆ default_value

std::string blender::nodes::decl::String::default_value

Definition at line 197 of file NOD_socket_declarations.hh.

◆ static_socket_type

eNodeSocketDatatype blender::nodes::decl::String::static_socket_type = SOCK_STRING

staticconstexpr

Definition at line 195 of file NOD_socket_declarations.hh.

◆ StringBuilder

friend blender::nodes::decl::String::StringBuilder

Definition at line 200 of file NOD_socket_declarations.hh.

◆ subtype

PropertySubType blender::nodes::decl::String::subtype = PROP_NONE

Definition at line 198 of file NOD_socket_declarations.hh.

Referenced by build(), and update_or_build().

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