blender::nodes::decl::Vector Class Reference

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclaration.

Public Types
using	Builder = VectorBuilder

Public Member Functions
#Vector
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
float4	default_value = {0, 0, 0, 0}
float	soft_min_value = -FLT_MAX
float	soft_max_value = FLT_MAX
int	dimensions = 3
PropertySubType	subtype = PROP_NONE
friend	VectorBuilder
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_VECTOR

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

Member Typedef Documentation

Builder

using blender::nodes::decl::Vector::Builder = VectorBuilder

Definition at line 89 of file NOD_socket_declarations.hh.

Member Function Documentation

build()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 224 of file node_socket_declarations.cc.

References blender::StringRefNull::c_str(), default_value, bNodeSocket::default_value, dimensions, blender::nodes::SocketDeclaration::identifier, blender::nodes::SocketDeclaration::in_out, bNodeSocketValueVector::max, bNodeSocketValueVector::min, node, blender::bke::node_add_socket(), blender::bke::node_static_socket_type(), blender::nodes::SocketDeclaration::set_common_flags(), SOCK_VECTOR, soft_max_value, soft_min_value, subtype, this, bNodeSocketValueVector::value, and value.

Referenced by update_or_build().

can_connect()

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

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

matches()

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

overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 239 of file node_socket_declarations.cc.

References bNodeSocket::default_value, blender::nodes::SocketDeclaration::matches_common_data(), SOCK_VECTOR, this, bNodeSocket::type, bNodeSocket::typeinfo, and value.

update_or_build()

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

overridevirtual

Reimplemented from blender::nodes::SocketDeclaration.

Definition at line 275 of file node_socket_declarations.cc.

References BLI_assert, build(), bNodeSocket::default_value, dimensions, bNodeSocketValueVector::dimensions, bNodeSocket::in_out, bNodeSocketValueVector::max, bNodeSocketValueVector::min, blender::nodes::decl::modify_subtype_except_for_storage(), node, blender::nodes::SocketDeclaration::set_common_flags(), SOCK_VECTOR, soft_max_value, soft_min_value, subtype, bNodeSocketValueVector::subtype, this, bNodeSocket::type, bNodeSocket::typeinfo, and value.

Member Data Documentation

default_value

float4 blender::nodes::decl::Vector::default_value = {0, 0, 0, 0}

Definition at line 81 of file NOD_socket_declarations.hh.

Referenced by build(), blender::nodes::node_composite_blur_cc::cmp_node_blur_declare(), blender::nodes::node_composite_displace_cc::cmp_node_displace_declare(), blender::nodes::node_composite_vec_blur_cc::cmp_node_vec_blur_declare(), blender::nodes::node_geo_points_cc::node_declare(), blender::nodes::node_geo_scale_instances_cc::node_declare(), and blender::nodes::node_shader_vector_rotate_cc::sh_node_vector_rotate_declare().

dimensions

int blender::nodes::decl::Vector::dimensions = 3

Definition at line 84 of file NOD_socket_declarations.hh.

Referenced by build(), blender::nodes::node_composite_boxmask_cc::cmp_node_boxmask_declare(), blender::nodes::node_composite_cornerpin_cc::cmp_node_cornerpin_declare(), blender::nodes::node_composite_directionalblur_cc::cmp_node_directional_blur_declare(), blender::nodes::node_composite_ellipsemask_cc::cmp_node_ellipsemask_declare(), blender::nodes::node_composite_sunbeams_cc::cmp_node_sunbeams_declare(), blender::nodes::node_composite_trackpos_cc::cmp_node_trackpos_declare(), blender::nodes::node_composite_relative_to_pixel_cc::node_declare(), and update_or_build().

soft_max_value

float blender::nodes::decl::Vector::soft_max_value = FLT_MAX

Definition at line 83 of file NOD_socket_declarations.hh.

Referenced by build(), and update_or_build().

soft_min_value

float blender::nodes::decl::Vector::soft_min_value = -FLT_MAX

Definition at line 82 of file NOD_socket_declarations.hh.

Referenced by build(), and update_or_build().

static_socket_type

eNodeSocketDatatype blender::nodes::decl::Vector::static_socket_type = SOCK_VECTOR

staticconstexpr

Definition at line 79 of file NOD_socket_declarations.hh.

subtype

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

Definition at line 85 of file NOD_socket_declarations.hh.

Referenced by build(), blender::nodes::node_composite_normal_cc::cmp_node_normal_declare(), blender::nodes::node_composite_texture_cc::cmp_node_texture_declare(), blender::nodes::node_geo_distribute_points_in_grid_cc::node_declare(), blender::nodes::node_geo_distribute_points_in_volume_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_cube_cc::node_declare(), blender::nodes::node_shader_mapping_cc::node_declare(), blender::nodes::node_shader_normal_cc::node_declare(), blender::nodes::node_sh_mix_cc::sh_node_mix_declare(), and update_or_build().

VectorBuilder

friend blender::nodes::decl::Vector::VectorBuilder

Definition at line 87 of file NOD_socket_declarations.hh.

---

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

• NOD_socket_declarations.hh
• node_socket_declarations.cc