Blender V5.3
blender::bke::node_interface Namespace Reference

Namespaces

namespace  detail
namespace  item_types
namespace  socket_types

Classes

struct  bNodeTreeInterfaceItemReference

Functions

template<typename T>
T & get_item_as (bNodeTreeInterfaceItem &item)
template<typename T>
const T & get_item_as (const bNodeTreeInterfaceItem &item)
template<typename T>
T * get_item_as (bNodeTreeInterfaceItem *item)
template<typename T>
const T * get_item_as (const bNodeTreeInterfaceItem *item)
template<typename T>
bool socket_data_is_type (const char *socket_type)
template<typename T>
T & get_socket_data_as (bNodeTreeInterfaceSocket &item)
template<typename T>
const T & get_socket_data_as (const bNodeTreeInterfaceSocket &item)
bNodeTreeInterfaceSocket * add_interface_socket_from_node (bNodeTree &ntree, const bNode &from_node, const bNodeSocket &from_sock, std::optional< StringRef > name=std::nullopt, std::optional< eNodeSocketInOut > in_out=std::nullopt)
void item_reference_free (bNodeTreeInterfaceItemReference *item_reference)
bNode * create_proxy_const_input_node (eNodeSocketDatatype socket_type, const bNodeTree &src_tree, const bNodeSocket &src_socket, bContext &C, bNodeTree &dst_tree, Vector< AnimationBasePathChange > &anim_basepaths)
bNode * create_proxy_implicit_input_node (eNodeSocketDatatype socket_type, NodeDefaultInputType default_input, bContext &C, bNodeTree &tree)
bNode * create_proxy_converter_node (eNodeSocketDatatype socket_type, const bNodeTree &src_tree, const bNodeSocket *src_socket, bContext &C, bNodeTree &dst_tree, Vector< AnimationBasePathChange > &anim_basepaths)
static bNodeTreeInterfaceSocket * make_socket (const int uid, const StringRef name, const StringRef description, const StringRef socket_type, const NodeTreeInterfaceSocketFlag flag)
static std::string get_node_property_path (const bNodeTree &tree, const bNode &node, const StringRefNull prop)
static std::string get_socket_property_path (const bNodeTree &tree, const bNodeSocket &socket, const StringRefNull prop)
static bNode * create_proxy_implicit_scene_frame_node (bContext &C, bNodeTree &tree)
static std::string socket_basepath (const bNodeTree &tree, const bNodeSocket &socket)
static bNodeTreeInterfacePanel * make_panel (const int uid, const StringRef name, const StringRef description, const NodeTreeInterfacePanelFlag flag)

Function Documentation

◆ add_interface_socket_from_node()

bNodeTreeInterfaceSocket * blender::bke::node_interface::add_interface_socket_from_node ( bNodeTree & ntree,
const bNode & from_node,
const bNodeSocket & from_sock,
std::optional< StringRef > name = std::nullopt,
std::optional< eNodeSocketInOut > in_out = std::nullopt )

Add a tree interface socket based on the properties of an existing node socket.

Parameters
ntreeNode tree where the interface socket is added.
from_nodeNode that owns the template socket. Does not have to be part of ntree.
from_sockTemplate socket on which the interface properties are based.
nameOptional custom socket name. By default the visible socket label or name is used.
in_outOptional input/output direction. By default same as the template socket.

Definition at line 1301 of file node_tree_interface.cc.

References add_interface_socket_from_node(), blender::BLI_assert(), blender::bke::bNodeSocketRuntime::declaration, blender::bNodeTreeInterfaceSocket::default_input, blender::bNodeSocket::description, blender::bNode::id, blender::bNodeTree::id, blender::bke::bNodeSocketType::idname, blender::bke::bNodeSocketType::interface_from_socket, blender::bNodeTreeInterfaceSocket::item, blender::NODE_INTERFACE_SOCKET_INPUT, blender::NODE_INTERFACE_SOCKET_MENU_EXPANDED, blender::NODE_INTERFACE_SOCKET_OPTIONAL_LABEL, blender::NODE_INTERFACE_SOCKET_OUTPUT, blender::bke::node_socket_label(), blender::UString::ref(), blender::bNodeSocket::runtime, SET_FLAG_FROM_TEST, blender::SOCK_IN, blender::SOCK_MENU, blender::bNodeTree::tree_interface, blender::bNodeSocket::type, and blender::bNodeSocket::typeinfo.

Referenced by blender::ed::space_node::add_group_input_node_fn(), blender::ed::space_node::add_interface_from_socket(), add_interface_socket_from_node(), blender::nodes::group_input_insert_link(), and blender::nodes::group_output_insert_link().

◆ create_proxy_const_input_node()

bNode * blender::bke::node_interface::create_proxy_const_input_node ( eNodeSocketDatatype socket_type,
const bNodeTree & src_tree,
const bNodeSocket & src_socket,
bContext & C,
bNodeTree & dst_tree,
Vector< AnimationBasePathChange > & anim_basepaths )

Create a constant value node for the socket type.

Returns
Constant value input node or null if the socket type is not supported.

