Blender  V2.93
Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Node Union Referenceabstract

#include <node.h>

Inherited by Background, Camera, Film, Geometry, Integrator, Light, Object, ParticleSystem, Pass, Procedural, Shader, and ShaderNode.

Public Member Functions

 Node (const NodeType *type, ustring name=ustring())
 
virtual ~Node ()=0
 
void set (const SocketType &input, bool value)
 
void set (const SocketType &input, int value)
 
void set (const SocketType &input, uint value)
 
void set (const SocketType &input, float value)
 
void set (const SocketType &input, float2 value)
 
void set (const SocketType &input, float3 value)
 
void set (const SocketType &input, const char *value)
 
void set (const SocketType &input, ustring value)
 
void set (const SocketType &input, const Transform &value)
 
void set (const SocketType &input, Node *value)
 
void set (const SocketType &input, array< bool > &value)
 
void set (const SocketType &input, array< int > &value)
 
void set (const SocketType &input, array< float > &value)
 
void set (const SocketType &input, array< float2 > &value)
 
void set (const SocketType &input, array< float3 > &value)
 
void set (const SocketType &input, array< ustring > &value)
 
void set (const SocketType &input, array< Transform > &value)
 
void set (const SocketType &input, array< Node * > &value)
 
bool get_bool (const SocketType &input) const
 
int get_int (const SocketType &input) const
 
uint get_uint (const SocketType &input) const
 
float get_float (const SocketType &input) const
 
float2 get_float2 (const SocketType &input) const
 
float3 get_float3 (const SocketType &input) const
 
ustring get_string (const SocketType &input) const
 
Transform get_transform (const SocketType &input) const
 
Node * get_node (const SocketType &input) const
 
const array< bool > & get_bool_array (const SocketType &input) const
 
const array< int > & get_int_array (const SocketType &input) const
 
const array< float > & get_float_array (const SocketType &input) const
 
const array< float2 > & get_float2_array (const SocketType &input) const
 
const array< float3 > & get_float3_array (const SocketType &input) const
 
const array< ustring > & get_string_array (const SocketType &input) const
 
const array< Transform > & get_transform_array (const SocketType &input) const
 
const array< Node * > & get_node_array (const SocketType &input) const
 
bool has_default_value (const SocketType &input) const
 
void set_default_value (const SocketType &input)
 
bool equals_value (const Node &other, const SocketType &input) const
 
void copy_value (const SocketType &input, const Node &other, const SocketType &other_input)
 
void set_value (const SocketType &input, const Node &other, const SocketType &other_input)
 
bool equals (const Node &other) const
 
void hash (MD5Hash &md5)
 
size_t get_total_size_in_bytes () const
 
bool is_a (const NodeType *type)
 
bool socket_is_modified (const SocketType &input) const
 
bool is_modified ()
 
void tag_modified ()
 
void clear_modified ()
 
void print_modified_sockets () const
 
const NodeOwner * get_owner () const
 
void set_owner (const NodeOwner *owner_)
 

Public Attributes

ustring name
 
const NodeType * type
 
InternalNode internal
 
LeafNode leaf
 

Protected Member Functions

template<typename T >
void set_if_different (const SocketType &input, T value)
 
template<typename T >
void set_if_different (const SocketType &input, array< T > &value)
 

Static Protected Member Functions

template<typename T >
static T & get_socket_value (const Node *node, const SocketType &socket)
 

Protected Attributes

const NodeOwner * owner
 
SocketModifiedFlags socket_modified
 

Detailed Description

Definition at line 98 of file node.h.

Constructor & Destructor Documentation

◆ Node()

Node::Node ( const NodeType *  type,
ustring  name = ustring() 
)
explicit

Definition at line 33 of file node.cpp.

References NodeType::inputs, name, NodeType::name, owner, set_default_value(), tag_modified(), and type.

◆ ~Node()

Node::~Node ( )
pure virtual

Definition at line 51 of file node.cpp.

Member Function Documentation

◆ clear_modified()

void Node::clear_modified ( )

Definition at line 791 of file node.cpp.

References socket_modified.

◆ copy_value()

void Node::copy_value ( const SocketType &  input,
const Node &  other,
const SocketType &  other_input 
)

Definition at line 334 of file node.cpp.

References SocketType::BOOLEAN_ARRAY, SocketType::COLOR_ARRAY, SocketType::FLOAT_ARRAY, SocketType::INT_ARRAY, SocketType::is_array(), SocketType::NODE_ARRAY, SocketType::NORMAL_ARRAY, SocketType::POINT2_ARRAY, SocketType::POINT_ARRAY, SocketType::size(), SocketType::STRING_ARRAY, SocketType::struct_offset, SocketType::TRANSFORM_ARRAY, SocketType::type, and SocketType::VECTOR_ARRAY.

