1. Epic GamesDeveloper
  3. SGraphEditor

SGraphEditor

Interface and wrapper for GraphEditor widgets.

API > API/Editor > API/Editor/UnrealEd

Inheritance Hierarchy

References

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

Syntax

class SGraphEditor : public SCompoundWidget

Remarks

Interface and wrapper for GraphEditor widgets. Gracefully handles the GraphEditorModule being unloaded.

Variables

  Type Name Description
Protected variable TWeakPtr< FAssetEditorToolkit > AssetEditorToolkit  
Protected variable UEdGraph * EdGraphObj The Graph we are currently editing

Functions

  Type Name Description
Public function Virtual void

AddNotification ( FNotificationInfo& Info,
bool bSuccess
)

 Show notification on graph
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void Capture keyboard
Public function Virtual void Clear the selection
Public function void

Construct ( const FArguments& InArgs
)

 Loads the GraphEditorModule and constructs a GraphEditor as a child of this widget.
Public function Static TSharedPtr< SGraphEditor > Returns the first graph editor that is viewing the specified graph.
Public function void

FocusCommentNodes ( TArray< UEdGraphNode* >& CommentNodes,
TArray< UEdGraphNode* >& RelatedNodes
)

  
Public function Virtual Const bool

GetBoundsForNode ( const UEdGraphNode* InNode,
FSlateRect& Rect,
float Padding
)

 Get Bounds for the specified node, returns false on failure
Public function Virtual bool

GetBoundsForSelectedNodes ( FSlateRect& Rect,
float Padding
)

 Get Bounds for selected nodes, false if nothing selected
Public function Const UEdGraph *  
Public function Virtual UEdGraphNode *  
Public function Virtual Const SGraphPanel * Returns the graph panel used for this graph editor
Public function Virtual UEdGraphPin *  
Public function Virtual Const int32  
Public function Virtual Const FVector2D  
Public function Virtual Const const FGraphPanelSelectionSet &  
Public function Virtual Const UEdGraphNode * Returns the currently selected node if there is a single node selected (if there are multiple nodes selected or none selected, it will return nullptr)
Public function Virtual Const TSharedPtr< SWidget > Get the title bar if there is one
Public function Virtual void

GetViewBookmark ( FGuid& OutBookmarkId
)

 Gets the current graph view bookmark
Public function Virtual void

GetViewLocation ( FVector2D& OutLocation,
float& OutZoomAmount
)

 Gets the view location of the graph
Public function Virtual bool

IsNodeTitleVisible ( const UEdGraphNode* Node,
bool bRequestRename
)

 Check if node title is visible with optional flag to ensure it is
Public function Virtual void

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

 Bring the specified node into view
Public function Virtual void

JumpToPin ( const UEdGraphPin* JumpToMe
)

 Bring the specified pin into view
Public function Virtual void Lock two graph editors together
Public function Virtual void Invoked when the Graph being edited changes in some way.
Public function void

NotifyPostPropertyChange ( const FPropertyChangedEvent& PropertyChangeEvent,
const FString& PropertyName
)

  
Public function void

NotifyPrePropertyChange ( const FString& PropertyName
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Protected function Virtual void

OnGraphChanged ( const FEdGraphEditAction& InAction
)

 Invoked when the underlying Graph is being changed.
Public function void Invoked to let this widget know that the GraphEditor module has been reloaded.
Public function void Invoked to let this widget know that the GraphEditor module is being unloaded.
Public function Virtual void  
Public function Virtual void  
Public function Virtual TSharedRef< FActiveTimerHandle >

RegisterActiveTimer ( float TickPeriod,
FWidgetActiveTimerDelegate TickFunction
)

 Register an active timer on the graph editor.
Public function void Common methods for MaterialEditor and BlueprintEditor's focusing related nodes feature
Public function Virtual void Select all nodes
Public function Virtual void

SetNodeFactory ( const TSharedRef< class FGraphNodeFactory >& NewNodeFactory
)

 Sets the current node, pin and connection factory.
Public function Virtual void

SetNodeSelection ( UEdGraphNode* Node,
bool bSelect
)

 Set the selection status of a node
Public function Virtual void

SetPinVisibility ( EPinVisibility InVisibility
)

 Set the pin visibility mode
Public function Virtual void

SetViewLocation ( const FVector2D& Location,
float ZoomAmount,
const FGuid& BookmarkId
)

 Set new viewer location and optionally set the current bookmark
Public function Virtual void  
Public function Virtual Const void

StraightenConnections ( UEdGraphPin* SourcePin,
UEdGraphPin* PinToAlign
)

  
Public function Virtual void Unlock two graph editors from each other
Public function Virtual void

ZoomToFit ( bool bOnlySelection
)

 Zooms out to fit either all nodes or only the selected ones.

Classes

  Type Name Description
Public struct FArguments    
Public struct FGraphEditorEvents Info about events occurring in/on the graph  

Enums

  Type Name Description
Public enum EPinVisibility Pin visibility modes  

Typedefs

Name Description
FActionMenuClosed  
FOnCreateActionMenu  
FOnCreateNodeOrPinMenu  
FOnDisallowedPinConnection  
FOnDoubleClicked  
FOnDropActor  
FOnDropStreamingLevel  
FOnFocused  
FOnMouseButtonDown  
FOnNodeSingleClicked  
FOnNodeSpawnedByKeymap  
FOnSelectionChanged  
FOnSpawnNodeByShortcut  

Constants

Name Description
AllInstances Active GraphEditor wrappers; we will notify these about the module being unloaded so they can handle it gracefully.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page