1. Epic GamesDeveloper
  3. FPCGEditor

FPCGEditor

API > API/Plugins > API/Plugins/PCGEditor

   
Name FPCGEditor
Type class
Header File /Engine/Plugins/PCG/Source/PCGEditor/Public/PCGEditor.h
Include Path #include "PCGEditor.h"

Syntax

class FPCGEditor :  
    public FAssetEditorToolkit,  
    public FGCObject ,  
    public FSelfRegisteringEditorUndoClient

Inheritance Hierarchy

Implements Interfaces

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AttributesWidgets TArray< TSharedPtr< SPCGEditorGraphAttributeListView > >   PCGEditor.h  
DebugObjectTreeWidget TSharedPtr< SPCGEditorGraphDebugObjectTree >   PCGEditor.h  
DeterminismWidget TSharedPtr< SPCGEditorGraphDeterminismListView >   PCGEditor.h  
FindWidget TSharedPtr< SPCGEditorGraphFind >   PCGEditor.h  
GraphEditorCommands TSharedPtr< FUICommandList >   PCGEditor.h  
GraphEditorWidget TSharedPtr< SGraphEditor >   PCGEditor.h  
InspectionDataManager FPCGEditorInspectionDataManager   PCGEditor.h  
LastExecutionStatus TOptional< TPair< const IPCGGraphExecutionSource *, EPCGGenerationStatus > > Keep track of the last execution status to be able to break infinite loop when a source is triggered to be generated by inspection aborted and re-triggered. PCGEditor.h  
LogWidget TSharedPtr< SPCGEditorGraphLogView >   PCGEditor.h  
NodeSourceWidget TSharedPtr< SPCGEditorNodeSource >   PCGEditor.h  
PaletteWidget TSharedPtr< SPCGEditorGraphNodePalette >   PCGEditor.h  
PCGDefaultExecutionSource TObjectPtr< UPCGDefaultExecutionSource >   PCGEditor.h  
PCGEditorGraph UPCGEditorGraph *   PCGEditor.h  
PCGGraphBeingEdited TObjectPtr< UPCGGraph >   PCGEditor.h  
ProfilingWidget TSharedPtr< SPCGEditorGraphProfilingView >   PCGEditor.h  
PropertyDetailsWidgets TArray< TSharedPtr< SPCGEditorGraphDetailsView > >   PCGEditor.h  
UserParamsWidget TSharedPtr< SPCGEditorGraphUserParametersView >   PCGEditor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BringFocusToPanel ( const FName PanelID
) const

 Focuses the user on a specific panel and flashes the tab. PCGEditor.h  

void BringFocusToPanel ( EPCGEditorPanel Panel
) const

 Focuses the user on a specific panel and flashes the tab. PCGEditor.h  

bool CanRunDeterminismGraphTest()

 Can determinism be tested on the current graph PCGEditor.h  

void ClearStackBeingInspected()

 Clear current inspection. PCGEditor.h  

void CloseGraphPanel ( const FName PanelID
) const

 Attempts to close the specific panel if it's open. PCGEditor.h  

void CloseGraphPanel ( EPCGEditorPanel Panel
) const

 Attempts to close the specific panel if it's open. PCGEditor.h  

virtual FText GetBaseToolkitName()

   PCGEditor.h  

UPCGDefaultExecutionSource * GetDefaultExecutionSource()

   PCGEditor.h  
  PCGEditor.h  
  PCGEditor.h  

FName GetPanelID ( EPCGEditorPanel Panel
) const

 Get the TabID of the editor panel. PCGEditor.h  

UPCGComponent * GetPCGComponentBeingInspected()

 Gets the PCG source we are debugging PCGEditor.h  

UPCGEditorGraph * GetPCGEditorGraph ()

 Get the PCG editor graph being edited. PCGEditor.h  

const UPCGGraph * GetPCGGraph()

 Get the PCG graph being edited. PCGEditor.h  

IPCGGraphExecutionSource * GetPCGSourceBeingInspected()

   PCGEditor.h  

virtual TSubclassOf< UPCGEditorGraphSchema > GetSchemaClass()

 Can override the schema used for this editor. By default, it's UPCGEditorSchema. PCGEditor.h  

const FPCGStack * GetStackBeingInspected()

 Gets the PCG stack we are inspecting PCGEditor.h  

virtual IPCGBaseSubsystem * GetSubsystem()

 Helper to get to the subsystem. PCGEditor.h  

virtual FName GetToolkitFName()

   PCGEditor.h  

virtual FLinearColor GetWorldCentricTabColorScale()

   PCGEditor.h  

virtual FString GetWorldCentricTabPrefix()

   PCGEditor.h  

void Initialize ( const EToolkitMode::Type InMode,
const TSharedPtr< class IToolkitHost >& InToolkitHost,
UPCGGraph* InPCGGraph,
UObject* InObjectToEdit
)

 Edits the specified PCGGraph PCGEditor.h  

virtual void InitToolMenuContext ( FToolMenuContext& MenuContext
)

   PCGEditor.h  

