blender::nodes::DOutputSocket Class Reference

#include <NOD_derived_node_tree.hh>

Inheritance diagram for blender::nodes::DOutputSocket:

Classes
struct	TargetSocketPathInfo

Public Types
using	ForeachTargetSocketFn = FunctionRef< void(DInputSocket, const TargetSocketPathInfo &path_info)>

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 OutputSocketRef *socket)
	DOutputSocket (const DSocket &base_socket)
const OutputSocketRef *	socket_ref () const
const OutputSocketRef *	operator-> () const
Public Member Functions inherited from blender::nodes::DSocket
	DSocket ()=default
	DSocket (const DTreeContext *context, const SocketRef *socket)
	DSocket (const DInputSocket &input_socket)
	DSocket (const DOutputSocket &output_socket)
const DTreeContext *	context () const
const SocketRef *	socket_ref () const
const SocketRef *	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 SocketRef *	socket_ref_ = nullptr

Detailed Description

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

Definition at line 144 of file NOD_derived_node_tree.hh.

Member Typedef Documentation

ForeachTargetSocketFn

using blender::nodes::DOutputSocket::ForeachTargetSocketFn = FunctionRef<void(DInputSocket, const TargetSocketPathInfo &path_info)>

Definition at line 161 of file NOD_derived_node_tree.hh.

Constructor & Destructor Documentation

DOutputSocket() [1/3]

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

default

DOutputSocket() [2/3]

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

inline

Definition at line 423 of file NOD_derived_node_tree.hh.

DOutputSocket() [3/3]

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

inlineexplicit

Definition at line 428 of file NOD_derived_node_tree.hh.

References BLI_assert, and blender::nodes::SocketRef::is_output().

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 211 of file derived_node_tree.cc.

Referenced by blender::modifiers::geometry_nodes::GeometryNodesEvaluator::forward_output(), and blender::modifiers::geometry_nodes::GeometryNodesEvaluator::initialize_node_state().

get_active_corresponding_group_output_socket()

DInputSocket blender::nodes::DOutputSocket::get_active_corresponding_group_output_socket

(

)

const

Definition at line 142 of file derived_node_tree.cc.

References BLI_assert, blender::nodes::DTreeContext::child_context(), blender::nodes::DSocket::context_, blender::nodes::SocketRef::index(), blender::nodes::NodeRef::is_group_node(), blender::nodes::SocketRef::node(), NODE_DO_OUTPUT, blender::nodes::NodeTreeRef::nodes_by_type(), blender::Span< T >::size(), blender::nodes::DSocket::socket_ref_, and blender::nodes::DTreeContext::tree().

get_corresponding_group_node_input()

DInputSocket blender::nodes::DOutputSocket::get_corresponding_group_node_input

(

)

const

Definition at line 127 of file derived_node_tree.cc.

References BLI_assert, blender::nodes::DSocket::context_, blender::nodes::SocketRef::index(), blender::nodes::NodeRef::input(), blender::nodes::NodeRef::is_group_input_node(), blender::nodes::SocketRef::node(), blender::nodes::NodeRef::outputs(), blender::nodes::DTreeContext::parent_context(), blender::nodes::DTreeContext::parent_node(), and blender::nodes::DSocket::socket_ref_.

operator->()

const OutputSocketRef * blender::nodes::DOutputSocket::operator-> ( ) const

inline

Definition at line 438 of file NOD_derived_node_tree.hh.

References blender::nodes::DSocket::socket_ref_.

socket_ref()

const OutputSocketRef * blender::nodes::DOutputSocket::socket_ref ( ) const

inline

Definition at line 433 of file NOD_derived_node_tree.hh.

References blender::nodes::DSocket::socket_ref_.

---

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

• NOD_derived_node_tree.hh
• derived_node_tree.cc