1. Epic GamesDeveloper
  3. SGraphEditor

SGraphEditor

Interface and wrapper for GraphEditor widgets.

API > API/Editor > API/Editor/UnrealEd

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

   
Name SGraphEditor
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/GraphEditor.h
Include Path #include "GraphEditor.h"

Syntax

class SGraphEditor : public SCompoundWidget

Inheritance Hierarchy

Derived Classes

Structs

Name Remarks
FArguments  
FGraphEditorEvents Info about events occurring in/on the graph

Enums

Public

Name Remarks
EPinVisibility Pin visibility modes

Typedefs

Name Type Remarks Include Path
FActionMenuClosed TBaseDelegate_NoParams< void >   GraphEditor.h
FOnCreateActionMenu TBaseDelegate_FiveParams< FActionMenuContent, UEdGraph *, const FVector2D &, const TArray< UEdGraphPin * > &, bool, FActionMenuClosed >   GraphEditor.h
FOnCreateActionMenuAtLocation TBaseDelegate_FiveParams< FActionMenuContent, UEdGraph *, const FVector2f &, const TArray< UEdGraphPin * > &, bool, FActionMenuClosed >   GraphEditor.h
FOnCreateNodeOrPinMenu TBaseDelegate_FiveParams< FActionMenuContent, UEdGraph *, const UEdGraphNode *, const UEdGraphPin *, FMenuBuilder *, bool >   GraphEditor.h
FOnDisallowedPinConnection TBaseDelegate_TwoParams< void, const UEdGraphPin *, const UEdGraphPin * >   GraphEditor.h
FOnDoubleClicked TBaseDelegate_NoParams< void >   GraphEditor.h
FOnDropActor TBaseDelegate_ThreeParams< void, const TArray< TWeakObjectPtr< class AActor > > &, class UEdGraph *, const FVector2D & >   GraphEditor.h
FOnDropActors TBaseDelegate_ThreeParams< void, const TArray< TWeakObjectPtr< class AActor > > &, class UEdGraph *, const FVector2f & >   GraphEditor.h
FOnDropStreamingLevel TBaseDelegate_ThreeParams< void, const TArray< TWeakObjectPtr< class ULevelStreaming > > &, class UEdGraph *, const FVector2D & >   GraphEditor.h
FOnDropStreamingLevels TBaseDelegate_ThreeParams< void, const TArray< TWeakObjectPtr< class ULevelStreaming > > &, class UEdGraph *, const FVector2f & >   GraphEditor.h
FOnFocused TBaseDelegate_OneParam< void, const TSharedRef< SGraphEditor > & >   GraphEditor.h
FOnMouseButtonDown TBaseDelegate_TwoParams< FReply, const FGeometry &, const FPointerEvent & >   GraphEditor.h
FOnNodeSingleClicked TBaseDelegate_OneParam< void, UObject * >   GraphEditor.h
FOnNodeSpawnedByKeymap TBaseDelegate_NoParams< void >   GraphEditor.h
FOnSelectionChanged TBaseDelegate_OneParam< void, const FGraphPanelSelectionSet & >   GraphEditor.h
FOnSpawnNodeByShortcut TBaseDelegate_TwoParams< FReply, FInputChord, const FVector2D & >   GraphEditor.h
FOnSpawnNodeByShortcutAtLocation TBaseDelegate_TwoParams< FReply, FInputChord, const FVector2f & >   GraphEditor.h

Constants

Name Type Remarks Include Path
AllInstances TArray< TWeakPtr< SGraphEditor > > Active GraphEditor wrappers; we will notify these about the module being unloaded so they can handle it gracefully. GraphEditor.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Implementation TSharedPtr< SGraphEditor > The actual implementation of the GraphEditor GraphEditor.h  
OnGraphModuleReloadedCallback FEdGraphEvent This callback is triggered whenever the graph module is reloaded. GraphEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
  GraphEditor.h  

virtual void AddNotification ( FNotificationInfo& Info,
bool bSuccess
)

 Show notification on graph GraphEditor.h  

virtual bool CanCollapseNodes()

   GraphEditor.h  

virtual bool CanExpandNodes()

   GraphEditor.h  

virtual void CaptureKeyboard()

 Capture keyboard GraphEditor.h  

virtual void ClearSelectionSet()

 Clear the selection GraphEditor.h  

void Construct ( const FArguments& InArgs
)

 Loads the GraphEditorModule and constructs a GraphEditor as a child of this widget. GraphEditor.h  

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

   GraphEditor.h  

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

 Get Bounds for the specified node, returns false on failure GraphEditor.h  

virtual bool GetBoundsForSelectedNodes ( FSlateRect& Rect,
float Padding
)

 Get Bounds for selected nodes, false if nothing selected GraphEditor.h  

UEdGraph * GetCurrentGraph()

   GraphEditor.h  

virtual UEdGraphNode * GetGraphNodeForMenu()

   GraphEditor.h  

virtual SGraphPanel * GetGraphPanel()

 Returns the graph panel used for this graph editor GraphEditor.h  

virtual UEdGraphPin * GetGraphPinForMenu()

   GraphEditor.h  

