PCGEditor

API > API/Plugins

   
Name PCGEditor
Type Editor
Part of Plugins Procedural Content Generation Framework (PCG)
Location /Engine/Plugins/PCG/Source/PCGEditor/
Module Build Rules PCGEditor.Build.cs

Classes

Name Remarks
FEnumSelectorDetails Property type customization for an enum selector allowing the user to easily select from a list of available enum classes and then also select a value from that class's options.
FPCGAttributePropertySelectorDetails  
FPCGBaseTextureDataVisualization  
FPCGBlueprintSettingsDetails  
FPCGCollisionShapeDataVisualization Specialization for simple collision shapes
FPCGCollisionWrapperDataVisualization Specialization for collision wrappers
FPCGComponentDetails  
FPCGComponentVisualizer  
FPCGCustomHLSLSettingsDetails Implements a details view customization for the Custom HLSL node settings.
FPCGDataTypeIdentifierDetails  
FPCGDataViewVisualization  
FPCGEditableUserParameterDetails A simple Details Customization that will provide a single property from the graph's FInstancePropertyBag
FPCGEditor  
FPCGEditorCommands  
FPCGEditorConnectionDrawingPolicy  
FPCGEditorInspectionDataManager Central class that will handle everything related to Inspection Data.
FPCGEditorModule  
FPCGEditorSpawnNodeCommands Handles spawn node commands for the PCG Graph Editor.
FPCGGraphDetails  
FPCGGraphInstanceDetails  
FPCGInteractiveToolSettingsDetails  
FPCGPolygon2DDataVisualization  
FPCGPrimitiveDataVisualization Overrides collapse behavior to target a given number of points generated, to avoid too coarse debug (points way bigger than data) or enormous amount of points (points way smaller than data).
FPCGRawBufferDataVisualization  
FPCGRaycastFilterRuleCollectionDetails  
FPCGTexture2DArrayDataVisualization  
FPCGVolumeDataVisualization Specialization for volumes that don't always rely on their primitive component
FPCGVolumeDetails  
SPCGEditorViewport  
SPCGExecutionSourceActionWidget  
UPCGAssetEditorInteractiveTool Base interactive tool for PCG Asset Editor Provides viewport coordination and node inspection integration
UPCGAssetEditorInteractiveToolBuilder Generic builder for PCG Asset Editor Interactive Tools.
UPCGAssetEditorInteractiveToolSettings Settings for PCG Asset Editor Interactive Tool
UPCGAssetEditorMode Editor mode used exclusively within the PCG Asset Editor window (FPCGEditor).
UPCGCollisionVisComponent  
UPCGEditorGraphNode  
UPCGEditorGraphNodeBase  
UPCGEditorGraphSchema  
UPCGEditorProjectSettings  
UPCGEditorSettings  
UPCGGraphParametersSchema Specific property bag schema to allow only arrays and set as containers.
UPCGLevelToAsset  
UPCGNodeToolContext Generic context object stored in UContextObjectStore to pass data from FPCGEditor into a tool.
UPCGPropertyBagHierarchyCategory  
UPCGPropertyBagHierarchyRoot  
UPCGPropertyBagHierarchySection  

Structs

Name Remarks
FColumnInfoOverrides  
FInsertedViewportElement An element inserted by an extension that has no corresponding source point.
FPCGActionsFilter  
FPCGDeferNodeReconstructScope Disables reconstruct on nodes (or from a pin) and re-enables in destructor.
FPCGDeltaCreateContext Context passed to extensions when creating a new delta on first gizmo release.
FPCGDeltaKeyBinding A key binding requested by an extension for an input action.
FPCGDeltaViewportCallbacks Generic actions provided by the framework to extensions to subscribe to on creation.
FPCGDeltaViewportContext Snapshot of panel state passed to extensions when the selection or configuration changes.
FPCGDeltaViewportExtensionRegistry Register a delta struct type with an IPCGDeltaViewportExtension to control viewport behavior and panel UI.
FPCGDeltaVisualizationRegistry Register a delta struct type with an IPCGDeltaVisualization to implement custom visualization behavior.
FPCGDeltaVisualizerColumnInfo Lightweight column descriptor for the delta overrides table.
FPCGEditorAttributeListViewSettings  
FPCGEditorCommonDummyStruct Used to make sure UHT generates properly
FPCGEditorGraphSchemaAction_NewBlueprintElement  
FPCGEditorGraphSchemaAction_NewComment Action to add a 'comment' node to the graph
FPCGEditorGraphSchemaAction_NewGetParameterElement  
FPCGEditorGraphSchemaAction_NewLoadAssetElement  
FPCGEditorGraphSchemaAction_NewNamedRerouteDeclaration  
FPCGEditorGraphSchemaAction_NewNamedRerouteUsage  
FPCGEditorGraphSchemaAction_NewNativeElement  
FPCGEditorGraphSchemaAction_NewReroute  
FPCGEditorGraphSchemaAction_NewSettingsElement  
FPCGEditorGraphSchemaAction_NewSubgraphElement Creates a new subgraph element and allows choosing whether it can be a subgraph node or a loop node.
FPCGEditorGraphSchemaActionBase  
FPCGEditorInspectionDataEntry  
FPCGEditorInspectionDataEntrySetupParams  
FPCGGenericTabFactory  
FPCGGenericTabFactoryParams  
FPCGGraphEditorDocumentTabFactory  
FPCGSpawnNodeCommandInfo  
HPCGComponentVisualizerHitProxy  

