blender::nodes::DSocket Class Reference

#include <NOD_derived_node_tree.hh>

Inherited by blender::nodes::DInputSocket, and blender::nodes::DOutputSocket.

Public Member Functions
	DSocket ()=default
#DSocket Inline Methods
	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

Protected Attributes
const DTreeContext *	context_ = nullptr
const bNodeSocket *	bsocket_ = nullptr

Detailed Description

A (nullable) reference to a socket and the context it is in. It is unique within an entire nested node group hierarchy. This type is small and can be passed around by value.

A DSocket can represent an input or an output socket. If the type of a socket is known at compile time is preferable to use DInputSocket or DOutputSocket instead.

Definition at line 106 of file NOD_derived_node_tree.hh.

Constructor & Destructor Documentation

DSocket() [1/4]

blender::nodes::DSocket::DSocket ( )

default

References bsocket_, context(), context_, and DSocket().

Referenced by blender::nodes::DInputSocket::DInputSocket(), blender::nodes::DInputSocket::DInputSocket(), blender::nodes::DInputSocket::DInputSocket(), blender::nodes::DOutputSocket::DOutputSocket(), blender::nodes::DOutputSocket::DOutputSocket(), blender::nodes::DOutputSocket::DOutputSocket(), DSocket(), DSocket(), DSocket(), and blender::nodes::DInputSocket::foreach_origin_socket().

DSocket() [2/4]

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

inline

Definition at line 345 of file NOD_derived_node_tree.hh.

References BLI_assert, bsocket(), bsocket_, context(), and context_.

DSocket() [3/4]

blender::nodes::DSocket::DSocket ( const DInputSocket & input_socket )

inline

Definition at line 352 of file NOD_derived_node_tree.hh.

References bsocket_, context_, and DSocket().

DSocket() [4/4]

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

inline

Definition at line 357 of file NOD_derived_node_tree.hh.

References bsocket_, context_, and DSocket().

Member Function Documentation

bsocket()

const bNodeSocket * blender::nodes::DSocket::bsocket ( ) const

inline

Definition at line 367 of file NOD_derived_node_tree.hh.

References bsocket_.

Referenced by blender::nodes::DInputSocket::DInputSocket(), blender::nodes::DOutputSocket::DOutputSocket(), DSocket(), and blender::compositor::gpu_type_from_socket().

context()

const DTreeContext * blender::nodes::DSocket::context ( ) const

inline

Definition at line 362 of file NOD_derived_node_tree.hh.

References context_.

Referenced by blender::nodes::DInputSocket::DInputSocket(), blender::nodes::DInputSocket::DInputSocket(), blender::nodes::DOutputSocket::DOutputSocket(), blender::nodes::DOutputSocket::DOutputSocket(), DSocket(), DSocket(), and blender::nodes::DerivedNodeTree::to_dot().

hash()

uint64_t blender::nodes::DSocket::hash ( ) const

inline

Definition at line 388 of file NOD_derived_node_tree.hh.

References bsocket_, context_, and blender::get_default_hash().

node()

DNode blender::nodes::DSocket::node ( ) const

inline

Definition at line 393 of file NOD_derived_node_tree.hh.

References BLI_assert, bsocket_, and context_.

operator bool()

blender::nodes::DSocket::operator bool ( ) const

inline

Definition at line 372 of file NOD_derived_node_tree.hh.

References bsocket_.

operator*()

const bNodeSocket & blender::nodes::DSocket::operator* ( ) const

inline

Definition at line 382 of file NOD_derived_node_tree.hh.

References BLI_assert, and bsocket_.

operator->()

const bNodeSocket * blender::nodes::DSocket::operator-> ( ) const

inline

Definition at line 377 of file NOD_derived_node_tree.hh.

References bsocket_.

Member Data Documentation

bsocket_

const bNodeSocket* blender::nodes::DSocket::bsocket_ = nullptr

protected

Definition at line 109 of file NOD_derived_node_tree.hh.

Referenced by bsocket(), DSocket(), DSocket(), DSocket(), DSocket(), blender::nodes::DInputSocket::foreach_origin_socket(), blender::nodes::DOutputSocket::get_active_corresponding_group_output_socket(), blender::nodes::DInputSocket::get_corresponding_group_input_sockets(), blender::nodes::DOutputSocket::get_corresponding_group_node_input(), blender::nodes::DInputSocket::get_corresponding_group_node_output(), hash(), node(), operator bool(), operator*(), and operator->().

context_

const DTreeContext* blender::nodes::DSocket::context_ = nullptr

protected

Definition at line 108 of file NOD_derived_node_tree.hh.

Referenced by context(), DSocket(), DSocket(), DSocket(), DSocket(), blender::nodes::DInputSocket::foreach_origin_socket(), blender::nodes::DOutputSocket::get_active_corresponding_group_output_socket(), blender::nodes::DInputSocket::get_corresponding_group_input_sockets(), blender::nodes::DOutputSocket::get_corresponding_group_node_input(), blender::nodes::DInputSocket::get_corresponding_group_node_output(), hash(), and node().

---

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

• NOD_derived_node_tree.hh