Referenced by ShaderGraph::relink(), and ShaderGraph::remove_proxy_nodes().

◆ equals()

bool Node::equals ( const Node &  other) const

Definition at line 546 of file node.cpp.

References equals_value(), NodeType::inputs, and type.

◆ equals_value()

bool Node::equals_value ( const Node &  other,
const SocketType &  input 
) const

Definition at line 482 of file node.cpp.

References SocketType::BOOLEAN, SocketType::BOOLEAN_ARRAY, SocketType::CLOSURE, SocketType::COLOR, SocketType::COLOR_ARRAY, SocketType::ENUM, SocketType::FLOAT, SocketType::FLOAT_ARRAY, SocketType::INT, SocketType::INT_ARRAY, SocketType::NODE, SocketType::NODE_ARRAY, SocketType::NORMAL, SocketType::NORMAL_ARRAY, SocketType::POINT, SocketType::POINT2, SocketType::POINT2_ARRAY, SocketType::POINT_ARRAY, SocketType::STRING, SocketType::STRING_ARRAY, SocketType::TRANSFORM, SocketType::TRANSFORM_ARRAY, SocketType::type, SocketType::UINT, SocketType::UNDEFINED, SocketType::VECTOR, and SocketType::VECTOR_ARRAY.

Referenced by equals(), and ShaderNode::equals().

◆ get_bool()

bool Node::get_bool ( const SocketType &  input) const

Definition at line 192 of file node.cpp.

References SocketType::BOOLEAN, and SocketType::type.

◆ get_bool_array()

const array< bool > & Node::get_bool_array ( const SocketType &  input) const

Definition at line 257 of file node.cpp.

References SocketType::BOOLEAN_ARRAY, and SocketType::type.

◆ get_float()

float Node::get_float ( const SocketType &  input) const

Definition at line 210 of file node.cpp.

References SocketType::FLOAT, and SocketType::type.

Referenced by PrincipledBsdfNode::compile(), VolumeNode::compile(), BsdfNode::compile(), ConstantFolder::fold_mix(), ConstantFolder::is_one(), ConstantFolder::is_zero(), and ConstantFolder::try_bypass_or_make_constant().

◆ get_float2()

float2 Node::get_float2 ( const SocketType &  input) const

Definition at line 216 of file node.cpp.

References SocketType::POINT2, and SocketType::type.

◆ get_float2_array()

const array< float2 > & Node::get_float2_array ( const SocketType &  input) const

Definition at line 275 of file node.cpp.

References SocketType::POINT2_ARRAY, and SocketType::type.

◆ get_float3()

float3 Node::get_float3 ( const SocketType &  input) const

Definition at line 222 of file node.cpp.

References is_socket_float3().

Referenced by PrincipledBsdfNode::compile(), ConstantFolder::fold_mix(), ConstantFolder::is_one(), ConstantFolder::is_zero(), and ConstantFolder::try_bypass_or_make_constant().

◆ get_float3_array()

const array< float3 > & Node::get_float3_array ( const SocketType &  input) const

Definition at line 281 of file node.cpp.

References is_socket_array_float3().

◆ get_float_array()

const array< float > & Node::get_float_array ( const SocketType &  input) const

Definition at line 269 of file node.cpp.

References SocketType::FLOAT_ARRAY, and SocketType::type.

◆ get_int()

int Node::get_int ( const SocketType &  input) const

Definition at line 198 of file node.cpp.

References SocketType::ENUM, SocketType::INT, and SocketType::type.

◆ get_int_array()

const array< int > & Node::get_int_array ( const SocketType &  input) const

Definition at line 263 of file node.cpp.

References SocketType::INT_ARRAY, and SocketType::type.

◆ get_node()

Node * Node::get_node ( const SocketType &  input) const

Definition at line 250 of file node.cpp.

References SocketType::NODE, and SocketType::type.

◆ get_node_array()

const array< Node * > & Node::get_node_array ( const SocketType &  input) const

Definition at line 299 of file node.cpp.

References SocketType::NODE_ARRAY, and SocketType::type.

◆ get_owner()

const NodeOwner * Node::get_owner ( ) const

Definition at line 765 of file node.cpp.

References owner.

◆ get_socket_value()

template<typename T >
static T& Node::get_socket_value ( const Node *  node,
const SocketType &  socket 
)
inlinestaticprotected

Definition at line 183 of file node.h.

References node, SocketType::struct_offset, and T.

