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.
GraphCanvas::GraphUtils Class Reference

Public Types

enum class  VerticalAlignment { Top , Middle , Bottom , None }
 
enum class  HorizontalAlignment { Left , Center , Right , None }
 
enum class  CalculationType { Floor , Round , Ceiling }
 

Static Public Member Functions

static bool IsConnectableNode (const NodeId &entityId)
 
static bool IsNodeOrWrapperSelected (const NodeId &nodeId)
 
static bool IsSpliceableConnection (const ConnectionId &connectionId)
 
static bool IsConnection (const AZ::EntityId &graphMemberId)
 
static bool IsNode (const AZ::EntityId &graphMemberId)
 
static bool IsNodeWrapped (const NodeId &nodeId)
 
static bool IsWrapperNode (const AZ::EntityId &graphMemberId)
 
static bool IsSlot (const AZ::EntityId &graphMemberId)
 
static bool IsSlotVisible (const SlotId &slotId)
 
static bool IsSlotHideable (const SlotId &slotId)
 
static bool IsSlotConnectionType (const SlotId &slotId, ConnectionType connectionType)
 
static bool IsSlotType (const SlotId &slotId, SlotType slotType)
 
static bool IsSlot (const SlotId &slotId, SlotType slotType, ConnectionType connectionType)
 
static bool IsGroupableElement (const AZ::EntityId &graphMemberId)
 
static bool IsNodeGroup (const AZ::EntityId &graphMemberId)
 
static bool IsCollapsedNodeGroup (const AZ::EntityId &graphMemberId)
 
static bool IsComment (const AZ::EntityId &graphMemberId)
 
static bool IsBookmarkAnchor (const AZ::EntityId &graphMemberId)
 
static AZ::EntityId CreateGroupForElements (const AZ::EntityId &graphId, const AZStd::vector< AZ::EntityId > &memberIds, AZ::Vector2 startingPoint=AZ::Vector2(0, 0))
 
static void ResizeGroupToElements (const AZ::EntityId &groupId, const AZStd::vector< AZ::EntityId > &memberIds)
 
static AZ::Vector2 FindMinorStep (const AZ::EntityId &graphId)
 
static AZ::Vector2 FindMajorStep (const AZ::EntityId &graphId)
 
static NodeId FindOutermostNode (const AZ::EntityId &graphMemberId)
 
static void DeleteOutermostNode (const GraphId &graphId, const AZ::EntityId &graphMemberId)
 
static AZStd::unordered_set< EndpointRemapEndpointForModel (const Endpoint &endpoint)
 
static void ParseMembersForSerialization (GraphSerialization &graphData, const AZStd::unordered_set< AZ::EntityId > &memberIds)
 
static SubGraphParsingResult ParseSceneMembersIntoSubGraphs (const AZStd::vector< NodeId > &sourceSceneMembers, const SubGraphParsingConfig &subGraphParsingConfig)
 
static bool IsValidModelConnection (const GraphId &graphId, const Endpoint &sourceEndpoint, const Endpoint &targetEndpoint)
 
static ConnectionValidationTooltip GetModelConnnectionValidityToolTip (const GraphId &graphId, const Endpoint &sourceEndpoint, const Endpoint &targetEndpoint)
 
static bool CreateModelConnection (const GraphId &graphId, const ConnectionId &connectionId, const Endpoint &sourceEndpoint, const Endpoint &targetEndpoint)
 
static AZStd::unordered_set< ConnectionId > FindConnectionsForNodes (const AZStd::unordered_set< NodeId > &nodeIds, bool internalConnectionsOnly)
 
static bool SpliceNodeOntoConnection (const NodeId &node, const ConnectionId &connectionId, ConnectionSpliceConfig &spliceConfiguration)
 
static bool SpliceSubGraphOntoConnection (const GraphSubGraph &subGraph, const ConnectionId &connectionId)
 
static void DetachNodeAndStitchConnections (const NodeDetachConfig &nodeDetatchConfig)
 
static void DetachSubGraphAndStitchConnections (const GraphSubGraph &subGraph)
 
static bool CreateConnectionsBetween (const AZStd::vector< Endpoint > &endpoints, const AZ::EntityId &targetNode, CreateConnectionsBetweenConfig &creationConfig)
 
static AZStd::unordered_set< GraphCanvas::ConnectionId > CreateOpportunisticConnectionsBetween (const Endpoint &initializingEndpoint, const Endpoint &opportunisticEndpoint)
 
static OpportunisticSpliceResult CreateOpportunisticsConnectionsForSplice (const GraphId &graphId, const AZStd::vector< ConnectionEndpoints > &connectedEndpoints, const NodeId &splicedNode)
 
static QRectF AlignNodes (const AZStd::vector< AZ::EntityId > &memberIds, const AlignConfig &alignConfig, QRectF overallBoundingRect=QRectF())
 
static void OrganizeNodes (const AZStd::vector< AZ::EntityId > &memberIds, const AlignConfig &alignConfig)
 
static void FocusOnElements (const AZStd::vector< AZ::EntityId > &memberIds, const FocusConfig &focusConfig)
 
static void FindConnectedNodes (const AZStd::vector< AZ::EntityId > &seedNodeIds, AZStd::unordered_set< AZ::EntityId > &connectedNodes, const AZStd::unordered_set< ConnectionType > &connectionTypes)
 
static AZStd::unordered_set< NodeId > FindTerminalForNodeChain (const AZStd::vector< AZ::EntityId > &nodeIds, ConnectionType searchDirection)
 
static void SanityCheckEnabledState (AZ::EntityId nodeId)
 
static void SetNodesEnabledState (const AZStd::unordered_set< NodeId > &nodeIds, RootGraphicsItemEnabledState enabledState)
 
static bool CanHideEndpoint (const Endpoint &endpoint, const HideSlotConfig &slotConfig)
 
static void AlignSlotForConnection (const GraphCanvas::Endpoint &moveableEndpoint, const GraphCanvas::Endpoint &fixedEndpoint)
 
static QPointF CalculateAnchorPoint (const QPointF &position, const AZ::Vector2 &anchorPoint, const QRectF &boundingBox)
 
static QPointF CalculateGridSnapPosition (const QPointF &position, const AZ::Vector2 &anchorPoint, const QRectF &boundingBox, const AZ::Vector2 &gridStep, CalculationType calculationType=CalculationType::Round)
 
static void AddElementToGroup (const AZ::EntityId &memberId, const AZ::EntityId &groupTarget)
 
static AZ::EntityId FindVisibleElement (const AZ::EntityId &memberId)
 
static bool UngroupGroup (const GraphId &graphId, AZ::EntityId groupElement)
 

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