Blender V5.0
Public Types | Public Attributes | Static Public Attributes | List of all members
blender::nodes::decl::Color Class Reference

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclaration.

Public Types

using Builder = ColorBuilder

Public Member Functions

#Color
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
Public Member Functions inherited from blender::nodes::ItemDeclaration
virtual ~ItemDeclaration ()=default

Public Attributes

ColorGeometry4f default_value {0.8f, 0.8f, 0.8f, 1.0f}
friend ColorBuilder
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 optional_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
bool is_volume_grid_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
std::unique_ptr< InputSocketUsageInferenceFn > usage_inference_fn
friend NodeDeclarationBuilder
Public Attributes inherited from blender::nodes::ItemDeclaration
const PanelDeclaration * parent = nullptr

Static Public Attributes

static constexpr eNodeSocketDatatype static_socket_type = SOCK_RGBA

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

Member Typedef Documentation

◆ Builder

using blender::nodes::decl::Color::Builder = ColorBuilder

Definition at line 147 of file NOD_socket_declarations.hh.

Member Function Documentation

◆ build()

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

Implements blender::nodes::SocketDeclaration.

Definition at line 352 of file node_socket_declarations.cc.

References copy_v4_v4(), bNodeSocket::default_value, blender::nodes::SocketDeclaration::identifier, blender::nodes::SocketDeclaration::in_out, blender::bke::node_add_static_socket(), PROP_NONE, blender::nodes::SocketDeclaration::set_common_flags(), SOCK_RGBA, and bNodeSocketValueRGBA::value.

Referenced by update_or_build().

◆ can_connect()

bool blender::nodes::decl::Color::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 378 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::Color::matches ( const bNodeSocket & socket) const
overridevirtual

Implements blender::nodes::SocketDeclaration.

Definition at line 367 of file node_socket_declarations.cc.

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

◆ update_or_build()

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

Reimplemented from blender::nodes::SocketDeclaration.

Definition at line 386 of file node_socket_declarations.cc.

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

Member Data Documentation

◆ ColorBuilder

friend blender::nodes::decl::Color::ColorBuilder

Definition at line 145 of file NOD_socket_declarations.hh.

◆ default_value

ColorGeometry4f blender::nodes::decl::Color::default_value {0.8f, 0.8f, 0.8f, 1.0f}

Definition at line 143 of file NOD_socket_declarations.hh.

Referenced by blender::nodes::node_composite_convert_color_space_cc::CMP_NODE_CONVERT_COLOR_SPACE_declare(), blender::nodes::node_composite_defocus_cc::cmp_node_defocus_declare(), blender::nodes::node_composite_separate_color_cc::cmp_node_separate_color_declare(), blender::nodes::node_composite_convert_to_display_cc::node_declare(), blender::nodes::node_fn_separate_color_cc::node_declare(), blender::nodes::node_sh_mix_cc::sh_node_mix_declare(), and blender::nodes::node_shader_separate_color_cc::sh_node_sepcolor_declare().

◆ static_socket_type

eNodeSocketDatatype blender::nodes::decl::Color::static_socket_type = SOCK_RGBA
staticconstexpr

Definition at line 141 of file NOD_socket_declarations.hh.

The documentation for this class was generated from the following files:
Generated on for Blender by  doxygen 1.16.1