1. Epic GamesDeveloper
  3. SGraphPanel

SGraphPanel

API > API/Editor > API/Editor/GraphEditor

Inheritance Hierarchy

References

   
Module GraphEditor
Header /Engine/Source/Editor/GraphEditor/Public/SGraphPanel.h
Include #include "SGraphPanel.h"

Syntax

class SGraphPanel :  
    public SNodePanel,  
    public FGCObject

Variables

  Type Name Description
Protected variable bool bIsDrawStateCached  
Protected variable FCurveSequence BounceCurve Bouncing curve
Protected variable bool bPreservePinPreviewConnection Should we ignore the OnStopMakingConnection unless forced?
Protected variable bool bShowPIENotification Whether to draw the overlay indicating we're in PIE
Protected variable FVector2D CachedAllottedGeometryScaledSize Geometry cache
Protected variable TSet< FEdGraphPinReference > CurrentHoveredPins List of pins currently being hovered over
Protected variable TSharedPtr< TArray< FDiffSingleResult > > DiffResults If this graph is displaying the results of a diff, this will provide info on how to display the nodes
Protected variable TAttribute< int32 > FocusedDiffResult  
Protected variable TObjectPtr< UEdGraph > GraphObj  
Protected variable FPointerEvent LastPointerEvent  
Protected variable FGeometry LastPointerGeometry The mouse state from the last mouse move event, used to synthesize pin actions when hovering over a spline on the panel
Public variable TWeakPtr< SGraphPin > MarkedPin Pin marked via shift-clicking
Protected variable SGraphEditor::FOnMouseButtonDown OnClicked Called when the graph itself is clicked
Protected variable SGraphEditor::FOnDisallowedPinConnection OnDisallowedPinConnection Called when the user generates a warning tooltip because a connection was invalid
Protected variable SGraphEditor::FOnDoubleClicked OnDoubleClicked Called when the graph itself is double clicked
Protected variable SGraphEditor::FOnDropActor OnDropActor Invoked when an actor is dropped onto the panel
Protected variable SGraphEditor::FOnDropStreamingLevel OnDropStreamingLevel Invoked when a streaming level is dropped onto the panel
Protected variable FOnGetContextMenuFor OnGetContextMenuFor Invoked when we need to summon a context menu
Protected variable FSingleNodeEvent OnNodeDoubleClicked What to do when a node is double-clicked
Protected variable FOnNodeTextCommitted OnTextCommitted Invoked when text is committed on panel
Protected variable FOnUpdateGraphPanel OnUpdateGraphPanel Invoked when the panel is updated
Protected variable FOnNodeVerifyTextCommit OnVerifyTextCommit Invoked when text is being committed on panel to verify it
Protected variable SGraphEditor::EPinVisibility PinVisibility Pin visibility mode
Protected variable FVector2D PreviewConnectorEndpoint  
Protected variable TArray< FGraphPinHandle > PreviewConnectorFromPins Sometimes the panel draws a preview connector; e.g. when the user is connecting pins
Protected variable FVector2D PreviousFrameSavedMousePosForSplineOverlap The overlap results from the previous OnPaint call
Protected variable FGraphSplineOverlapResult PreviousFrameSplineOverlap  
Protected variable FVector2D SavedMousePosForOnPaintEventLocalSpace Last mouse position seen, used for paint-centric highlighting
Protected variable TAttribute< bool > ShowGraphStateOverlay Whether to draw decorations for graph state (PIE / ReadOnly etc.)
Protected variable double TimeWhenMouseEnteredPin Time since the last mouse enter/exit on a pin
Protected variable double TimeWhenMouseLeftPin  

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Protected function void

AddNode ( UEdGraphNode* Node,
AddNodeBehavior Behavior
)

 Helper method to add a new node to the panel
Public function void

AddPinToHoverSet ( UEdGraphPin* HoveredPin
)

  
Public function Const void

ArrangeChildrenForContextMenuSummon ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
)

  
Public function void

AttachGraphEvents ( TSharedPtr< SGraphNode > CreatedSubNode
)

 Helper to attach graph events to sub node, which won't be placed directly on the graph
Public function void

Construct ( const FArguments& InArgs
)

 Construct a widget
Public function void  
Public function void

GetAllPins ( TSet< TSharedRef< SWidget > >& AllPins
)

  
Public function Const bool

GetBoundsForNode ( const UObject* InNode,
FVector2D& MinCorner,
FVector2D& MaxCorner,
float Padding
)

 Attempt to retrieve the bounds for the specified node
Protected function const TSharedRef< SGraphNode >

