Open 3D Engine GraphCanvas 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 Types | Public Member Functions | Static Public Attributes | List of all members
GraphCanvas::SlotRequests Class Referenceabstract

#include <SlotBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::EntityId
 

Public Member Functions

virtual const AZ::EntityId & GetNode () const =0
 Get the entity ID of the node that owns this slot, if any.
 
virtual void SetNode (const AZ::EntityId &)=0
 Set the entity ID of the node that owns this slot, if any.
 
virtual Endpoint GetEndpoint () const =0
 Returns the endpoint represented by this SlotId.
 
virtual const AZStd::string GetName () const =0
 
virtual void SetName (const AZStd::string &)=0
 Set the slot's name.
 
virtual void SetDetails (const AZStd::string &name, const AZStd::string &tooltip)=0
 Set the slot's name & tooltip.
 
virtual const AZStd::string GetTooltip () const =0
 Get the tooltip for the slot.
 
virtual void SetTooltip (const AZStd::string &)=0
 Set the tooltip this slot should display.
 
virtual SlotGroup GetSlotGroup () const =0
 Get the group of the slot.
 
virtual SlotType GetSlotType () const =0
 Get the type of the slot.
 
virtual ConnectionType GetConnectionType () const =0
 Get the connection type of the slot is in.
 
virtual void SetDisplayOrdering (int ordering)=0
 
virtual int GetDisplayOrdering () const =0
 Returns the ordering index of the slot within it's given group.
 
virtual bool IsConnectedTo (const Endpoint &endpoint) const =0
 
virtual void FindConnectionsForEndpoints (const AZStd::unordered_set< Endpoint > &searchEndpoints, AZStd::unordered_set< ConnectionId > &connectedEndpoints)=0
 
virtual bool CanDisplayConnectionTo (const Endpoint &endpoint) const =0
 
virtual bool CanCreateConnectionTo (const Endpoint &endpoint) const =0
 
virtual AZ::EntityId CreateConnectionWithEndpoint (const Endpoint &endpoint)=0
 
virtual AZ::EntityId DisplayConnection ()=0
 Returns the connection to be used when trying to create a connection from this object.
 
virtual AZ::EntityId DisplayConnectionWithEndpoint (const Endpoint &endpoint)=0
 
virtual void DisplayProposedConnection (const AZ::EntityId &connectionId, const Endpoint &endpoint)=0
 Displays the proposed connection on the slot.
 
virtual void RemoveProposedConnection (const AZ::EntityId &connectionId, const Endpoint &endpoint)=0
 Restores the connection display to the previous state.
 
virtual void AddConnectionId (const AZ::EntityId &connectionId, const Endpoint &endpoint)=0
 Adds the given connection to the slot.
 
virtual void RemoveConnectionId (const AZ::EntityId &connectionId, const Endpoint &endpoint)=0
 Remove the specified connection from the slot.
 
virtual AZStd::any * GetUserData ()=0
 Gets the UserData on the slot.
 
virtual bool HasConnections () const =0
 Returns whether or not the slot has any connections.
 
virtual AZ::EntityId GetLastConnection () const =0
 
virtual AZStd::vector< AZ::EntityId > GetConnections () const =0
 Returns the list of connections connected to this slot.
 
virtual void SetConnectionDisplayState (RootGraphicsItemDisplayState displayState)=0
 Sets the specified display state onto all of the connected connections.
 
virtual void ReleaseConnectionDisplayState ()=0
 Sets the specified display state onto all of the connected connections.
 
virtual void ClearConnections ()=0
 Clears all of the connections currently attached to this slot.
 
virtual const SlotConfiguration & GetSlotConfiguration () const =0
 
virtual SlotConfiguration * CloneSlotConfiguration () const =0
 
virtual void RemapSlotForModel (const Endpoint &endpoint)=0
 
virtual bool HasModelRemapping () const =0
 
virtual AZStd::vector< Endpoint > GetRemappedModelEndpoints () const =0
 
virtual int GetLayoutPriority () const
 
virtual void SetLayoutPriority (int layoutPriority)=0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

SlotRequests Requests to retrieve or modify the current state of a slot.

Member Function Documentation

◆ CreateConnectionWithEndpoint()

virtual AZ::EntityId GraphCanvas::SlotRequests::CreateConnectionWithEndpoint ( const Endpoint &  endpoint)
pure virtual

Returns the connection to be used when trying to create a connection from this object. Will create a connection with the underlying data model.

◆ DisplayConnectionWithEndpoint()

virtual AZ::EntityId GraphCanvas::SlotRequests::DisplayConnectionWithEndpoint ( const Endpoint &  endpoint)
pure virtual

Returns the connection to be used when trying to create a connection from this object. Will not create a connection with the underlying data model.

◆ GetLastConnection()

virtual AZ::EntityId GraphCanvas::SlotRequests::GetLastConnection ( ) const
pure virtual

Returns the last connection connected to the slot Returns an invalid EntityId if the slot has no connections

◆ GetName()

virtual const AZStd::string GraphCanvas::SlotRequests::GetName ( ) const
pure virtual

Get the name, or label, of the slot. These generally appear as a label against Input or Output slots.

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