blender::fn::lazy_function::Socket Class Reference

#include <FN_lazy_function_graph.hh>

Inherits blender::NonCopyable, and blender::NonMovable.

Inherited by blender::fn::lazy_function::InputSocket, and blender::fn::lazy_function::OutputSocket.

Public Member Functions
std::string	name () const
std::string	detailed_name () const
#Socket Inline Methods
bool	is_input () const
bool	is_output () const
int	index () const
int	index_in_graph () const
InputSocket &	as_input ()
OutputSocket &	as_output ()
const InputSocket &	as_input () const
const OutputSocket &	as_output () const
const Node &	node () const
Node &	node ()
const CPPType &	type () const

Protected Attributes
Node *	node_
const CPPType *	type_
bool	is_input_
int	index_in_node_
int	index_in_graph_
friend	Graph

Detailed Description

A #Socket is the interface of a Node. Every #Socket is either an #InputSocket or #OutputSocket. Links can be created from output sockets to input sockets.

Definition at line 40 of file FN_lazy_function_graph.hh.

Member Function Documentation

as_input() [1/2]

InputSocket & blender::fn::lazy_function::Socket::as_input ( )

inline

Definition at line 338 of file FN_lazy_function_graph.hh.

References BLI_assert, and is_input().

as_input() [2/2]

const InputSocket & blender::fn::lazy_function::Socket::as_input ( ) const

inline

Definition at line 350 of file FN_lazy_function_graph.hh.

References BLI_assert, and is_input().

as_output() [1/2]

OutputSocket & blender::fn::lazy_function::Socket::as_output ( )

inline

Definition at line 344 of file FN_lazy_function_graph.hh.

References BLI_assert, and is_output().

as_output() [2/2]

const OutputSocket & blender::fn::lazy_function::Socket::as_output ( ) const

inline

Definition at line 356 of file FN_lazy_function_graph.hh.

References BLI_assert, and is_output().

detailed_name()

std::string blender::fn::lazy_function::Socket::detailed_name

(

)

const

Definition at line 160 of file lazy_function_graph.cc.

References index_in_node_, is_input_, blender::fn::lazy_function::Node::name(), name(), and node_.

index()

int blender::fn::lazy_function::Socket::index ( ) const

inline

Definition at line 328 of file FN_lazy_function_graph.hh.

References index_in_node_.

Referenced by blender::fn::lazy_function::GraphExecutor::GraphExecutor().

index_in_graph()

int blender::fn::lazy_function::Socket::index_in_graph ( ) const

inline

Definition at line 333 of file FN_lazy_function_graph.hh.

References index_in_graph_.

is_input()

bool blender::fn::lazy_function::Socket::is_input ( ) const

inline

Definition at line 318 of file FN_lazy_function_graph.hh.

References is_input_.

Referenced by as_input(), and as_input().

is_output()

bool blender::fn::lazy_function::Socket::is_output ( ) const

inline

Definition at line 323 of file FN_lazy_function_graph.hh.

References is_input_.

Referenced by as_output(), and as_output().

name()

std::string blender::fn::lazy_function::Socket::name

(

)

const

Definition at line 146 of file lazy_function_graph.cc.

References blender::fn::lazy_function::FunctionNode::function(), index_in_node_, blender::fn::lazy_function::LazyFunction::input_name(), blender::fn::lazy_function::Node::is_function(), is_input_, node_, and blender::fn::lazy_function::LazyFunction::output_name().

Referenced by detailed_name(), blender::nodes::GeometryNodesLazyFunctionLogger::dump_when_input_is_set_twice(), blender::fn::lazy_function::GraphExecutor::input_name(), blender::fn::lazy_function::GraphExecutor::output_name(), and blender::fn::lazy_function::Graph::ToDotOptions::socket_name().

node() [1/2]

Node & blender::fn::lazy_function::Socket::node ( )

inline

Definition at line 367 of file FN_lazy_function_graph.hh.

References node_.

node() [2/2]

const Node & blender::fn::lazy_function::Socket::node ( ) const

inline

Definition at line 362 of file FN_lazy_function_graph.hh.

References node_.

Referenced by blender::nodes::GeometryNodesLazyFunctionLogger::dump_when_input_is_set_twice(), and blender::fn::lazy_function::GraphExecutor::GraphExecutor().

type()

const CPPType & blender::fn::lazy_function::Socket::type ( ) const

inline

Definition at line 372 of file FN_lazy_function_graph.hh.

References type_.

Referenced by blender::fn::lazy_function::GraphExecutor::GraphExecutor().

Member Data Documentation

Graph

friend blender::fn::lazy_function::Socket::Graph

protected

Definition at line 63 of file FN_lazy_function_graph.hh.

index_in_graph_

int blender::fn::lazy_function::Socket::index_in_graph_

protected

Index of the socket in the entire graph. Every socket has a different index.

Definition at line 61 of file FN_lazy_function_graph.hh.

Referenced by index_in_graph().

index_in_node_

int blender::fn::lazy_function::Socket::index_in_node_

protected

Index of the socket. E.g. 0 for the first input and the first output socket.

Definition at line 57 of file FN_lazy_function_graph.hh.

Referenced by blender::fn::lazy_function::Graph::add_function(), blender::fn::lazy_function::Graph::add_input(), blender::fn::lazy_function::Graph::add_output(), detailed_name(), index(), and name().

is_input_

bool blender::fn::lazy_function::Socket::is_input_

protected

Indicates whether this is an #InputSocket or #OutputSocket.

Definition at line 53 of file FN_lazy_function_graph.hh.

Referenced by blender::fn::lazy_function::Graph::add_function(), blender::fn::lazy_function::Graph::add_input(), blender::fn::lazy_function::Graph::add_output(), detailed_name(), is_input(), is_output(), and name().

node_

Node* blender::fn::lazy_function::Socket::node_

protected

The node the socket belongs to.

Definition at line 45 of file FN_lazy_function_graph.hh.

Referenced by blender::fn::lazy_function::Graph::add_function(), blender::fn::lazy_function::Graph::add_input(), blender::fn::lazy_function::Graph::add_output(), detailed_name(), name(), node(), and node().

type_

const CPPType* blender::fn::lazy_function::Socket::type_

protected

Data type of the socket. Only sockets with the same type can be linked.

Definition at line 49 of file FN_lazy_function_graph.hh.

Referenced by blender::fn::lazy_function::Graph::add_function(), blender::fn::lazy_function::Graph::add_input(), blender::fn::lazy_function::Graph::add_output(), and type().

---

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

• FN_lazy_function_graph.hh
• lazy_function_graph.cc