virtual int32 GetNumberOfSelectedNodes()

   GraphEditor.h  

virtual FVector2D GetPasteLocation()

   GraphEditor.h  

virtual UE::Slate::FDeprecateVector2DResult GetPasteLocation2f()

   GraphEditor.h  

virtual const FGraphPanelSelectionSet & GetSelectedNodes()

   GraphEditor.h  

virtual UEdGraphNode * GetSingleSelectedNode()

 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) GraphEditor.h  

virtual TSharedPtr< SWidget > GetTitleBar()

 Get the title bar if there is one GraphEditor.h  

virtual void GetViewBookmark ( FGuid& OutBookmarkId
)

 Gets the current graph view bookmark GraphEditor.h  

virtual void GetViewLocation ( FVector2f& OutLocation,
float& OutZoomAmount
)

   GraphEditor.h  

virtual void GetViewLocation ( FVector2D& OutLocation,
float& OutZoomAmount
)

 Gets the view location of the graph GraphEditor.h  

virtual bool IsNodeTitleVisible ( const UEdGraphNode* Node,
bool bRequestRename
)

 Check if node title is visible with optional flag to ensure it is GraphEditor.h  

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

 Bring the specified node into view GraphEditor.h  

virtual void JumpToPin ( const UEdGraphPin* JumpToMe
)

 Bring the specified pin into view GraphEditor.h  

virtual void LockToGraphEditor ( TWeakPtr< SGraphEditor > Other
)

 Lock two graph editors together GraphEditor.h  

virtual void NotifyGraphChanged()

 Invoked when the Graph being edited changes in some way. GraphEditor.h  

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

   GraphEditor.h  

void NotifyPrePropertyChange ( const FString& PropertyName
)

   GraphEditor.h  

virtual void OnAlignBottom()

   GraphEditor.h  

virtual void OnAlignCenter()

   GraphEditor.h  

virtual void OnAlignLeft()

   GraphEditor.h  

virtual void OnAlignMiddle()

   GraphEditor.h  

virtual void OnAlignRight()

   GraphEditor.h  

virtual void OnAlignTop()

   GraphEditor.h  

virtual void OnCollapseNodes()

   GraphEditor.h  

virtual void OnDistributeNodesH()

   GraphEditor.h  

virtual void OnDistributeNodesV()

   GraphEditor.h  

virtual void OnExpandNodes()

   GraphEditor.h  

void OnModuleReloaded()

 Invoked to let this widget know that the GraphEditor module has been reloaded. GraphEditor.h  

void OnModuleUnloading()

 Invoked to let this widget know that the GraphEditor module is being unloaded. GraphEditor.h  

virtual void OnStackNodesH()

   GraphEditor.h  

virtual void OnStackNodesV()

   GraphEditor.h  

virtual void OnStraightenConnections()

   GraphEditor.h  

virtual void RefreshNode ( UEdGraphNode& Node
)

   GraphEditor.h  

virtual TSharedRef< FActiveTimerHandle > RegisterActiveTimer ( float TickPeriod,
FWidgetActiveTimerDelegate TickFunction
)

 Register an active timer on the graph editor. GraphEditor.h  

void ResetAllNodesUnrelatedStates()

 Common methods for MaterialEditor and BlueprintEditor's focusing related nodes feature GraphEditor.h  

virtual void SelectAllNodes()

 Select all nodes GraphEditor.h  

virtual void SetNodeFactory ( const TSharedRef< class FGraphNodeFactory >& NewNodeFactory
)

 Sets the current node, pin and connection factory. GraphEditor.h  

virtual void SetNodeSelection ( UEdGraphNode* Node,
bool bSelect
)

 Set the selection status of a node GraphEditor.h  

virtual void SetOnTick ( FOnGraphEditorTickDelegate InOnTickDelegate
)

 Sets the on tick delegate for the graph editor GraphEditor.h  

virtual void SetPinVisibility ( EPinVisibility InVisibility
)

 Set the pin visibility mode GraphEditor.h  

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

 Set new viewer location and optionally set the current bookmark GraphEditor.h  

virtual void SetViewLocation ( const FVector2f& Location,
float ZoomAmount,
const FGuid& BookmarkId
)

   GraphEditor.h  

virtual void StraightenConnections ()

   GraphEditor.h  

virtual void StraightenConnections ( UEdGraphPin* SourcePin,
UEdGraphPin* PinToAlign
) const

   GraphEditor.h  

virtual void UnlockFromGraphEditor ( TWeakPtr< SGraphEditor > Other
)

 Unlock two graph editors from each other GraphEditor.h  

virtual void ZoomToFit ( bool bOnlySelection
)

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

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnGraphChanged ( const FEdGraphEditAction& InAction
)

 Invoked when the underlying Graph is being changed. GraphEditor.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< SGraphEditor > FindGraphEditorForGraph ( const UEdGraph* Graph
)

 Returns the first graph editor that is viewing the specified graph. GraphEditor.h  

static void RegisterGraphEditor ( const TSharedRef< SGraphEditor >& InGraphEditor
)

   GraphEditor.h  

static void UpgradeDeprecatedDelegates ( FGraphEditorEvents& EventsToUpdate
)

   GraphEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page