FPCGComponentVisualizer

API > API/Plugins > API/Plugins/PCGEditor

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

Syntax

class FPCGComponentVisualizer : public FComponentVisualizer

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FPCGComponentVisualizer()

   PCGComponentVisualizer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPCGComponentVisualizer()

   PCGComponentVisualizer.h  

Structs

Name Remarks
FEditState Tracks the state of the currently selected delta element in the viewport, including the owning component, delta key, gizmo transform, and per-extension metadata.
FManualEditComponentCache Component derived state cached across frames. Rebuilt when the executed stacks generation changes.
FPCGCachedDeltaContext Cached result of resolving the mutable delta collection for the active editing node.

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearActiveSelection()

 Clears the current selection (EditTarget + gizmo). Call before switching active editing nodes. PCGComponentVisualizer.h  

void RestoreAllDeltas()

 Removes all restorable deltas from the active collection (delegates to each extension's CollectRestorableKeys). PCGComponentVisualizer.h  

void RestoreDelta ( const FPCGDeltaKey& Key
)

 Removes a specific delta by key. PCGComponentVisualizer.h  

void SelectElement ( const FPCGDeltaKey& DeltaKey,
int32 ElementIndex
)

 Selects a delta element by key and optional sub-index. Looks up the extension from the registry. PCGComponentVisualizer.h  

Public Virtual

Overridden from FComponentVisualizer

Name Remarks Include Path Unreal Specifiers

virtual void DrawVisualization ( const UActorComponent* Component,
const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

   PCGComponentVisualizer.h  

virtual void DrawVisualizationHUD ( const UActorComponent* Component,
const FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

   PCGComponentVisualizer.h  

virtual void EndEditing()

   PCGComponentVisualizer.h  

virtual TSharedPtr< SWidget > GenerateContextMenu()

   PCGComponentVisualizer.h  

virtual bool GetCustomInputCoordinateSystem ( const FEditorViewportClient* ViewportClient,
FMatrix& OutMatrix
) const

   PCGComponentVisualizer.h  

virtual bool GetWidgetLocation ( const FEditorViewportClient* ViewportClient,
FVector& OutLocation
) const

   PCGComponentVisualizer.h  

virtual bool HandleInputDelta ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FVector& DeltaTranslate,
FRotator& DeltaRotate,
FVector& DeltaScale
)

   PCGComponentVisualizer.h  

virtual bool HandleInputKey ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FKey Key,
EInputEvent Event
)

   PCGComponentVisualizer.h  

virtual void OnRegister()

   PCGComponentVisualizer.h  

virtual bool VisProxyHandleClick ( FEditorViewportClient* InViewportClient,
HComponentVisProxy* VisProxy,
const FViewportClick& Click
)

   PCGComponentVisualizer.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BuildExecutedNodeStacksCache ( FManualEditComponentCache& Cache,
const UPCGComponent* InComponent
)

 Rebuilds the cache from the component's executed stacks map. PCGComponentVisualizer.h  
Returns a pointer to the cache entry for InComponent, creating one if it does not exist. PCGComponentVisualizer.h  

bool HasSelection()

 Returns true if there is a valid PCG component and an active edit target. PCGComponentVisualizer.h  

void OnGizmoDragged ( const FTransform& NewTransform
)

 Called each frame while the TRS gizmo is being dragged. Updates the cached selection transform. PCGComponentVisualizer.h  

void OnGizmoReleased ( const FTransform& FinalTransform
)

 Called when the TRS gizmo drag ends. Materializes deferred deltas and applies the final transform. PCGComponentVisualizer.h  

void RefreshKeyBindings ( IPCGDeltaViewportExtension* Extension
)

 Rebuilds the active key bindings from the extension's registered input actions. PCGComponentVisualizer.h  

void RemoveAllDeltas()

 Removes all deltas from the active editing node's collection and clears the selection. PCGComponentVisualizer.h  

void RemoveSelectedDeltas()

 Removes the currently selected delta and clears the selection. PCGComponentVisualizer.h  

void ResetGizmo()

 Hides and destroys the active TRS gizmo. PCGComponentVisualizer.h  

void SetupGizmo ( UInteractiveGizmoManager* GizmoManager,
const FTransform& InitialTransform
)

 Creates a TRS gizmo at the given transform with drag/release callbacks bound to this visualizer. PCGComponentVisualizer.h  

void SetupManualEditComponentCacheCallbacks ( FManualEditComponentCache& Cache,
const UPCGComponent* InComponent
)

 Binds component delegate bindings that mark the cache dirty. PCGComponentVisualizer.h  

void TeardownManualEditComponentCacheCallbacks ( FManualEditComponentCache& Cache,
const UPCGComponent* InComponent
)

 Releases component delegate bindings. Safe to call even if the component is no longer valid. PCGComponentVisualizer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page