Referenced by set_if_different(), and set_value().

◆ get_string()

ustring Node::get_string ( const SocketType &  input) const

Definition at line 228 of file node.cpp.

References SocketType::ENUM, SocketType::enum_values, NodeEnum::exists(), SocketType::STRING, and SocketType::type.

◆ get_string_array()

const array< ustring > & Node::get_string_array ( const SocketType &  input) const

Definition at line 287 of file node.cpp.

References SocketType::STRING_ARRAY, and SocketType::type.

◆ get_total_size_in_bytes()

size_t Node::get_total_size_in_bytes ( ) const

Definition at line 692 of file node.cpp.

References SocketType::BOOLEAN, SocketType::BOOLEAN_ARRAY, SocketType::CLOSURE, SocketType::COLOR, SocketType::COLOR_ARRAY, SocketType::ENUM, SocketType::FLOAT, SocketType::FLOAT_ARRAY, NodeType::inputs, SocketType::INT, SocketType::INT_ARRAY, SocketType::NODE, SocketType::NODE_ARRAY, SocketType::NORMAL, SocketType::NORMAL_ARRAY, SocketType::POINT, SocketType::POINT2, SocketType::POINT2_ARRAY, SocketType::POINT_ARRAY, SocketType::size(), SocketType::STRING, SocketType::STRING_ARRAY, SocketType::TRANSFORM, SocketType::TRANSFORM_ARRAY, type, SocketType::type, SocketType::UINT, SocketType::UNDEFINED, SocketType::VECTOR, and SocketType::VECTOR_ARRAY.

Referenced by GeometryManager::collect_statistics().

◆ get_transform()

Transform Node::get_transform ( const SocketType &  input) const

Definition at line 244 of file node.cpp.

References SocketType::TRANSFORM, and SocketType::type.

◆ get_transform_array()

const array< Transform > & Node::get_transform_array ( const SocketType &  input) const

Definition at line 293 of file node.cpp.

References SocketType::TRANSFORM_ARRAY, and SocketType::type.

◆ get_uint()

uint Node::get_uint ( const SocketType &  input) const

Definition at line 204 of file node.cpp.

References SocketType::type, and SocketType::UINT.

◆ has_default_value()

bool Node::has_default_value ( const SocketType &  input) const

Definition at line 307 of file node.cpp.

References SocketType::default_value, and SocketType::size().

◆ hash()

void Node::hash ( MD5Hash &  md5)

Definition at line 592 of file node.cpp.

References MD5Hash::append(), SocketType::BOOLEAN, SocketType::BOOLEAN_ARRAY, SocketType::CLOSURE, SocketType::COLOR, SocketType::COLOR_ARRAY, SocketType::ENUM, SocketType::FLOAT, SocketType::FLOAT_ARRAY, NodeType::inputs, SocketType::INT, SocketType::INT_ARRAY, SocketType::name, NodeType::name, SocketType::NODE, SocketType::NODE_ARRAY, SocketType::NORMAL, SocketType::NORMAL_ARRAY, SocketType::POINT, SocketType::POINT2, SocketType::POINT2_ARRAY, SocketType::POINT_ARRAY, SocketType::STRING, SocketType::STRING_ARRAY, SocketType::TRANSFORM, SocketType::TRANSFORM_ARRAY, type, SocketType::type, SocketType::UINT, SocketType::UNDEFINED, SocketType::VECTOR, and SocketType::VECTOR_ARRAY.

◆ is_a()

bool Node::is_a ( const NodeType *  type)

Definition at line 755 of file node.cpp.

References NodeType::base, and type.

Referenced by xml_read_node().

◆ is_modified()

bool Node::is_modified ( )

Definition at line 781 of file node.cpp.

References socket_modified.

Referenced by Background::device_update(), Film::device_update(), Integrator::device_update(), GeometryManager::device_update(), ObjectManager::device_update(), GeometryManager::device_update_bvh(), GeometryManager::device_update_displacement_images(), GeometryManager::device_update_volume_images(), BlenderSession::draw(), Scene::need_data_update(), Scene::need_reset(), Scene::need_update(), Session::render_need_denoise(), Background::tag_update(), Light::tag_update(), Object::tag_update(), and Camera::update().

◆ print_modified_sockets()

void Node::print_modified_sockets ( ) const

Definition at line 818 of file node.cpp.

References NodeType::inputs, name, SocketType::name, socket_is_modified(), and type.

◆ set() [1/18]

void Node::set ( const SocketType &  input,
array< bool > &  value 
)

Definition at line 143 of file node.cpp.

References SocketType::BOOLEAN_ARRAY, set_if_different(), and SocketType::type.

