Blender: blender::nodes::LinkSearchOpParams Class Reference

Blender V5.0

#include <NOD_socket_search_link.hh>

Public Member Functions
	LinkSearchOpParams (const bContext &C, bNodeTree &node_tree, bNode &node, bNodeSocket &socket, Vector< bNode * > &added_nodes)
bNode &	add_node (StringRef idname)
bNode &	add_node (const bke::bNodeType &node_type)
void	connect_available_socket (bNode &new_node, StringRef socket_name)
void	connect_available_socket_by_identifier (bNode &new_node, StringRef socket_identifier)
void	connect_socket (bNode &new_node, bNodeSocket &new_socket)
void	update_and_connect_available_socket (bNode &new_node, StringRef socket_name)

Public Attributes
const bContext &	C
bNodeTree &	node_tree
bNode &	node
bNodeSocket &	socket

Detailed Description

Parameters for the operation of adding a node after the link drag search menu closes.

Definition at line 24 of file NOD_socket_search_link.hh.

Constructor & Destructor Documentation

◆ LinkSearchOpParams()

blender::nodes::LinkSearchOpParams::LinkSearchOpParams	(	const bContext &	C,
		bNodeTree &	node_tree,
		bNode &	node,
		bNodeSocket &	socket,
		Vector< bNode * > &	added_nodes )

inline

Definition at line 43 of file NOD_socket_search_link.hh.

References C, node, node_tree, and socket.

Member Function Documentation

◆ add_node() [1/2]

bNode & blender::nodes::LinkSearchOpParams::add_node ( const bke::bNodeType & node_type )

Definition at line 107 of file socket_search_link.cc.

References add_node(), and blender::bke::bNodeType::idname.

◆ add_node() [2/2]

bNode & blender::nodes::LinkSearchOpParams::add_node ( StringRef idname )

Definition at line 99 of file socket_search_link.cc.

References BLI_assert, C, node, blender::bke::node_add_node(), and node_tree.

Referenced by add_node().

◆ connect_available_socket()

void blender::nodes::LinkSearchOpParams::connect_available_socket	(	bNode &	new_node,
		StringRef	socket_name )

Find a socket with the given name (correctly checks for inputs and outputs) and connect it to the socket the link drag started from (socket).

Definition at line 66 of file socket_search_link.cc.

References BLI_assert_unreachable, connect_socket(), blender::bke::node_find_enabled_socket(), SOCK_IN, SOCK_OUT, and socket.

Referenced by update_and_connect_available_socket().

◆ connect_available_socket_by_identifier()

void blender::nodes::LinkSearchOpParams::connect_available_socket_by_identifier	(	bNode &	new_node,
		StringRef	socket_identifier )

Definition at line 79 of file socket_search_link.cc.

References BLI_assert, connect_socket(), blender::bke::node_find_socket(), SOCK_IN, SOCK_OUT, and socket.

◆ connect_socket()

void blender::nodes::LinkSearchOpParams::connect_socket	(	bNode &	new_node,
		bNodeSocket &	new_socket )

Definition at line 88 of file socket_search_link.cc.

References C, CTX_data_main(), bNodeSocket::in_out, node, blender::bke::node_add_link(), blender::bke::node_socket_move_default_value(), node_tree, SOCK_OUT, and socket.

Referenced by connect_available_socket(), and connect_available_socket_by_identifier().

◆ update_and_connect_available_socket()

void blender::nodes::LinkSearchOpParams::update_and_connect_available_socket	(	bNode &	new_node,
		StringRef	socket_name )

Like connect_available_socket, but also calls the node's update function.

Definition at line 112 of file socket_search_link.cc.

References connect_available_socket(), node_tree, bNode::typeinfo, and blender::nodes::update_node_declaration_and_sockets().

Member Data Documentation

◆ C

const bContext& blender::nodes::LinkSearchOpParams::C

Definition at line 32 of file NOD_socket_search_link.hh.

Referenced by add_node(), connect_socket(), and LinkSearchOpParams().

◆ node

bNode& blender::nodes::LinkSearchOpParams::node

The node that contains the socket.

Definition at line 37 of file NOD_socket_search_link.hh.

Referenced by add_node(), connect_socket(), and LinkSearchOpParams().

◆ node_tree

bNodeTree& blender::nodes::LinkSearchOpParams::node_tree

Definition at line 33 of file NOD_socket_search_link.hh.

Referenced by add_node(), connect_socket(), LinkSearchOpParams(), and update_and_connect_available_socket().

◆ socket

bNodeSocket& blender::nodes::LinkSearchOpParams::socket

The existing socket to connect any added nodes to. Might be an input or output socket.

Definition at line 41 of file NOD_socket_search_link.hh.

Referenced by connect_available_socket(), connect_available_socket_by_identifier(), connect_socket(), and LinkSearchOpParams().

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