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

#include <NOD_socket_declarations.hh>

Inherits blender::nodes::SocketDeclaration.

Public Types

using Builder = FloatBuilder

Public Member Functions

#Float
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

float default_value = 0.0f
float soft_min_value = -FLT_MAX
float soft_max_value = FLT_MAX
PropertySubType subtype = PROP_NONE
friend FloatBuilder
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_FLOAT

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

Member Typedef Documentation

◆ Builder

using blender::nodes::decl::Float::Builder = FloatBuilder

Definition at line 36 of file NOD_socket_declarations.hh.

Member Function Documentation

◆ build()

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

Implements blender::nodes::SocketDeclaration.

Definition at line 83 of file node_socket_declarations.cc.

References default_value, bNodeSocket::default_value, blender::nodes::SocketDeclaration::identifier, blender::nodes::SocketDeclaration::in_out, bNodeSocketValueFloat::max, bNodeSocketValueFloat::min, blender::bke::node_add_static_socket(), blender::nodes::SocketDeclaration::set_common_flags(), SOCK_FLOAT, soft_max_value, soft_min_value, subtype, and bNodeSocketValueFloat::value.

Referenced by update_or_build().

◆ can_connect()

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

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

◆ matches()

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

Implements blender::nodes::SocketDeclaration.

Definition at line 100 of file node_socket_declarations.cc.

References bNodeSocket::default_value, blender::nodes::SocketDeclaration::matches_common_data(), bNodeSocketValueFloat::max, bNodeSocketValueFloat::min, SOCK_FLOAT, bNodeSocket::type, and bNodeSocket::typeinfo.

◆ update_or_build()

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

Reimplemented from blender::nodes::SocketDeclaration.

Definition at line 132 of file node_socket_declarations.cc.

References BLI_assert, build(), bNodeSocket::default_value, bNodeSocket::in_out, bNodeSocketValueFloat::max, bNodeSocketValueFloat::min, blender::nodes::decl::modify_subtype_except_for_storage(), blender::nodes::SocketDeclaration::set_common_flags(), SOCK_FLOAT, soft_max_value, soft_min_value, subtype, bNodeSocketValueFloat::subtype, bNodeSocket::type, and bNodeSocket::typeinfo.

Member Data Documentation

◆ default_value

float blender::nodes::decl::Float::default_value = 0.0f

Definition at line 29 of file NOD_socket_declarations.hh.

Referenced by build(), blender::nodes::build_interface_socket_declaration(), blender::nodes::node_composite_boxmask_cc::cmp_node_boxmask_declare(), blender::nodes::node_composite_combine_color_cc::cmp_node_combine_color_declare(), blender::nodes::node_composite_defocus_cc::cmp_node_defocus_declare(), blender::nodes::node_composite_ellipsemask_cc::cmp_node_ellipsemask_declare(), blender::nodes::node_composite_keyingscreen_cc::cmp_node_keyingscreen_declare(), blender::nodes::node_composite_planetrackdeform_cc::cmp_node_planetrackdeform_declare(), blender::nodes::node_fn_combine_color_cc::node_declare(), blender::nodes::node_fn_compare_cc::node_declare(), blender::nodes::node_fn_random_value_cc::node_declare(), blender::nodes::node_geo_curve_primitive_arc_cc::node_declare(), blender::nodes::node_geo_curve_primitive_circle_cc::node_declare(), blender::nodes::node_geo_curve_primitive_line_cc::node_declare(), blender::nodes::node_geo_curve_primitive_quadrilateral_cc::node_declare(), blender::nodes::node_geo_curve_to_points_cc::node_declare(), blender::nodes::node_geo_extrude_mesh_cc::node_declare(), blender::nodes::node_geo_gizmo_dial_cc::node_declare(), blender::nodes::node_geo_grid_advect_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_circle_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_cone_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_cylinder_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_line_cc::node_declare(), blender::nodes::node_geo_mesh_to_density_grid_cc::node_declare(), blender::nodes::node_geo_mesh_to_points_cc::node_declare(), blender::nodes::node_geo_points_cc::node_declare(), blender::nodes::node_geo_sdf_grid_offset_cc::node_declare(), blender::nodes::node_geo_set_curve_radius_cc::node_declare(), blender::nodes::node_geo_string_to_curves_cc::node_declare(), blender::nodes::node_geo_subdivision_surface_cc::node_declare(), blender::nodes::node_shader_combine_color_cc::sh_node_combcolor_declare(), blender::nodes::node_shader_curves_cc::flt::sh_node_curve_float_declare(), blender::nodes::node_shader_curves_cc::rgb::sh_node_curve_rgb_declare(), blender::nodes::node_shader_curves_cc::vec::sh_node_curve_vec_declare(), blender::nodes::node_sh_mix_cc::sh_node_mix_declare(), blender::nodes::node_shader_tex_brick_cc::sh_node_tex_brick_declare(), blender::nodes::node_shader_tex_checker_cc::sh_node_tex_checker_declare(), blender::nodes::node_shader_tex_gabor_cc::sh_node_tex_gabor_declare(), blender::nodes::node_shader_tex_magic_cc::sh_node_tex_magic_declare(), and blender::nodes::node_shader_tex_wave_cc::sh_node_tex_wave_declare().