◆ set() [2/18]

void Node::set ( const SocketType &  input,
array< float > &  value 
)

Definition at line 155 of file node.cpp.

References SocketType::FLOAT_ARRAY, set_if_different(), and SocketType::type.

◆ set() [3/18]

void Node::set ( const SocketType &  input,
array< float2 > &  value 
)

Definition at line 161 of file node.cpp.

References SocketType::POINT2_ARRAY, set_if_different(), and SocketType::type.

◆ set() [4/18]

void Node::set ( const SocketType &  input,
array< float3 > &  value 
)

Definition at line 167 of file node.cpp.

References is_socket_array_float3(), and set_if_different().

◆ set() [5/18]

void Node::set ( const SocketType &  input,
array< int > &  value 
)

Definition at line 149 of file node.cpp.

References SocketType::INT_ARRAY, set_if_different(), and SocketType::type.

◆ set() [6/18]

void Node::set ( const SocketType &  input,
array< Node * > &  value 
)

Definition at line 185 of file node.cpp.

References SocketType::NODE_ARRAY, set_if_different(), and SocketType::type.

◆ set() [7/18]

void Node::set ( const SocketType &  input,
array< Transform > &  value 
)

Definition at line 179 of file node.cpp.

References set_if_different(), SocketType::TRANSFORM_ARRAY, and SocketType::type.

◆ set() [8/18]

void Node::set ( const SocketType &  input,
array< ustring > &  value 
)

Definition at line 173 of file node.cpp.

References set_if_different(), SocketType::STRING_ARRAY, and SocketType::type.

◆ set() [9/18]

void Node::set ( const SocketType &  input,
bool  value 
)

Definition at line 70 of file node.cpp.

References SocketType::BOOLEAN, set_if_different(), and SocketType::type.

Referenced by BKE_scene_base_iter_next(), set(), and set_value().

◆ set() [10/18]

void Node::set ( const SocketType &  input,
const char *  value 
)

Definition at line 106 of file node.cpp.

References set().

◆ set() [11/18]

void Node::set ( const SocketType &  input,
const Transform &  value 
)

Definition at line 130 of file node.cpp.

References set_if_different(), SocketType::TRANSFORM, and SocketType::type.

◆ set() [12/18]

void Node::set ( const SocketType &  input,
float  value 
)

Definition at line 88 of file node.cpp.

References SocketType::FLOAT, set_if_different(), and SocketType::type.

◆ set() [13/18]

void Node::set ( const SocketType &  input,
float2  value 
)

Definition at line 94 of file node.cpp.

References SocketType::POINT2, set_if_different(), and SocketType::type.

◆ set() [14/18]

void Node::set ( const SocketType &  input,
float3  value 
)

Definition at line 100 of file node.cpp.

References is_socket_float3(), and set_if_different().

◆ set() [15/18]

void Node::set ( const SocketType &  input,
int  value 
)

Definition at line 76 of file node.cpp.

References SocketType::ENUM, SocketType::INT, set_if_different(), and SocketType::type.

◆ set() [16/18]

void Node::set ( const SocketType &  input,
Node *  value 
)

Definition at line 136 of file node.cpp.

References SocketType::NODE, set_if_different(), and SocketType::type.

◆ set() [17/18]

void Node::set ( const SocketType &  input,
uint  value 
)

Definition at line 82 of file node.cpp.

References set_if_different(), SocketType::type, and SocketType::UINT.

◆ set() [18/18]

void Node::set ( const SocketType &  input,
ustring  value 
)

Definition at line 111 of file node.cpp.

References SocketType::ENUM, SocketType::enum_values, NodeEnum::exists(), set_if_different(), SocketType::STRING, and SocketType::type.

◆ set_default_value()

void Node::set_default_value ( const SocketType &  input)

Definition at line 314 of file node.cpp.

References SocketType::default_value, SocketType::size(), and SocketType::struct_offset.

Referenced by Node().

◆ set_if_different() [1/2]

template<typename T >
void Node::set_if_different ( const SocketType &  input,
array< T > &  value 
)
protected

Definition at line 806 of file node.cpp.

References get_socket_value(), SocketType::modified_flag_bit, socket_is_modified(), and socket_modified.

◆ set_if_different() [2/2]

template<typename T >
void Node::set_if_different ( const SocketType &  input,
T  value 
)
protected

Definition at line 796 of file node.cpp.

References SocketType::modified_flag_bit, and socket_modified.

Referenced by set().

◆ set_owner()

void Node::set_owner ( const NodeOwner *  owner_)

Definition at line 770 of file node.cpp.

References owner.