Interfaces

Name Remarks
IPCGDeltaViewportExtension Interface for manual editing viewport behavior and panel UI.
IPCGDeltaVisualization Interface for delta type visualizers.
IPCGLandscapeDataVisualization Overrides collapse behavior to target a given number of points generated, to avoid too coarse debug (points way bigger than data) or enormous amount of points (points way smaller than data).
IPCGParamDataVisualization  
IPCGSpatialDataVisualization Default implementation for spatial data. Collapses to a PointData representation.
IPCGSplineDataVisualization  
IPCGStaticMeshDataVisualization  

Typedefs

Name Type Remarks Include Path
FOnInspectedNodeChanged TMulticastDelegate_OneParam< void, UPCGEditorGraphNodeBase * >   PCGEditor.h
FOnInspectedStackChanged TMulticastDelegate_OneParam< void, const FPCGStack & >   Managers/PCGEditorInspectionDataManager.h
FOnInspectionEntryChanged TMulticastDelegate_TwoParams< void, const FPCGEditorInspectionDataEntry &, int32 >   Managers/PCGEditorInspectionDataManager.h
FPCGGenericTabClosed TBaseDelegate_OneParam< void, FName >   PCGEditorTabFactories.h

Enums

Public

Name Remarks
EPCGEditorDoubleClickAction  
EPCGEditorNewPCGGraphBehavior  
EPCGEditorNewSettingsBehavior  
EPCGElementType  
EPCGToolbarButtons  
EPCGTreatViewportAsGenerationSource  
PCGActionsHelpers::ECompatibilityMask  

Constants

Name Type Remarks Include Path
PCGDeltaVisualization::Constants::DeltaTypeId const FName   DeltaVisualizations/PCGDeltaVisualization.h
PCGDeltaVisualization::Constants::SignatureId const FName   DeltaVisualizations/PCGDeltaVisualization.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AttributesID FLazyName   PCGEditor.h  
BaseTextureDataType const FName   PCGEditorCommon.h  
CodeEditorID FLazyName   PCGEditor.h  
ConcreteDataType const FName   PCGEditorCommon.h  
ContextIdentifier const FString   PCGEditorCommon.h  
DataOverridesID FLazyName   PCGEditor.h  
DebugObjectID FLazyName   PCGEditor.h  
DeterminismID FLazyName   PCGEditor.h  
DynamicMeshDataType const FName   PCGEditorCommon.h  
EmbeddedSubgraphsID FLazyName   PCGEditor.h  
FindID FLazyName   PCGEditor.h  
GraphEditorID FLazyName   PCGEditor.h  
HLSLSourceID FLazyName   PCGEditor.h  
LandscapeDataType const FName   PCGEditorCommon.h  
LogID FLazyName   PCGEditor.h  
NAME_Index const FName Names of the columns in the attribute list. DataVisualizations/PCGDataVisualizationHelpers.h  
NumAttributeTabs int32   PCGEditor.h  
NumPropertyDetailTabs int32   PCGEditor.h  
NumViewportTabs int32   PCGEditor.h  
OtherDataType const FName   PCGEditorCommon.h  
PaletteID FLazyName   PCGEditor.h  
ParamDataType const FName   PCGEditorCommon.h  
PointDataType const FName   PCGEditorCommon.h  
PolyLineDataType const FName   PCGEditorCommon.h  
PrimitiveDataType const FName   PCGEditorCommon.h  
ProfilingID FLazyName   PCGEditor.h  
PropertyDetailsID FLazyName   PCGEditor.h  
RenderTargetDataType const FName   PCGEditorCommon.h  
SettingsDataType const FName   PCGEditorCommon.h  
SpatialDataType const FName   PCGEditorCommon.h  
StaticMeshResourceDataType const FName   PCGEditorCommon.h  
SurfaceDataType const FName   PCGEditorCommon.h  
TextureDataType const FName   PCGEditorCommon.h  
UserParamsID FLazyName   PCGEditor.h  
ViewportID FLazyName   PCGEditor.h  
VirtualTextureDataType const FName   PCGEditorCommon.h  
VolumeDataType const FName   PCGEditorCommon.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void FPCGEditorCommon::Helpers::DispatchEditorToast ( const FText& Text,
const FText& SubText,
const float Duration
)

   PCGEditorCommon.h  

