Navigation
API > API/Plugins > API/Plugins/PCGEditor
Interface for manual editing viewport behavior and panel UI. Implement this to control:
- What UI appears in the manual edit panel for a given delta type.
- How elements with this delta type are drawn, selected, and manipulated in the viewport.
| Name | IPCGDeltaViewportExtension |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCGEditor/Public/DeltaViewportExtensions/PCGDeltaViewportExtension.h |
| Include Path | #include "DeltaViewportExtensions/PCGDeltaViewportExtension.h" |
Syntax
class IPCGDeltaViewportExtension
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IPCGDeltaViewportExtension() |
DeltaViewportExtensions/PCGDeltaViewportExtension.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< SWidget > CreateWidget
(
FPCGDeltaViewportCallbacks Callbacks |
Build the Slate widget section for this delta type. Called when the extension is swapped in. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
FLinearColor GetDisplayColor
(
bool bIsSelected |
Color for drawing elements with this delta type in the viewport. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
FText GetDisplayName() |
Returns the display name for this delta type. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
void RefreshLists
(
const FPCGDeltaViewportContext& Context |
Called when the delta context changes and lists need refreshing. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
void UpdateContext
(
const FPCGDeltaViewportContext& Context |
Called when the panel context changes. Update buttons, labels, etc. | DeltaViewportExtensions/PCGDeltaViewportExtension.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ApplyGizmoTransform
(
const FTransform& NewTransform, |
Apply the final gizmo transform to the delta struct. Returns true on success. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual void CollectRestorableKeys
(
const FPCGDeltaCollection& Collection, |
Collect all delta keys in the collection that this extension considers restorable. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual void CreateNewDelta
(
const FPCGDeltaKey& DeltaKey, |
Create a new delta struct in the collection on first gizmo release (deferred creation). | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual FName GetDeltaName() |
The delta name used for key computation. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual FTransform GetDisplayTransform
(
const FTransform& SourceElementTransform, |
Given a source element transform and the delta struct, return the transform to display. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual void GetInsertedElements
(
const FPCGDeltaCollection& Collection, |
Collect elements inserted by this extension that have no corresponding source point. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual TArray< FPCGDeltaKeyBinding > GetKeyBindings () |
Returns key bindings this extension wants the visualizer to route. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual FTransform GetOriginalTransform
(
const FConstStructView DeltaStruct |
Returns the original transform stored in the delta struct. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual int32 GetSortPriority() |
Sort priority for the delta type selector. Lower values appear first. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual bool MatchesSourceElement
(
const FTransform& SourceElementTransform, |
Given a source element's transform and a delta, return true if this delta corresponds to that source element. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual int32 OnAltDrag
(
FPCGDeltaCollection& Collection, |
Alt+drag handler. | DeltaViewportExtensions/PCGDeltaViewportExtension.h | |
virtual bool UsesTRSGizmo() |
Returns true if this delta type uses a TRS gizmo when selected. | DeltaViewportExtensions/PCGDeltaViewportExtension.h |