Open 3D Engine GraphCanvas Gem API Reference  24.09
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 | Protected Member Functions | Protected Attributes | List of all members
GraphCanvas::SlotComponent Class Reference

Inherits AZ::Component, SlotRequestBus::Handler, SceneMemberRequestBus::Handler, and SceneMemberNotificationBus::Handler.

Inherited by GraphCanvas::DataSlotComponent, GraphCanvas::ExecutionSlotComponent, GraphCanvas::ExtenderSlotComponent, and GraphCanvas::PropertySlotComponent.

Public Member Functions

 AZ_COMPONENT (SlotComponent, "{EACFC8FB-C75B-4ABA-988D-89C964B9A4E4}")
 
 SlotComponent (const SlotType &slotType)
 
 SlotComponent (const SlotType &slotType, const SlotConfiguration &slotConfiguration)
 
void Activate () override
 
void Deactivate () override
 
void SetScene (const AZ::EntityId &sceneId) override
 
void ClearScene (const AZ::EntityId &oldSceneId) override
 
void SignalMemberSetupComplete () override
 
AZ::EntityId GetScene () const override
 
void OnSceneSet (const AZ::EntityId &) override
 
void OnSceneReady () override
 
const AZ::EntityId & GetNode () const override
 
void SetNode (const AZ::EntityId &) override
 
Endpoint GetEndpoint () const override
 
const AZStd::string GetName () const override
 
void SetName (const AZStd::string &name) override
 
void SetDetails (const AZStd::string &name, const AZStd::string &tooltip) override
 
const AZStd::string GetTooltip () const override
 
void SetTooltip (const AZStd::string &tooltip) override
 
void DisplayProposedConnection (const AZ::EntityId &connectionId, const Endpoint &endpoint) override
 
void RemoveProposedConnection (const AZ::EntityId &connectionId, const Endpoint &endpoint) override
 
void AddConnectionId (const AZ::EntityId &connectionId, const Endpoint &endpoint) override
 
void RemoveConnectionId (const AZ::EntityId &connectionId, const Endpoint &endpoint) override
 
ConnectionType GetConnectionType () const override
 
SlotGroup GetSlotGroup () const override
 
SlotType GetSlotType () const override
 
void SetDisplayOrdering (int ordering) override
 
int GetDisplayOrdering () const override
 
bool IsConnectedTo (const Endpoint &endpoint) const override
 
void FindConnectionsForEndpoints (const AZStd::unordered_set< GraphCanvas::Endpoint > &searchEndpoints, AZStd::unordered_set< ConnectionId > &connections) override
 
bool CanDisplayConnectionTo (const Endpoint &endpoint) const override
 
bool CanCreateConnectionTo (const Endpoint &endpoint) const override
 
AZ::EntityId CreateConnectionWithEndpoint (const Endpoint &endpoint) override
 
AZ::EntityId DisplayConnection () override
 
AZ::EntityId DisplayConnectionWithEndpoint (const Endpoint &endpoint) override
 
AZStd::any * GetUserData () override
 
bool HasConnections () const override
 
bool IsNameHidden () const
 
AZ::EntityId GetLastConnection () const override
 
AZStd::vector< AZ::EntityId > GetConnections () const override
 
void SetConnectionDisplayState (RootGraphicsItemDisplayState displayState) override
 
void ReleaseConnectionDisplayState () override
 
void ClearConnections () override
 
const SlotConfiguration & GetSlotConfiguration () const override
 
SlotConfiguration * CloneSlotConfiguration () const override
 
void RemapSlotForModel (const Endpoint &endpoint) override
 
bool HasModelRemapping () const override
 
AZStd::vector< Endpoint > GetRemappedModelEndpoints () const override
 
int GetLayoutPriority () const override
 
void SetLayoutPriority (int priority) override
 
void Show ()
 
void Hide ()
 
bool IsVisible () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static AZ::Entity * CreateCoreSlotEntity ()
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &)
 

Protected Member Functions

void PopulateSlotConfiguration (SlotConfiguration &slotConfiguration) const
 
AZ::EntityId CreateConnectionHelper (const Endpoint &otherEndpoint, bool createConnection)
 
 SlotComponent (const SlotComponent &)=delete
 
const SlotComponent & operator= (const SlotComponent &)=delete
 
virtual AZ::Entity * ConstructConnectionEntity (const Endpoint &sourceEndpoint, const Endpoint &targetEndpoint, bool createModelConnection)
 
void FinalizeDisplay ()
 
virtual void OnFinalizeDisplay ()
 

Protected Attributes

AZStd::vector< Endpoint > m_modelRedirections
 
AZ::EntityId m_nodeId
 The Node this Slot belongs to.
 
SlotType m_slotType
 
SlotConfiguration m_slotConfiguration
 
int m_displayOrdering
 
int m_layoutPriority
 
AZStd::vector< AZ::EntityId > m_connections
 Keeps track of connections to this slot.
 
StateSetter< RootGraphicsItemDisplayState > m_connectionDisplayStateStateSetter
 
AZStd::any m_userData
 Stores custom user data for this slot.
 
bool m_visible
 
The documentation for this class was generated from the following file: