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::NodeRequests Class Referenceabstract

#include <NodeBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::EntityId
 

Public Member Functions

virtual void SetTooltip (const AZStd::string &)=0
 Set the tooltip for the node, which will display when the mouse is over the node but not a child item.
 
virtual const AZStd::string GetTooltip () const =0
 Get the tooltip that is currently set for the node.
 
virtual void SetShowInOutliner (bool showInOutliner)=0
 Sets whether or not the given node will display in the outliner.
 
virtual bool ShowInOutliner () const =0
 Get whether to show this node in the outliner or not.
 
virtual void AddSlot (const AZ::EntityId &)=0
 
virtual void RemoveSlot (const AZ::EntityId &)=0
 Remove a slot from the node.
 
virtual AZStd::vector< AZ::EntityId > GetSlotIds () const =0
 Obtain a collection of the entity IDs of the slots owned by a node.
 
virtual AZStd::vector< SlotId > GetVisibleSlotIds () const =0
 
virtual AZStd::vector< SlotId > FindVisibleSlotIdsByType (const ConnectionType &connectionType, const SlotType &slotType) const =0
 
virtual bool HasConnections () const =0
 
virtual AZStd::any * GetUserData ()=0
 Get user data from this node.
 
virtual bool IsWrapped () const =0
 Returns whether or not the Node is currently wrapped.
 
virtual void SetWrappingNode (const AZ::EntityId &wrappingNode)=0
 
virtual AZ::EntityId GetWrappingNode () const =0
 
virtual void SignalBatchedConnectionManipulationBegin ()=0
 
virtual void SignalBatchedConnectionManipulationEnd ()=0
 
virtual void SignalConnectionMoveBegin (const ConnectionId &connectionId)=0
 
virtual RootGraphicsItemEnabledState UpdateEnabledState ()=0
 
virtual bool HasHideableSlots () const =0
 
virtual bool IsHidingUnusedSlots () const =0
 
virtual void ShowAllSlots ()=0
 
virtual void HideUnusedSlots ()=0
 
virtual void SignalNodeAboutToBeDeleted ()=0
 

Static Public Attributes

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

Detailed Description

NodeRequests Requests that get or set the properties of a node.

Member Function Documentation

◆ AddSlot()

virtual void GraphCanvas::NodeRequests::AddSlot ( const AZ::EntityId &  )
pure virtual

Add a slot entity to the node. The node will manage the slot entity and its entity life-cycle will be linked to that of the node. If the slot must outlive the node, then it will need to be removed before the node is destroyed.

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