blender::nodes::GatherLinkSearchOpParams Class Reference

#include <NOD_socket_search_link.hh>

Public Member Functions
	GatherLinkSearchOpParams (const bNodeType &node_type, const bNodeTree &node_tree, const bNodeSocket &other_socket, Vector< SocketLinkOperation > &items)
const bNodeSocket &	other_socket () const
const bNodeTree &	node_tree () const
const bNodeType &	node_type () const
eNodeSocketInOut	in_out () const
void	add_item (std::string socket_name, SocketLinkOperation::LinkSocketFn fn, int weight=0)

Detailed Description

Definition at line 70 of file NOD_socket_search_link.hh.

Constructor & Destructor Documentation

GatherLinkSearchOpParams()

blender::nodes::GatherLinkSearchOpParams::GatherLinkSearchOpParams ( const bNodeType &  node_type, const bNodeTree &  node_tree, const bNodeSocket &  other_socket, Vector< SocketLinkOperation > &  items  )

inline

Definition at line 82 of file NOD_socket_search_link.hh.

Member Function Documentation

add_item()

void blender::nodes::GatherLinkSearchOpParams::add_item	(	std::string	socket_name,
		SocketLinkOperation::LinkSocketFn	fn,
		int	weight = 0
	)

Parameters

weight

Used to customize the order when multiple search items match.

Warning

When creating lambdas for the #fn argument, be careful not to capture this class itself, since it is temporary. That is why we tend to use the same variable name for this class (params) that we do for the argument to LinkSocketFn.

Definition at line 16 of file socket_search_link.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), IFACE_, UI_MENU_ARROW_SEP, and bNodeType::ui_name.

in_out()

eNodeSocketInOut blender::nodes::GatherLinkSearchOpParams::in_out

(

)

const

Whether to list the input or output sockets of the node.

Definition at line 42 of file socket_search_link.cc.

References bNodeSocket::in_out, SOCK_IN, and SOCK_OUT.

node_tree()

const bNodeTree & blender::nodes::GatherLinkSearchOpParams::node_tree

(

)

const

The node tree the user is editing when the search menu is created.

Definition at line 32 of file socket_search_link.cc.

node_type()

const bNodeType & blender::nodes::GatherLinkSearchOpParams::node_type

(

)

const

The type of the node in the current callback.

Definition at line 37 of file socket_search_link.cc.

other_socket()

const bNodeSocket & blender::nodes::GatherLinkSearchOpParams::other_socket

(

)

const

The node on the other side of the dragged link.

Definition at line 27 of file socket_search_link.cc.

---

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

• NOD_socket_search_link.hh
• socket_search_link.cc