CeresEngine::MaterialGraphSocket Class Reference

#include <CeresEngine/Material/Graph/MaterialGraphSocket.hpp>

Inheritance diagram for CeresEngine::MaterialGraphSocket:

Public Member Functions
	MaterialGraphSocket (MaterialGraphNode &node, GraphSocketDirection direction, MaterialGraphSocketType type)
	Creates a new material graph socket.
virtual bool	isCompatibleWith (const MaterialGraphSocket &other)
	Determines whether the given socket is compatible with this socket.
Public Member Functions inherited from CeresEngine::GraphSocket
	GraphSocket (GraphNode &node, const GraphSocketDirection direction, const GraphValueType type)
GraphConnection *	getConnectionTo (GraphSocket &targetSocket) const
const Vector< GraphConnectionPtr > &	getConnections () const noexcept
GraphConnection *	connectWith (GraphSocket &targetSocket)
void	disconnectWith (GraphSocket &targetSocket)
GraphConnection *	connectWith (GraphNode &targetNode, StringView targetSocketName)
GraphConnection *	disconnectWith (GraphNode &targetNode, StringView targetSocketName)
GraphNode &	getNode () const noexcept
	A reference to the node that owns this socket.
GraphSocketDirection	getDirection () const noexcept
	Determines the connection direction of the socket.
const GraphSocketFlags &	getFlags () const noexcept
	A set of user-defined flags that customize behavior of the socket.
void	setFlags (const GraphSocketFlags &flags)
	A set of user-defined flags that customize behavior of the socket.
GraphValueType	getType () const noexcept
	Determines the type of this socket.
Public Member Functions inherited from CeresEngine::RefCounted< GraphSocket >
	RefCounted (Args &&... args)
	Creates a new RefCounted object and constructs a new Deleter by forwarding Args to it.
void	retain () noexcept
	Retains the object by increment it's reference count by one.
bool	release () noexcept
	Relases the object by decrementing it's reference count by one.

Private Types
using	super = GraphSocket

Private Attributes
MaterialGraphSocketType	mType
	The socket in/output type.

Additional Inherited Members
Public Attributes inherited from CeresEngine::GraphSocket
Event< void()>	onChange
Event< void(GraphConnection &)>	onConnect
Event< void(GraphConnection &)>	onDisconnect

Member Typedef Documentation

super

using CeresEngine::MaterialGraphSocket::super = GraphSocket

private

Constructor & Destructor Documentation

MaterialGraphSocket()

CeresEngine::MaterialGraphSocket::MaterialGraphSocket	(	MaterialGraphNode &	node,
		GraphSocketDirection	direction,
		MaterialGraphSocketType	type
	)

Creates a new material graph socket.

Parameters

node	A reference to the node that owns the socket.
direction	The direction of the graph connection, either input or output.
type	The type of value of the socket in/output.

Member Function Documentation

isCompatibleWith()

virtual bool CeresEngine::MaterialGraphSocket::isCompatibleWith ( const MaterialGraphSocket &  other )

virtual

Determines whether the given socket is compatible with this socket.

Member Data Documentation

mType

MaterialGraphSocketType CeresEngine::MaterialGraphSocket::mType

private

The socket in/output type.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Material/Graph/MaterialGraphSocket.hpp