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.
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
GraphCanvas::SceneComponent Class Reference

Inherits GraphCanvas::GraphCanvasPropertyComponent, AZ::EntityBus::Handler, SceneRequestBus::Handler, GeometryNotificationBus::MultiHandler, VisualNotificationBus::MultiHandler, GraphCanvas::ViewNotificationBus::Handler, SceneMimeDelegateRequestBus::Handler, EntitySaveDataRequestBus::Handler, SceneBookmarkActionBus::Handler, StyleManagerNotificationBus::Handler, AZ::SystemTickBus::Handler, and AssetEditorSettingsNotificationBus::Handler.

Classes

struct  GraphCanvasConstructSaveData
 
class  SceneComponentSaveData
 

Public Member Functions

 AZ_COMPONENT (SceneComponent, "{3F71486C-3D51-431F-B904-DA070C7A0238}", GraphCanvasPropertyComponent)
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
void OnSystemTick () override
 
void OnEntityExists (const AZ::EntityId &entityId) override
 
void WriteSaveData (EntitySaveDataContainer &saveDataContainer) const override
 
void ReadSaveData (const EntitySaveDataContainer &saveDataContainer) override
 
SceneRequests * GetSceneRequests ()
 
const SceneRequests * GetSceneRequestsConst () const
 
GraphData * GetGraphData () override
 
const GraphData * GetGraphDataConst () const override
 
AZStd::any * GetUserData () override
 
const AZStd::any * GetUserDataConst () const override
 
AZ::Entity * GetSceneEntity () const override
 
void SetEditorId (const EditorId &editorId) override
 
EditorId GetEditorId () const override
 
AZ::EntityId GetGrid () const override
 
GraphicsEffectId CreatePulse (const AnimatedPulseConfiguration &pulseConfiguration) override
 
GraphicsEffectId CreatePulseAroundArea (const QRectF &area, int gridSteps, AnimatedPulseConfiguration &pulseConfiguration) override
 
GraphicsEffectId CreatePulseAroundSceneMember (const AZ::EntityId &memberId, int gridSteps, AnimatedPulseConfiguration configuration) override
 
GraphicsEffectId CreateCircularPulse (const AZ::Vector2 &centerPoint, float initialRadius, float finalRadius, AnimatedPulseConfiguration configuration) override
 
GraphicsEffectId CreateOccluder (const OccluderConfiguration &occluderConfiguration) override
 
GraphicsEffectId CreateGlow (const FixedGlowOutlineConfiguration &configuration) override
 
GraphicsEffectId CreateGlowOnSceneMember (const SceneMemberGlowOutlineConfiguration &configuration) override
 
GraphicsEffectId CreateParticle (const ParticleConfiguration &configuration) override
 
AZStd::vector< GraphicsEffectId > ExplodeSceneMember (const AZ::EntityId &memberId, float fillPercent) override
 
void CancelGraphicsEffect (const GraphicsEffectId &effectId) override
 
bool AddNode (const AZ::EntityId &nodeId, const AZ::Vector2 &position, bool isPaste) override
 
void AddNodes (const AZStd::vector< AZ::EntityId > &nodeIds) override
 
bool RemoveNode (const AZ::EntityId &nodeId) override
 
AZStd::vector< AZ::EntityId > GetNodes () const override
 
AZStd::vector< AZ::EntityId > GetSelectedNodes () const override
 
void DeleteNodeAndStitchConnections (const AZ::EntityId &node) override
 
AZ::EntityId CreateConnectionBetween (const Endpoint &sourceEndpoint, const Endpoint &targetEndpoint) override
 
bool AddConnection (const AZ::EntityId &connectionId) override
 
void AddConnections (const AZStd::vector< AZ::EntityId > &connectionIds) override
 
bool RemoveConnection (const AZ::EntityId &connectionId) override
 
AZStd::vector< AZ::EntityId > GetConnections () const override
 
AZStd::vector< AZ::EntityId > GetSelectedConnections () const override
 
AZStd::vector< AZ::EntityId > GetConnectionsForEndpoint (const Endpoint &firstEndpoint) const override
 
bool IsEndpointConnected (const Endpoint &endpoint) const override
 
AZStd::vector< Endpoint > GetConnectedEndpoints (const Endpoint &firstEndpoint) const override
 
bool CreateConnection (const Endpoint &sourceEndpoint, const Endpoint &targetEndpoint) override
 
bool DisplayConnection (const Endpoint &sourceEndpoint, const Endpoint &targetEndpoint) override
 
bool Disconnect (const Endpoint &, const Endpoint &) override
 
bool DisconnectById (const AZ::EntityId &connectionId) override
 
bool FindConnection (AZ::Entity *&connectionEntity, const Endpoint &firstEndpoint, const Endpoint &otherEndpoint) const override
 
bool AddBookmarkAnchor (const AZ::EntityId &bookmarkAnchorId, const AZ::Vector2 &position) override
 
bool RemoveBookmarkAnchor (const AZ::EntityId &bookmarkAnchorId) override
 
bool Add (const AZ::EntityId &entity, bool isPaste=false) override
 
bool Remove (const AZ::EntityId &entity) override
 
bool Show (const AZ::EntityId &graphMemeber) override
 
bool Hide (const AZ::EntityId &graphMemeber) override
 
bool IsHidden (const AZ::EntityId &graphMember) const override
 
bool Enable (const NodeId &nodeId) override
 
void EnableVisualState (const NodeId &nodeId) override
 
void EnableSelection () override
 