const FAssetCategoryPath FPCGEditorCommon::PCGAdvancedAssetCategoryPath ( FPCGEditorCommon::PCGAssetCategoryPath
)

   PCGEditorCommon.h  

const FAssetCategoryPath FPCGEditorCommon::PCGAssetCategoryPath ( LOCTEXT("PCGCategory", "Procedural")
)

   PCGEditorCommon.h  

const FAssetCategoryPath FPCGEditorCommon::PCGAssetSubCategoryPath ( FPCGEditorCommon::PCGAssetCategoryPath
)

   PCGEditorCommon.h  

bool operator! ( EPCGElementType E
)

   PCGEditorCommon.h  
  PCGEditorCommon.h  

EPCGElementType & operator&= ( EPCGElementType& Lhs,
EPCGElementType Rhs
)

   PCGEditorCommon.h  
  PCGEditorCommon.h  

EPCGElementType & operator^= ( EPCGElementType& Lhs,
EPCGElementType Rhs
)

   PCGEditorCommon.h  
  PCGEditorCommon.h  

EPCGElementType & operator|= ( EPCGElementType& Lhs,
EPCGElementType Rhs
)

   PCGEditorCommon.h  
  PCGEditorCommon.h  

bool PCGActionsHelpers::operator! ( ECompatibilityMask E
)

   Schema/PCGEditorGraphSchema.h  

ECompatibilityMask PCGActionsHelpers::operator& ( ECompatibilityMask Lhs,
ECompatibilityMask Rhs
)

   Schema/PCGEditorGraphSchema.h  

ECompatibilityMask & PCGActionsHelpers::operator&= ( ECompatibilityMask& Lhs,
ECompatibilityMask Rhs
)

   Schema/PCGEditorGraphSchema.h  

ECompatibilityMask PCGActionsHelpers::operator^ ( ECompatibilityMask Lhs,
ECompatibilityMask Rhs
)

   Schema/PCGEditorGraphSchema.h  

ECompatibilityMask & PCGActionsHelpers::operator^= ( ECompatibilityMask& Lhs,
ECompatibilityMask Rhs
)

   Schema/PCGEditorGraphSchema.h  

ECompatibilityMask PCGActionsHelpers::operator| ( ECompatibilityMask Lhs,
ECompatibilityMask Rhs
)

   Schema/PCGEditorGraphSchema.h  

ECompatibilityMask & PCGActionsHelpers::operator|= ( ECompatibilityMask& Lhs,
ECompatibilityMask Rhs
)

   Schema/PCGEditorGraphSchema.h  

ECompatibilityMask PCGActionsHelpers::operator~ ( ECompatibilityMask E
)

   Schema/PCGEditorGraphSchema.h  

void PCGDataVisualizationHelpers::AddPropertyEnumColumnInfo ( FPCGTableVisualizerInfo& OutInfo,
const UPCGData* Data,
EnumType EnumValue,
const FColumnInfoOverrides& Overrides
)

   DataVisualizations/PCGDataVisualizationHelpers.h  

void PCGDataVisualizationHelpers::AddPropertyEnumColumnInfo ( FPCGTableVisualizerInfo& OutInfo,
const UPCGData* Data,
const UEnum* EnumClass,
int64 EnumValue,
const FColumnInfoOverrides& Overrides
)

   DataVisualizations/PCGDataVisualizationHelpers.h  

void PCGDataVisualizationHelpers::AddTypedColumnInfo ( FPCGTableVisualizerInfo& OutInfo,
const UPCGData* Data,
const FPCGAttributePropertySelector& InSelector,
const FColumnInfoOverrides& Overrides
)

   DataVisualizations/PCGDataVisualizationHelpers.h  

void PCGDataVisualizationHelpers::AddTypedColumnInfo_Impl ( FPCGTableVisualizerInfo& OutInfo,
const UPCGData* Data,
const FPCGAttributePropertySelector& InSelector,
const FColumnInfoOverrides& Overrides
)

   DataVisualizations/PCGDataVisualizationHelpers.h  

TArray< UClass * > PCGMakeSupportedSettingsArray()

 Expands each TSettings type into its StaticClass() pointer. AssetEditorMode/Tools/PCGAssetEditorInteractiveTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page