GetChild ( int32 ChildIndex
)

  
Public function Const UEdGraph *  
Public function Const TSharedPtr< SGraphNode > Get a graph node widget from the specified GUID, if it applies to any nodes in this graph
Public function Const SGraphEditor::EPinVisibility  
Public function Const const FGraphSplineOverlapResult &  
Public function Const TArray< UEdGraphNode * > Get a list of selected editor graph nodes from the selection manager.
Public function EActiveTimerReturnType

InvalidatePerTick ( double InCurrentTime,
float InDeltaTime
)

 When the graph panel needs to be dynamically refreshing for animations, this function is registered to tick and invalidate the UI.
Public function Const bool Returns if this graph is editable
Public function bool

IsNodeTitleVisible ( const UEdGraphNode* Node,
bool bRequestRename
)

 Use to determine if a comment title is currently visible
Public function bool

IsRectVisible ( const FVector2D& TopLeft,
const FVector2D& BottomRight
)

 Use to determine if a rectangle is currently visible
Public function Const bool True in case a connection is currently being relinked, false if not.
Public function void

JumpToNode ( const UEdGraphNode* JumpToMe,
bool bRequestRename,
bool bSelectNode
)

  
Public function void

JumpToPin ( const UEdGraphPin* JumptToMe
)

  
Public function bool

JumpToRect ( const FVector2D& BottomLeft,
const FVector2D& TopRight
)

 Focuses the view on rectangle, zooming if neccesary
Protected function void  
Public function void  
Public function void

OnBeginMakingConnection ( UEdGraphPin* InOriginatingPin
)

  
Public function void

OnBeginRelinkConnection ( const FGraphPinHandle& InSourcePinHandle,
const FGraphPinHandle& InTargetPinHandle
)

 Indicate that the connection from the given start to the given end pins is being relinked.
Public function void

OnEndRelinkConnection ( bool bForceStop
)

 The relink connection operation either got cancelled or has successfully been executed.
Public function void

OnStopMakingConnection ( bool bForceStop
)

  
Public function void  
Public function void Purges the existing visual representation (typically followed by an Update call in the next tick)
Public function void Refresh the visual state of a single node
Protected function void

RemoveNode ( const UEdGraphNode* Node
)

 Helper method to remove a node from the panel
Public function void  
Public function void

SetNodeFactory ( const TSharedRef< class FGraphNodeFactory >& NewNodeFactory
)

 Sets the current widget factory.
Public function void  
Public function void Straighten all connections between the selected nodes
Public function void

StraightenConnections ( UEdGraphPin* SourcePin,
UEdGraphPin* PinToAlign
)

 Straighten any connections attached to the specified pin, optionally limiting to the specified pin to align
Public function TSharedPtr< SWidget >

SummonContextMenu ( const FVector2D& WhereToSummon,
const FVector2D& WhereToAddNode,
UEdGraphNode* ForNode,
UEdGraphPin* ForPin,
const TArray< UEdGraphPin* >& DragFromPins
)

  
Public function void

SummonCreateNodeMenuFromUICommand ( uint32 NumNodesAdded
)

  
Public function void

Update ()

 Update this GraphPanel to match the data that it is observing.

Overridden from SNodePanel

  Type Name Description
Public function Virtual void

AddGraphNode ( const TSharedRef< SNode >& NodeToAdd
)

 Add a slot to the CanvasPanel dynamically
Public function Virtual bool

OnHandleLeftMouseRelease ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

  
Public function Virtual TSharedPtr< SWidget >

OnSummonContextMenu ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 INTERFACE TO IMPLEMENT.
Public function Virtual void Remove all nodes from the panel

Overridden from SWidget

  Type Name Description
Public function Virtual TSharedPtr< IToolTip >  
Public function Virtual Const void

OnArrangeChildren ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
)

 Panels arrange their children in a space described by the AllottedGeometry parameter.
Public function Virtual void

OnDragEnter ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
Public function Virtual void

OnDragLeave ( const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the drag leaves a widget.
Public function Virtual FReply

OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the the mouse is being dragged over a widget.
Public function Virtual FReply

OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual FReply

OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when a mouse button is double clicked. Override this in derived classes.
Public function Virtual FReply

OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Public function Virtual FReply

OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was release within it.
Public function Virtual FReply

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Classes

  Type Name Description
Public struct FArguments    

Enums

  Type Name Description
Protected enum AddNodeBehavior Flag to control AddNode, more readable than a bool:  

Typedefs

Name Description
FOnGetContextMenuFor  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page