Open 3D Engine GraphModel Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
GraphModel::Connection Class Reference

!! Start in Graph.h for high level GraphModel documentation !!! More...

#include <Connection.h>

Inherits GraphModel::GraphElement.

Public Member Functions

 AZ_CLASS_ALLOCATOR (Connection, AZ::SystemAllocator)
 
 AZ_RTTI (Connection, "{B4301AE1-98F4-474E-B0A1-18F27EEDB059}", GraphElement)
 
 Connection (GraphPtr graph, SlotPtr sourceSlot, SlotPtr targetSlot)
 
void PostLoadSetup (GraphPtr graph)
 
NodePtr GetSourceNode () const
 
NodePtr GetTargetNode () const
 
SlotPtr GetSourceSlot () const
 
SlotPtr GetTargetSlot () const
 
const Endpoint & GetSourceEndpoint () const
 
const Endpoint & GetTargetEndpoint () const
 
- Public Member Functions inherited from GraphModel::GraphElement
 AZ_CLASS_ALLOCATOR (GraphElement, AZ::SystemAllocator)
 
 AZ_RTTI (GraphElement, "{FD83C7CA-556B-49F1-BACE-6E9C7A4D6347}")
 
 GraphElement (GraphPtr graph)
 
GraphPtr GetGraph () const
 Returns the Graph that owns this GraphElement.
 
GraphContextPtr GetGraphContext () const
 Returns the GraphContext for this GraphElement.
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from GraphModel::GraphElement
static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Attributes inherited from GraphModel::GraphElement
AZStd::weak_ptr< Graph > m_graph
 

Detailed Description

!! Start in Graph.h for high level GraphModel documentation !!!

Defines the connection between an Output Slot and an Input Slot. Usually a Connection instance will be created by the Graph class rather than directly.

Constructor & Destructor Documentation

◆ Connection()

GraphModel::Connection::Connection ( GraphPtr  graph,
SlotPtr  sourceSlot,
SlotPtr  targetSlot 
)

Create a Connection for a specific Graph, though this doesn't actually add it to the Graph.

Member Function Documentation

◆ PostLoadSetup()

void GraphModel::Connection::PostLoadSetup ( GraphPtr  graph)

Initializion after the Connection has been serialized in. This must be called whenever the default constructor is used. Sets the m_graph pointer and caches pointers to other GraphElements.

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