virtual bool IsPanelAvailable ( const FName PanelID
) const

 Returns true if the panel is available. PCGEditor.h  
Returns true if the selected tab is currently open and focused. PCGEditor.h  

bool IsPanelCurrentlyForeground ( const FName PanelID
) const

 Returns true if the selected tab is currently open and focused. PCGEditor.h  

bool IsPanelCurrentlyOpen ( EPCGEditorPanel Panel
) const

 Returns true if the selected tab is currently open. PCGEditor.h  

bool IsPanelCurrentlyOpen ( const FName PanelID
) const

 Returns true if the selected tab is currently open. PCGEditor.h  

void JumpToNode ( const UEdGraphNode* InNode
)

 Focus the graph view on a specific node PCGEditor.h  

void JumpToNode ( const UPCGNode* InNode
)

   PCGEditor.h  

virtual bool MatchesContext ( const FTransactionContext& InContext,
const TArray< TPair< UObject*, FTransactionObjectEvent > >& TransactionObjectContexts
) const

   PCGEditor.h  

virtual void OnClose()

   PCGEditor.h  

FActionMenuContent OnCreateActionMenuContent ( UEdGraph* InGraph,
const FVector2f& Location,
const TArray< UEdGraphPin* >& InDraggedPins,
bool bAutoExpand,
SGraphEditor::FActionMenuClosed OnMenuClosed
)

   PCGEditor.h  

void OnDeterminismGraphTest()

 Run the determinism test on the current graph PCGEditor.h  

FReply OnSpawnNodeByShortcut ( FInputChord InChord,
const FVector2D& InPosition,
UPCGEditorGraph* InGraph
)

 Handles spawning a graph node in the current graph using the passed in chord. PCGEditor.h  

FReply OnSpawnNodeByShortcut ( FInputChord InChord,
const FVector2f& InPosition,
UPCGEditorGraph* InGraph
)

   PCGEditor.h  

virtual void PostRedo ( bool bSuccess
)

   PCGEditor.h  

virtual void PostUndo ( bool bSuccess
)

   PCGEditor.h  

virtual void RegisterTabSpawners ( const TSharedRef< class FTabManager >& InTabManager
)

   PCGEditor.h  

void SetSourceEditorTargetObject ( UObject* InObject
)

   PCGEditor.h  

void SetStackBeingInspected ( const FPCGStack& FullStack
)

 Sets the execution stack that want to inspect. PCGEditor.h  

void SetStackBeingInspectedFromAnotherEditor ( const FPCGStack& FullStack
)

 Sets the execution stack from another editor, which will set directly in the debug object tree view. PCGEditor.h  

virtual void UnregisterTabSpawners ( const TSharedRef< class FTabManager >& InTabManager
)

   PCGEditor.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   PCGEditor.h  

virtual FString GetReferencerName()

   PCGEditor.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void BindCommands()

 Bind commands to delegates PCGEditor.h  

virtual bool CanToggleDebug()

 Whether we can toggle debug state of selected nodes PCGEditor.h  

virtual bool CanToggleEnabled()

 Whether we can toggle enabled state of selected nodes PCGEditor.h  

virtual bool CanToggleInspected()

 Whether we can toggle inspection of selected nodes PCGEditor.h  

virtual TSharedRef< SPCGEditorViewport > CreateViewportWidget()

 Create a new viewport widget. Can be subclassed to have customization around the viewport. PCGEditor.h  

virtual TAttribute< FGraphAppearanceInfo > GetAppearanceInfo()

   PCGEditor.h  

virtual void OnGraphChanged ( UPCGGraphInterface* InGraph,
EPCGChangeType ChangeType
)

   PCGEditor.h  

virtual void OnNodeDoubleClicked ( UEdGraphNode* Node
)

 Called when a node is double clicked PCGEditor.h  

virtual void OnSelectedNodesChanged ( const TSet< UObject* >& NewSelection
)

 Called when the selection changes in the GraphEditor PCGEditor.h  

void OnToggleInspected()

 Toggle node inspection state for selected nodes. PCGEditor.h  

void RegisterToolbarButton ( FToolMenuSection& Section,
EPCGToolbarButtons Button
) const

 Register PCG default editor toolbar button PCGEditor.h  

virtual void RegisterToolbarInternal ( FToolMenuSection& PCGSection
) const

 Register PCG specific toolbar for the editor PCGEditor.h  

void SetNodeInspected ( UPCGEditorGraphNodeBase* InspectedNode,
bool bValue
)

 Set inspection state for node. Can be null, in that case it will clear inspection. PCGEditor.h  

Static

Name Remarks Include Path Unreal Specifiers

static UPCGEditorGraph * GetPCGEditorGraph ( UPCGGraph* InGraph
)

 Gets/Creates the PCG graph editor for a given PCG graph PCGEditor.h  

static UPCGEditorGraph * GetPCGEditorGraph ( const UPCGNode* InNode
)

   PCGEditor.h  

static UPCGEditorGraph * GetPCGEditorGraph ( const UPCGSettings* InSettings
)

   PCGEditor.h  

static UPCGSubsystem * GetWorldSubsystem()

   PCGEditor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page