bool Disable (const NodeId &nodeId) override
 
void DisableVisualState (const NodeId &nodeId) override
 
void DisableSelection () override
 
void ProcessEnableDisableQueue () override
 
void ClearSelection () override
 
void SetSelectedArea (const AZ::Vector2 &topLeft, const AZ::Vector2 &topRight) override
 
void SelectAll () override
 
void SelectAllRelative (ConnectionType connectionType) override
 
void SelectConnectedNodes () override
 
bool HasSelectedItems () const override
 
bool HasMultipleSelection () const override
 
bool HasCopiableSelection () const override
 
bool HasEntitiesAt (const AZ::Vector2 &scenePoint) const override
 
AZStd::vector< AZ::EntityId > GetSelectedItems () const override
 
QGraphicsScene * AsQGraphicsScene () override
 
void CopySelection () const override
 
void Copy (const AZStd::vector< AZ::EntityId > &itemIds) const override
 
void CutSelection () override
 
void Cut (const AZStd::vector< AZ::EntityId > &itemIds) override
 
void Paste () override
 
void PasteAt (const QPointF &scenePos) override
 
void SerializeEntities (const AZStd::unordered_set< AZ::EntityId > &itemIds, GraphSerialization &serializationTarget) const override
 
void DeserializeEntities (const QPointF &scenePos, const GraphSerialization &serializationTarget) override
 
void DuplicateSelection () override
 
void DuplicateSelectionAt (const QPointF &scenePos) override
 
void Duplicate (const AZStd::vector< AZ::EntityId > &itemIds) override
 
void DuplicateAt (const AZStd::vector< AZ::EntityId > &itemIds, const QPointF &scenePos) override
 
void DeleteSelection () override
 
void Delete (const AZStd::unordered_set< AZ::EntityId > &itemIds) override
 
void DeleteGraphData (const GraphData &graphData) override
 
void ClearScene () override
 
void SuppressNextContextMenu () override
 
const AZStd::string & GetCopyMimeType () const override
 
void SetMimeType (const char *mimeType) override
 
AZStd::vector< AZ::EntityId > GetEntitiesAt (const AZ::Vector2 &position) const override
 
AZStd::vector< AZ::EntityId > GetEntitiesInRect (const QRectF &rect, Qt::ItemSelectionMode mode) const override
 
AZStd::vector< Endpoint > GetEndpointsInRect (const QRectF &rect) const override
 
void RegisterView (const AZ::EntityId &viewId) override
 
void RemoveView (const AZ::EntityId &viewId) override
 
ViewId GetViewId () const override
 
void DispatchSceneDropEvent (const AZ::Vector2 &scenePos, const QMimeData *mimeData) override
 
bool AddGraphData (const GraphData &graphData) override
 
void RemoveGraphData (const GraphData &graphData) override
 
void SetDragSelectionType (DragSelectionType dragSelectionType) override
 
void SignalDragSelectStart () override
 
void SignalDragSelectEnd () override
 
bool IsDragSelecting () const override
 
void SignalConnectionDragBegin () override
 
void SignalConnectionDragEnd () override
 
bool IsDraggingConnection () const override
 
void SignalDesplice () override
 
QRectF GetSelectedSceneBoundingArea () const override
 
QRectF GetSceneBoundingArea () const override
 
void SignalLoadStart () override
 
void SignalLoadEnd () override
 
bool IsLoading () const override
 
bool IsPasting () const override
 
void RemoveUnusedNodes () override
 
void RemoveUnusedElements () override
 
void HandleProposalDaisyChainWithGroup (const NodeId &startNode, SlotType slotType, ConnectionType connectionType, const QPoint &screenPoint, const QPointF &focusPoint, AZ::EntityId targetId) override
 
void StartNudging (const AZStd::unordered_set< AZ::EntityId > &fixedNodes) override
 
void FinalizeNudging () override
 
void CancelNudging () override
 
AZ::EntityId FindTopmostGroupAtPoint (QPointF scenePoint) override
 
QPointF SignalGenericAddPositionUseBegin () override
 
void SignalGenericAddPositionUseEnd () override
 
bool AllowContextMenu () const
 
bool OnMousePress (const AZ::EntityId &sourceId, const QGraphicsSceneMouseEvent *mouseEvent) override
 
bool OnMouseRelease (const AZ::EntityId &sourceId, const QGraphicsSceneMouseEvent *mouseEvent) override
 
void OnPositionChanged (const AZ::EntityId &itemId, const AZ::Vector2 &position) override
 
void OnEscape () override
 
void OnViewParamsChanged (const ViewParams &viewParams) override
 
void AddDelegate (const AZ::EntityId &delegateId) override
 
void RemoveDelegate (const AZ::EntityId &delegateId) override
 
AZ::u32 GetNewBookmarkCounter () override
 
void OnStylesLoaded () override
 
void OnSettingsChanged () 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
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incombatible)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &)
 
- Static Public Member Functions inherited from GraphCanvas::GraphCanvasPropertyComponent
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void ConfigureAndAddGraphicsEffect (GraphicsEffectInterface *graphicsEffect)
 
void OnSceneDragEnter (const QMimeData *mimeData)
 
void OnSceneDragMoveEvent (const QPointF &scenePoint, const QMimeData *mimeData)
 
void OnSceneDropEvent (const QPointF &scenePoint, const QMimeData *mimeData)
 
void OnSceneDragExit (const QMimeData *mimeData)
 
bool HasActiveMimeDelegates () const
 

Friends

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