◆ set_value()

void Node::set_value ( const SocketType &  input,
const Node &  other,
const SocketType &  other_input 
)

Definition at line 385 of file node.cpp.

References SocketType::BOOLEAN, SocketType::BOOLEAN_ARRAY, SocketType::COLOR, SocketType::COLOR_ARRAY, SocketType::ENUM, SocketType::FLOAT, SocketType::FLOAT_ARRAY, get_socket_value(), SocketType::INT, SocketType::INT_ARRAY, SocketType::is_array(), SocketType::NODE, SocketType::NODE_ARRAY, SocketType::NORMAL, SocketType::NORMAL_ARRAY, SocketType::POINT, SocketType::POINT2, SocketType::POINT2_ARRAY, SocketType::POINT_ARRAY, set(), SocketType::STRING, SocketType::STRING_ARRAY, SocketType::TRANSFORM, SocketType::TRANSFORM_ARRAY, SocketType::type, SocketType::UINT, SocketType::VECTOR, and SocketType::VECTOR_ARRAY.

Referenced by add_node(), and ShaderGraph::constant_fold().

◆ socket_is_modified()

bool Node::socket_is_modified ( const SocketType &  input) const

Definition at line 776 of file node.cpp.

References SocketType::modified_flag_bit, and socket_modified.

Referenced by print_modified_sockets(), and set_if_different().

◆ tag_modified()

void Node::tag_modified ( )

Definition at line 786 of file node.cpp.

References socket_modified.

Referenced by Geometry::clear(), Node(), Scene::reset(), BakeManager::set(), Camera::set_screen_size_and_resolution(), Geometry::tag_bvh_update(), Shader::tag_update(), Integrator::tag_update(), and Shader::tag_used().

Member Data Documentation

◆ internal

InternalNode Node::internal

Definition at line 177 of file octree.h.

Referenced by Octree::scanConvert().

◆ leaf

LeafNode Node::leaf

Definition at line 178 of file octree.h.

◆ name

ustring Node::name

Definition at line 174 of file node.h.

Referenced by OSLNode::add_input(), OSLNode::add_output(), BlenderSession::bake(), BKE_object_facemap_index_map_create(), ConstantFolder::bypass(), RenderStats::collect_profiling(), GeometryManager::collect_statistics(), CurvesNode::compile(), Geometry::compute_bvh(), ShaderGraph::connect(), copy_particle_systems_to_object(), GeometryManager::create_volume_mesh(), ObjectManager::device_update_object_transform(), ConstantFolder::discard(), GeometryManager::displace(), ShaderGraph::dump_graph(), ED_mesh_join_objects_exec(), eevee_volume_object_grids_init(), ExportCurveSegments(), ExportCurveSegmentsMotion(), Film::get_aov_offset(), ObjectManager::get_cryptomatte_objects(), gpencil_armatures_enum_itemf(), ShaderNode::input(), lineart_gpencil_generate(), ConstantFolder::make_constant(), Geometry::need_attribute(), Node(), ShaderNode::output(), print_modified_sockets(), render_image_update_pass_and_layer(), screen_render_invoke(), screen_render_single_layer_set(), ShaderNode::ShaderNode(), OutputAOVNode::simplify_settings(), SVMCompiler::stack_find_offset(), GeometryManager::update_osl_attributes(), updateDepsgraph(), and xml_write_node().

◆ owner

const NodeOwner* Node::owner
protected

Definition at line 181 of file node.h.

Referenced by get_owner(), Node(), and set_owner().

◆ socket_modified

SocketModifiedFlags Node::socket_modified
protected

Definition at line 188 of file node.h.

Referenced by clear_modified(), is_modified(), set_if_different(), socket_is_modified(), and tag_modified().

◆ type

const NodeType* Node::type

Definition at line 175 of file node.h.

Referenced by OSLNode::add_input(), OSLNode::add_output(), bind_fallback_shader(), BKE_mesh_runtime_debug_info(), CurvesNode::compile(), ConvertNode::constant_fold(), ShaderGraph::copy_nodes(), ShaderNode::create_inputs_outputs(), LightManager::device_update_background(), equals(), ShaderNode::equals(), get_total_size_in_bytes(), hash(), OSLNode::input_default_value(), is_a(), Shader::is_constant_emission(), Node(), NODE_DEFINE(), Hair::pack_primitives(), Mesh::pack_primitives(), print_modified_sockets(), ShaderNode::ShaderNode(), and OSLNode::~OSLNode().

The documentation for this union was generated from the following files:
Generated on Tue Jan 31 2023 14:37:24 for Blender by  doxygen 1.9.1