Definition at line 1389 of file node_tree_interface.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert_unreachable, blender::BLI_strdup(), blender::NodeInputBool::boolean, C, blender::copy_v3_v3(), blender::copy_v3_v3_int(), blender::copy_v4_v4(), create_proxy_const_input_node(), blender::bNodeSocket::default_value, blender::bNodeSocketValueIntVector::dimensions, blender::bNodeSocketValueVector::dimensions, get_node_property_path(), get_socket_property_path(), blender::Collection::id, blender::Object::id, blender::VFont::id, blender::id_us_plus(), blender::NodeInputInt::integer, node, blender::bke::node_add_node(), blender::NTREE_COMPOSIT, blender::NTREE_CUSTOM, blender::NTREE_GEOMETRY, blender::NTREE_SHADER, blender::NTREE_TEXTURE, blender::NTREE_UNDEFINED, blender::SOCK_BOOLEAN, blender::SOCK_BUNDLE, blender::SOCK_CLOSURE, blender::SOCK_COLLECTION, blender::SOCK_CUSTOM, blender::SOCK_FLOAT, blender::SOCK_FONT, blender::SOCK_GEOMETRY, blender::SOCK_IMAGE, blender::SOCK_INT, blender::SOCK_INT_VECTOR, blender::SOCK_MASK, blender::SOCK_MATERIAL, blender::SOCK_MATRIX, blender::SOCK_MENU, blender::SOCK_OBJECT, blender::SOCK_RGBA, blender::SOCK_ROTATION, blender::SOCK_SCENE, blender::SOCK_SHADER, blender::SOCK_SOUND, blender::SOCK_STRING, blender::SOCK_TEXT_ID, blender::SOCK_TEXTURE, blender::SOCK_VECTOR, blender::bke::socket_value_copy_content(), blender::NodeInputString::string, blender::bNodeTree::type, blender::bNodeSocketValueMenu::value, blender::bNodeSocketValueRGBA::value, and blender::bNodeSocketValueRotation::value_euler.

Referenced by create_proxy_const_input_node(), and blender::ed::space_node::create_proxy_input_node().

◆ create_proxy_converter_node()

◆ create_proxy_implicit_input_node()

bNode * blender::bke::node_interface::create_proxy_implicit_input_node ( eNodeSocketDatatype socket_type,
NodeDefaultInputType default_input,
bContext & C,
bNodeTree & tree )

Create an implicit input node for the socket type.

Returns
Implicit input field node or null if the socket type or default input is not supported.

Definition at line 1582 of file node_tree_interface.cc.

References BLI_assert_unreachable, C, create_proxy_implicit_input_node(), create_proxy_implicit_scene_frame_node(), node, blender::bke::node_add_node(), blender::NODE_DEFAULT_INPUT_HANDLE_LEFT_FIELD, blender::NODE_DEFAULT_INPUT_HANDLE_RIGHT_FIELD, blender::NODE_DEFAULT_INPUT_ID_INDEX_FIELD, blender::NODE_DEFAULT_INPUT_INDEX_FIELD, blender::NODE_DEFAULT_INPUT_INSTANCE_TRANSFORM_FIELD, blender::NODE_DEFAULT_INPUT_NORMAL_FIELD, blender::NODE_DEFAULT_INPUT_POSITION_FIELD, blender::NODE_DEFAULT_INPUT_SCENE_FRAME, blender::NODE_DEFAULT_INPUT_SELF_OBJECT, blender::bke::node_find_socket(), blender::SOCK_BOOLEAN, blender::SOCK_BUNDLE, blender::SOCK_CLOSURE, blender::SOCK_COLLECTION, blender::SOCK_CUSTOM, blender::SOCK_FLOAT, blender::SOCK_FONT, blender::SOCK_GEOMETRY, blender::SOCK_HIDDEN, blender::SOCK_IMAGE, blender::SOCK_IN, blender::SOCK_INT, blender::SOCK_INT_VECTOR, blender::SOCK_MASK, blender::SOCK_MATERIAL, blender::SOCK_MATRIX, blender::SOCK_MENU, blender::SOCK_OBJECT, blender::SOCK_OUT, blender::SOCK_RGBA, blender::SOCK_ROTATION, blender::SOCK_SCENE, blender::SOCK_SHADER, blender::SOCK_SOUND, blender::SOCK_STRING, blender::SOCK_TEXT_ID, blender::SOCK_TEXTURE, and blender::SOCK_VECTOR.

Referenced by create_proxy_implicit_input_node(), and blender::ed::space_node::create_proxy_input_node().

◆ create_proxy_implicit_scene_frame_node()

◆ get_item_as() [1/4]

◆ get_item_as() [2/4]

template<typename T>
T * blender::bke::node_interface::get_item_as ( bNodeTreeInterfaceItem * item)

◆ get_item_as() [3/4]

template<typename T>
const T & blender::bke::node_interface::get_item_as ( const bNodeTreeInterfaceItem & item)

◆ get_item_as() [4/4]

template<typename T>
const T * blender::bke::node_interface::get_item_as ( const bNodeTreeInterfaceItem * item)

◆ get_node_property_path()

std::string blender::bke::node_interface::get_node_property_path ( const bNodeTree & tree,
const bNode & node,
const StringRefNull prop )
static

◆ get_socket_data_as() [1/2]

◆ get_socket_data_as() [2/2]

template<typename T>
const T & blender::bke::node_interface::get_socket_data_as ( const bNodeTreeInterfaceSocket & item)

◆ get_socket_property_path()

std::string blender::bke::node_interface::get_socket_property_path ( const bNodeTree & tree,
const bNodeSocket & socket,
const StringRefNull prop )
static

◆ item_reference_free()

void blender::bke::node_interface::item_reference_free ( bNodeTreeInterfaceItemReference * item_reference)

◆ make_panel()

◆ make_socket()

◆ socket_basepath()

std::string blender::bke::node_interface::socket_basepath ( const bNodeTree & tree,
const bNodeSocket & socket )
static

◆ socket_data_is_type()

template<typename T>
bool blender::bke::node_interface::socket_data_is_type ( const char * socket_type)