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 | Friends | List of all members
GraphCanvas::NodeComponent Class Reference

Inherits GraphCanvas::GraphCanvasPropertyComponent, NodeRequestBus::Handler, SceneMemberRequestBus::Handler, SceneMemberNotificationBus::Handler, GraphCanvas::SceneNotificationBus::Handler, AZ::EntityBus::Handler, SlotNotificationBus::MultiHandler, GraphCanvas::ComponentSaveDataInterface< NodeSaveData >, ConnectionNotificationBus::Handler, and GroupableSceneMemberRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (NodeComponent, "{7385AAC3-18F0-4BCE-BD9B-C17798C899EC}", GraphCanvasPropertyComponent)
 
 NodeComponent (const NodeConfiguration &config)
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
void OnConnectedTo (const AZ::EntityId &connectionId, const Endpoint &endpoint) override
 
void OnDisconnectedFrom (const AZ::EntityId &connectionId, const Endpoint &endpoint) override
 
void OnEntityExists (const AZ::EntityId &) override
 
void OnEntityActivated (const AZ::EntityId &) override
 
void SetScene (const AZ::EntityId &sceneId) override
 
void ClearScene (const AZ::EntityId &oldSceneId) override
 
void SignalMemberSetupComplete () override
 
AZ::EntityId GetScene () const override
 
void OnSceneReady () override
 
void OnStylesChanged () override
 
void OnGraphLoadComplete () override
 
void OnPasteEnd () override
 
void SetTooltip (const AZStd::string &tooltip) override
 
const AZStd::string GetTooltip () const override
 
void SetShowInOutliner (bool showInOutliner) override
 
bool ShowInOutliner () const override
 
void AddSlot (const AZ::EntityId &slotId) override
 
void RemoveSlot (const AZ::EntityId &slotId) override
 
AZStd::vector< AZ::EntityId > GetSlotIds () const override
 
AZStd::vector< SlotId > GetVisibleSlotIds () const override
 
AZStd::vector< SlotId > FindVisibleSlotIdsByType (const ConnectionType &connectionType, const SlotType &slotType) const override
 
bool HasConnections () const override
 
AZStd::any * GetUserData () override
 
bool IsWrapped () const override
 
void SetWrappingNode (const AZ::EntityId &wrappingNode) override
 
AZ::EntityId GetWrappingNode () const override
 
void SignalBatchedConnectionManipulationBegin () override
 
void SignalBatchedConnectionManipulationEnd () override
 
void SignalConnectionMoveBegin (const ConnectionId &connectionId) override
 
RootGraphicsItemEnabledState UpdateEnabledState () override
 
bool HasHideableSlots () const override
 
bool IsHidingUnusedSlots () const override
 
void ShowAllSlots () override
 
void HideUnusedSlots () override
 
void SignalNodeAboutToBeDeleted () override
 
void OnMoveFinalized (bool isValidConnection) override
 
bool IsGrouped () const override
 
const AZ::EntityId & GetGroupId () const override
 
void RegisterToGroup (const AZ::EntityId &groupId) override
 
void UnregisterFromGroup (const AZ::EntityId &groupId) override
 
void RemoveFromGroup () override
 
- Public Member Functions inherited from GraphCanvas::GraphCanvasPropertyComponent
 AZ_COMPONENT (GraphCanvasPropertyComponent, "{12408A55-4742-45B2-8694-EE1C80430FB4}")
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
AZ::Component * GetPropertyComponent () override
 
- Public Member Functions inherited from GraphCanvas::GraphCanvasPropertyBusHandler
void OnActivate (const AZ::EntityId &entityId)
 
void OnDeactivate ()
 
void AddBusId (const AZ::EntityId &busId) final
 
void RemoveBusId (const AZ::EntityId &busId) final
 
- Public Member Functions inherited from GraphCanvas::ComponentSaveDataInterface< NodeSaveData >
 AZ_RTTI ((ComponentSaveDataInterface, "{0370B379-0C9F-492E-8270-66C9AF0645AF}", NodeSaveData))
 
void InitSaveDataInterface (const AZ::EntityId &entityId)
 
void RegisterIds (const AZ::EntityId &entityId, const GraphId &graphId)
 
void WriteSaveData (EntitySaveDataContainer &saveDataContainer) const
 
void ReadSaveData (const EntitySaveDataContainer &saveDataContainer)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *)
 
static AZ::Entity * CreateCoreNodeEntity (const NodeConfiguration &config=NodeConfiguration())
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
- Static Public Member Functions inherited from GraphCanvas::GraphCanvasPropertyComponent
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void HideUnusedSlotsImpl ()
 
void UpdateDisabledStateVisuals ()
 
- Protected Member Functions inherited from GraphCanvas::ComponentSaveDataInterface< NodeSaveData >
virtual void OnSaveDataRead ()
 

Protected Attributes

AZ::EntityId m_sceneId
 The ID of the scene this node belongs to.
 
AZStd::vector< AZ::Entity * > m_slots
 This node's slots.
 
NodeConfiguration m_configuration
 Serialized configuration settings.
 
AZ::EntityId m_wrappingNode
 
AZ::EntityId m_owningGroupId
 
AZStd::any m_userData
 Stores custom user data for this node.
 
bool m_updateSlotState = false
 

Friends

class NodeSerializer
 

Additional Inherited Members

- Public Attributes inherited from GraphCanvas::ComponentSaveDataInterface< NodeSaveData >
NodeSaveData m_saveData
 
The documentation for this class was generated from the following file: