Blender V5.3
blender::nodes::NodeDeclaration Class Reference

#include <NOD_node_declaration.hh>

Public Member Functions

void assert_valid () const
bool matches (const bNode &node) const
Span< SocketDeclaration * > sockets (eNodeSocketInOut in_out) const
const rl::RelationsInNode * reference_lifetime_relations () const

Public Attributes

Vector< ItemDeclarationPtr > all_items
Vector< ItemDeclaration * > root_items
Vector< SocketDeclaration * > inputs
Vector< SocketDeclaration * > outputs
Vector< PanelDeclaration * > panels
std::unique_ptr< rl::RelationsInNode > reference_lifetime_relations_
bool skip_updating_sockets = false
bool use_custom_socket_order = false
bool allow_any_socket_order = false
bool is_context_dependent = false
friend NodeDeclarationBuilder

Detailed Description

Definition at line 603 of file NOD_node_declaration.hh.

Member Function Documentation

◆ assert_valid()

void blender::nodes::NodeDeclaration::assert_valid ( ) const

Asserts that the declaration is considered valid.

Definition at line 216 of file node_declaration.cc.

References blender::nodes::assert_valid_panels_recursive(), blender::BLI_assert(), inputs, outputs, root_items, and use_custom_socket_order.

◆ matches()

bool blender::nodes::NodeDeclaration::matches ( const bNode & node) const

◆ reference_lifetime_relations()

const rl::RelationsInNode * blender::nodes::NodeDeclaration::reference_lifetime_relations ( ) const
inline

◆ sockets()

Span< SocketDeclaration * > blender::nodes::NodeDeclaration::sockets ( eNodeSocketInOut in_out) const

Member Data Documentation

◆ all_items

◆ allow_any_socket_order

bool blender::nodes::NodeDeclaration::allow_any_socket_order = false

Usually output sockets come before input sockets currently. Only some specific nodes are exempt from that rule for now.

Definition at line 632 of file NOD_node_declaration.hh.

Referenced by blender::nodes::assert_valid_panels_recursive().

◆ inputs

Vector<SocketDeclaration *> blender::nodes::NodeDeclaration::inputs

◆ is_context_dependent

bool blender::nodes::NodeDeclaration::is_context_dependent = false

True if any context was used to build this declaration.

Definition at line 637 of file NOD_node_declaration.hh.

◆ NodeDeclarationBuilder

friend blender::nodes::NodeDeclaration::NodeDeclarationBuilder

Definition at line 639 of file NOD_node_declaration.hh.

◆ outputs

◆ panels

◆ reference_lifetime_relations_

std::unique_ptr<rl::RelationsInNode> blender::nodes::NodeDeclaration::reference_lifetime_relations_

Definition at line 613 of file NOD_node_declaration.hh.

Referenced by reference_lifetime_relations().

◆ root_items

◆ skip_updating_sockets

bool blender::nodes::NodeDeclaration::skip_updating_sockets = false

Leave the sockets in place, even if they don't match the declaration. Used for dynamic declarations when the information used to build the declaration is missing, but might become available again in the future.

Definition at line 620 of file NOD_node_declaration.hh.

Referenced by blender::compositor::input_descriptor_from_input_socket(), blender::nodes::node_group_declare(), blender::nodes::refresh_node(), blender::ed::space_node::socket_needs_attribute_search(), blender::ed::space_node::socket_needs_layer_search(), and blender::ed::space_node::socket_needs_volume_grid_search().

◆ use_custom_socket_order

bool blender::nodes::NodeDeclaration::use_custom_socket_order = false

Use order of socket declarations for socket order instead of conventional outputs | buttons | inputs order. Panels are only supported when using custom socket order.

Definition at line 626 of file NOD_node_declaration.hh.

Referenced by assert_valid(), and blender::nodes::node_group_declare().


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