blender::nodes::DOutputSocket Class Reference

#include <NOD_derived_node_tree.hh>

Inherits blender::nodes::DSocket.

Classes
struct	TargetSocketPathInfo

Public Types
using	ForeachTargetSocketFn

Public Member Functions
	DOutputSocket ()=default
DInputSocket	get_corresponding_group_node_input () const
DInputSocket	get_active_corresponding_group_output_socket () const
void	foreach_target_socket (ForeachTargetSocketFn target_fn) const
#DOutputSocket Inline Methods
	DOutputSocket (const DTreeContext *context, const bNodeSocket *socket)
	DOutputSocket (const DSocket &base_socket)
Public Member Functions inherited from blender::nodes::DSocket
	DSocket ()=default
	DSocket (const DTreeContext *context, const bNodeSocket *socket)
	DSocket (const DInputSocket &input_socket)
	DSocket (const DOutputSocket &output_socket)
const DTreeContext *	context () const
const bNodeSocket *	bsocket () const
const bNodeSocket *	operator-> () const
const bNodeSocket &	operator* () const
	operator bool () const
uint64_t	hash () const
DNode	node () const

Additional Inherited Members
Protected Attributes inherited from blender::nodes::DSocket
const DTreeContext *	context_ = nullptr
const bNodeSocket *	bsocket_ = nullptr

Detailed Description

A (nullable) reference to an output socket and the context it is in.

Definition at line 150 of file NOD_derived_node_tree.hh.

Member Typedef Documentation

ForeachTargetSocketFn

using blender::nodes::DOutputSocket::ForeachTargetSocketFn

Initial value:

 
FunctionRef<void(DInputSocket, const TargetSocketPathInfo &path_info)>

Definition at line 164 of file NOD_derived_node_tree.hh.

Constructor & Destructor Documentation

DOutputSocket() [1/3]

blender::nodes::DOutputSocket::DOutputSocket ( )

default

References blender::nodes::DSocket::context(), and blender::nodes::DSocket::DSocket().

DOutputSocket() [2/3]

blender::nodes::DOutputSocket::DOutputSocket ( const DTreeContext * context, const bNodeSocket * socket )

inline

Definition at line 421 of file NOD_derived_node_tree.hh.

References blender::nodes::DSocket::bsocket(), blender::nodes::DSocket::context(), and blender::nodes::DSocket::DSocket().

DOutputSocket() [3/3]

blender::nodes::DOutputSocket::DOutputSocket ( const DSocket & base_socket )

inlineexplicit

Definition at line 426 of file NOD_derived_node_tree.hh.

References BLI_assert, and blender::nodes::DSocket::DSocket().

Member Function Documentation

foreach_target_socket()

void blender::nodes::DOutputSocket::foreach_target_socket

(

ForeachTargetSocketFn

target_fn

)

const

Calls target_fn for every "real" target socket. "Real" means that reroutes, muted nodes and node groups are handled by this function. Target sockets are on the nodes that use the value from this socket.

Definition at line 221 of file derived_node_tree.cc.

References foreach_target_socket().

Referenced by foreach_target_socket().

get_active_corresponding_group_output_socket()

DInputSocket blender::nodes::DOutputSocket::get_active_corresponding_group_output_socket

(

)

const

Definition at line 152 of file derived_node_tree.cc.

References BLI_assert, blender::nodes::DSocket::bsocket_, blender::nodes::DTreeContext::btree(), blender::nodes::DSocket::context_, NODE_DO_OUTPUT, and blender::Span< T >::size().

Referenced by blender::nodes::DInputSocket::foreach_origin_socket().

get_corresponding_group_node_input()

DInputSocket blender::nodes::DOutputSocket::get_corresponding_group_node_input

(

)

const

Definition at line 137 of file derived_node_tree.cc.

References BLI_assert, blender::nodes::DSocket::bsocket_, and blender::nodes::DSocket::context_.

Referenced by blender::nodes::DInputSocket::foreach_origin_socket().

---

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

• NOD_derived_node_tree.hh
• derived_node_tree.cc