Blender: blender::nodes::decl::Bool Class Reference

Blender V4.5

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclaration.

Public Types
using	Builder = BoolBuilder

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

void	make_available (bNode &node) const

const CompositorInputRealizationMode &	compositor_realization_mode () 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
bool	default_value = false

friend	BoolBuilder

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

std::string	short_label

std::string	identifier

std::string	description

std::optional< 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

bool	is_panel_toggle = false

bool	is_layer_name = false

int	index = -1

InputSocketFieldType	input_field_type = InputSocketFieldType::None

OutputFieldDependency	output_field_dependency

StructureType	structure_type = StructureType::Single

NodeDefaultInputType	default_input_type = NodeDefaultInputType::NODE_DEFAULT_INPUT_VALUE

std::unique_ptr< SocketNameRNA >	socket_name_rna

std::unique_ptr< CustomSocketDrawFn >	custom_draw_fn

friend	NodeDeclarationBuilder

Public Attributes inherited from blender::nodes::ItemDeclaration
const PanelDeclaration *	parent = nullptr

Static Public Attributes
static constexpr eNodeSocketDatatype	static_socket_type = SOCK_BOOLEAN

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

Member Typedef Documentation

◆ Builder

using blender::nodes::decl::Bool::Builder = BoolBuilder

Definition at line 118 of file NOD_socket_declarations.hh.

Member Function Documentation

◆ build()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 302 of file node_socket_declarations.cc.

References default_value, bNodeSocket::default_value, blender::nodes::SocketDeclaration::identifier, blender::nodes::SocketDeclaration::in_out, node, blender::bke::node_add_static_socket(), PROP_NONE, blender::nodes::SocketDeclaration::set_common_flags(), SOCK_BOOLEAN, this, and value.

Referenced by update_or_build().

◆ can_connect()

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

References blender::nodes::decl::basic_types_can_connect(), and blender::nodes::decl::sockets_can_connect().

◆ matches()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 317 of file node_socket_declarations.cc.

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

◆ update_or_build()

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

overridevirtual

Reimplemented from blender::nodes::SocketDeclaration.

Definition at line 336 of file node_socket_declarations.cc.

References BLI_assert, build(), bNodeSocket::in_out, node, blender::nodes::SocketDeclaration::set_common_flags(), SOCK_BOOLEAN, this, and bNodeSocket::type.

Member Data Documentation

◆ BoolBuilder

friend blender::nodes::decl::Bool::BoolBuilder

Definition at line 116 of file NOD_socket_declarations.hh.

◆ default_value

bool blender::nodes::decl::Bool::default_value = false

Definition at line 115 of file NOD_socket_declarations.hh.

Referenced by build().

◆ static_socket_type

eNodeSocketDatatype blender::nodes::decl::Bool::static_socket_type = SOCK_BOOLEAN

staticconstexpr

Definition at line 113 of file NOD_socket_declarations.hh.

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