◆ FloatBuilder

friend blender::nodes::decl::Float::FloatBuilder

Definition at line 34 of file NOD_socket_declarations.hh.

◆ soft_max_value

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

Definition at line 31 of file NOD_socket_declarations.hh.

Referenced by build(), and update_or_build().

◆ soft_min_value

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

Definition at line 30 of file NOD_socket_declarations.hh.

Referenced by build(), and update_or_build().

◆ static_socket_type

eNodeSocketDatatype blender::nodes::decl::Float::static_socket_type = SOCK_FLOAT
staticconstexpr

Definition at line 27 of file NOD_socket_declarations.hh.

◆ subtype

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

Definition at line 32 of file NOD_socket_declarations.hh.

Referenced by build(), blender::nodes::node_composite_antialiasing_cc::cmp_node_antialiasing_declare(), blender::nodes::node_composite_bokehimage_cc::cmp_node_bokehimage_declare(), blender::nodes::node_composite_channel_matte_cc::cmp_node_channel_matte_declare(), blender::nodes::node_composite_chroma_matte_cc::cmp_node_chroma_matte_declare(), blender::nodes::node_composite_color_matte_cc::cmp_node_color_matte_declare(), blender::nodes::node_composite_color_spill_cc::cmp_node_color_spill_declare(), blender::nodes::node_composite_colorbalance_cc::cmp_node_colorbalance_declare(), blender::nodes::node_composite_colorcorrection_cc::cmp_node_colorcorrection_declare(), blender::nodes::node_composite_despeckle_cc::cmp_node_despeckle_declare(), blender::nodes::node_composite_diff_matte_cc::cmp_node_diff_matte_declare(), blender::nodes::node_composite_directionalblur_cc::cmp_node_directional_blur_declare(), blender::nodes::node_composite_distance_matte_cc::cmp_node_distance_matte_declare(), blender::nodes::node_composite_filter_cc::cmp_node_filter_declare(), blender::nodes::node_composite_glare_cc::cmp_node_glare_declare(), blender::nodes::node_composite_huecorrect_cc::cmp_node_huecorrect_declare(), blender::nodes::node_composite_hue_sat_val_cc::cmp_node_huesatval_declare(), blender::nodes::node_composite_invert_cc::cmp_node_invert_declare(), blender::nodes::node_composite_keying_cc::cmp_node_keying_declare(), blender::nodes::node_composite_kuwahara_cc::cmp_node_kuwahara_declare(), blender::nodes::node_composite_lensdist_cc::cmp_node_lensdist_declare(), blender::nodes::node_composite_luma_matte_cc::cmp_node_luma_matte_declare(), blender::nodes::node_composite_mask_cc::cmp_node_mask_declare(), blender::nodes::node_composite_rgb_curves_cc::cmp_node_rgbcurves_declare(), blender::nodes::node_composite_rotate_cc::cmp_node_rotate_declare(), blender::nodes::node_composite_split_cc::cmp_node_split_declare(), blender::nodes::node_composite_tonemap_cc::cmp_node_tonemap_declare(), blender::nodes::node_composite_transform_cc::cmp_node_transform_declare(), blender::nodes::node_composite_alpha_over_cc::node_declare(), blender::nodes::node_composite_relative_to_pixel_cc::node_declare(), blender::nodes::node_fn_align_euler_to_vector_cc::node_declare(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_declare(), blender::nodes::node_geo_blur_attribute_cc::node_declare(), blender::nodes::node_geo_curve_fillet_cc::node_declare(), blender::nodes::node_geo_curve_primitive_spiral_cc::node_declare(), blender::nodes::node_geo_curve_primitive_star_cc::node_declare(), blender::nodes::node_geo_curve_resample_cc::node_declare(), blender::nodes::node_geo_curve_sample_cc::node_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_distribute_points_on_faces_cc::node_declare(), blender::nodes::node_geo_grid_to_mesh_cc::node_declare(), blender::nodes::node_geo_input_mesh_face_is_planar_cc::node_declare(), blender::nodes::node_geo_instances_to_points_cc::node_declare(), blender::nodes::node_geo_merge_by_distance_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_grid_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_ico_sphere_cc::node_declare(), blender::nodes::node_geo_mesh_primitive_uv_sphere_cc::node_declare(), blender::nodes::node_geo_mesh_to_sdf_grid_cc::node_declare(), blender::nodes::node_geo_mesh_to_volume_cc::node_declare(), blender::nodes::node_geo_points_to_sdf_grid_cc::node_declare(), blender::nodes::node_geo_points_to_volume_cc::node_declare(), blender::nodes::node_geo_raycast_cc::node_declare(), blender::nodes::node_geo_set_point_radius_cc::node_declare(), blender::nodes::node_geo_volume_to_mesh_cc::node_declare(), blender::nodes::node_shader_blackbody_cc::node_declare(), blender::nodes::node_shader_bsdf_diffuse_cc::node_declare(), blender::nodes::node_shader_bsdf_glass_cc::node_declare(), blender::nodes::node_shader_bsdf_glossy_cc::node_declare(), blender::nodes::node_shader_bsdf_hair_cc::node_declare(), blender::nodes::node_shader_bsdf_hair_principled_cc::node_declare(), blender::nodes::node_shader_bsdf_metallic_cc::node_declare(), blender::nodes::node_shader_bsdf_principled_cc::node_declare(), blender::nodes::node_shader_bsdf_refraction_cc::node_declare(), blender::nodes::node_shader_bsdf_sheen_cc::node_declare(), blender::nodes::node_shader_bsdf_toon_cc::node_declare(), blender::nodes::node_shader_bump_cc::node_declare(), blender::nodes::node_shader_eevee_specular_cc::node_declare(), blender::nodes::node_shader_gamma_cc::node_declare(), blender::nodes::node_shader_hueSatVal_cc::node_declare(), blender::nodes::node_shader_invert_cc::node_declare(), blender::nodes::node_shader_mix_shader_cc::node_declare(), blender::nodes::node_shader_output_linestyle_cc::node_declare(), blender::nodes::node_shader_subsurface_scattering_cc::node_declare(), blender::nodes::node_shader_volume_coefficients_cc::node_declare(), blender::nodes::node_shader_volume_principled_cc::node_declare(), blender::nodes::node_shader_volume_scatter_cc::node_declare(), blender::nodes::node_shader_wavelength_cc::node_declare(), blender::nodes::node_shader_mix_rgb_cc::sh_node_mix_rgb_declare(), blender::nodes::node_shader_color_ramp_cc::sh_node_valtorgb_declare(), and update_or_build().

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