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::NodeFrameGraphicsWidget Class Reference

#include <NodeFrameGraphicsWidget.h>

Inherits GraphCanvas::RootGraphicsItem< QGraphicsWidget >, SceneMemberUIRequestBus::Handler, GeometryNotificationBus::Handler, VisualRequestBus::Handler, NodeNotificationBus::Handler, NodeUIRequestBus::Handler, and StyleNotificationBus::Handler.

Inherited by GraphCanvas::GeneralNodeFrameGraphicsWidget, and GraphCanvas::NodeGroupFrameGraphicsWidget.

Public Member Functions

 AZ_TYPE_INFO (NodeFrameGraphicsWidget, "{33B9DFFB-9E40-4D55-82A7-85468F7E7790}")
 
 AZ_CLASS_ALLOCATOR (NodeFrameGraphicsWidget, AZ::SystemAllocator)
 
 NodeFrameGraphicsWidget (const AZ::EntityId &nodeVisual)
 
void Activate ()
 
void Deactivate ()
 
QRectF GetBoundingRect () const override
 
QGraphicsItem * GetRootGraphicsItem () override
 
QGraphicsLayoutItem * GetRootGraphicsLayoutItem () override
 
void SetSelected (bool selected) override
 
bool IsSelected () const override
 
void SetZValue (qreal zValue) override
 
qreal GetZValue () const override
 
void OnPositionChanged (const AZ::EntityId &entityId, const AZ::Vector2 &position) override
 
void OnStyleChanged () override
 
QSizeF sizeHint (Qt::SizeHint which, const QSizeF &constraint=QSizeF()) const override
 
void resizeEvent (QGraphicsSceneResizeEvent *) override
 
void OnDeleteItem () override
 
QGraphicsItem * AsGraphicsItem () override
 
bool Contains (const AZ::Vector2 &position) const override
 
void SetVisible (bool visible) override
 
bool IsVisible () const override
 
void OnNodeActivated () override
 
void OnAddedToScene (const AZ::EntityId &graphId) override
 
void OnNodeWrapped (const AZ::EntityId &wrappingNode) override
 
void AdjustSize () override
 
void SetSteppedSizingEnabled (bool sizing) override
 
void SetSnapToGrid (bool snapToGrid) override
 
void SetResizeToGrid (bool resizeToGrid) override
 
void SetGrid (AZ::EntityId gridId) override
 
qreal GetCornerRadius () const override
 
qreal GetBorderWidth () const override
 
- Public Member Functions inherited from GraphCanvas::RootGraphicsItem< QGraphicsWidget >
 RootGraphicsItem (AZ::EntityId itemId)
 
AZ::EntityId GetEntityId () const
 
bool IsSnappedToGrid () const
 
bool IsResizedToGrid () const
 
int GetGridXStep () const
 
int GetGridYStep () const
 
void SetSnapToGridEnabled (bool enabled)
 
void SetResizeToGridEnabled (bool enabled)
 
void SetGridSize (const AZ::Vector2 &gridSize)
 
void SetAnchorPoint (const AZ::Vector2 &anchorPoint)
 
void OnStateChanged ([[maybe_unused]] const RootGraphicsItemDisplayState &displayState) override
 
void OnTick (float delta, AZ::ScriptTimePoint) override
 
void AnimatePositionTo (const QPointF &scenePoint, const AZStd::chrono::milliseconds &duration) override
 
void CancelAnimation () override
 
void OffsetBy (const AZ::Vector2 &delta) override
 
void SignalGroupAnimationStart (AZ::EntityId groupId) override
 
void SignalGroupAnimationEnd (AZ::EntityId groupId) override
 
StateController< RootGraphicsItemDisplayState > * GetDisplayStateStateController () override
 
RootGraphicsItemDisplayState GetDisplayState () const override
 
void SetEnabledState (RootGraphicsItemEnabledState state) override
 
RootGraphicsItemEnabledState GetEnabledState () const override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *)=delete
 

Protected Member Functions

void SetDisplayState (NodeFrameDisplayState displayState)
 
void UpdateDisplayState (NodeFrameDisplayState displayState, bool enabled)
 
int GrowToNextStep (int value, int step, StepAxis stepAxis=StepAxis::Unknown) const
 
int RoundToClosestStep (int value, int step) const
 
int ShrinkToPreviousStep (int value, int step) const
 
virtual void OnActivated ()
 
virtual void OnDeactivated ()
 
virtual void OnRefreshStyle ()
 
 NodeFrameGraphicsWidget (const NodeFrameGraphicsWidget &)=delete
 
- Protected Member Functions inherited from GraphCanvas::RootGraphicsItem< QGraphicsWidget >
 RootGraphicsItem (const RootGraphicsItem &)=delete
 
void SetDisplayState (RootGraphicsItemDisplayState displayState)
 
void OnAltModifier (bool enabled) override
 
void hoverEnterEvent (QGraphicsSceneHoverEvent *hoverEvent) override
 
void hoverLeaveEvent (QGraphicsSceneHoverEvent *hoverEvent) override
 
void mousePressEvent (QGraphicsSceneMouseEvent *event) override
 
void mouseReleaseEvent (QGraphicsSceneMouseEvent *event) override
 
void mouseDoubleClickEvent (QGraphicsSceneMouseEvent *mouseEvent) override
 
QVariant itemChange (QGraphicsItem::GraphicsItemChange change, const QVariant &value) override
 
int type () const override
 
virtual void OnEnabledStateChanged (RootGraphicsItemEnabledState enabledState)
 
void SetAllowQuickDeletion (bool enabled)
 

Protected Attributes

Styling::StyleHelper m_style
 
NodeFrameDisplayState m_displayState
 
bool m_enabledSteppedSizing = true
 
EditorId m_editorId
 
AZ::EntityId m_wrapperNode
 
bool m_isWrapped = false
 

Additional Inherited Members

- Public Types inherited from GraphCanvas::RootGraphicsItem< QGraphicsWidget >
enum  
 

Detailed Description

Base class to handle a bunch of the weird quirky stuff that the NodeFrames need to manage. Will not paint anything.


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