1. Epic GamesDeveloper
  3. UPCGSubsystem

UPCGSubsystem

[UPCGSubsystem](API\Plugins\PCG\UPCGSubsystem)

API > API/Plugins > API/Plugins/PCG

UPCGSubsystem

   
Name UPCGSubsystem
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Subsystems/PCGSubsystem.h
Include Path #include "Subsystems/PCGSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UPCGSubsystem :  
    public UTickableWorldSubsystem ,  
    public IPCGBaseSubsystem

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGSubsystem()

   Subsystems/PCGSubsystem.h  

Typedefs

Name Type Remarks Include Path
FConstructionScriptSourceComponents TMap< FName, TObjectKey< UPCGComponent > >   Subsystems/PCGSubsystem.h
FTickAction TFunction< void()> Adds an action that will be executed once at the beginning of this subsystem's next Tick(). Subsystems/PCGSubsystem.h

Constants

Name Type Remarks Include Path
DisablePartitionActorCreationForWorld TSet< UWorld * >   Subsystems/PCGSubsystem.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FPCGActorAndComponentMapping friend   Subsystems/PCGSubsystem.h  
OnComponentGenerationCompleteOrCancelled FPCGOnComponentGenerationCompleteOrCancelled   Subsystems/PCGSubsystem.h  
OnComponentUnregistered FPCGOnComponentUnregistered   Subsystems/PCGSubsystem.h  
OnPCGComponentGenerationDone FPCGOnPCGComponentGenerationDone   Subsystems/PCGSubsystem.h  
OnPCGComponentUnregistered FPCGOnPCGComponentUnregistered   Subsystems/PCGSubsystem.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ActorAndComponentMapping TUniquePtr< FPCGActorAndComponentMapping >   Subsystems/PCGSubsystem.h  
BeginTickActions TArray< FTickAction > Functions will be executed at the beginning of the tick and then removed from this array. Subsystems/PCGSubsystem.h  
bHasTickedOnce bool   Subsystems/PCGSubsystem.h  
PCGWorldActor APCGWorldActor *   Subsystems/PCGSubsystem.h  
PCGWorldActorLock FCriticalSection   Subsystems/PCGSubsystem.h  
PerActorConstructionScriptSourceComponents TMap< TObjectKey< AActor >, FConstructionScriptSourceComponents >   Subsystems/PCGSubsystem.h  
RuntimeGenScheduler FPCGRuntimeGenScheduler *   Subsystems/PCGSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BuildLandscapeCache ( bool bQuiet,
bool bForceBuild
)

 Builds the landscape data cache. Subsystems/PCGSubsystem.h  

void CleanupAllPCGComponents ( bool bPurge
) const

 Will gather all the components registered, and ask for cleanup. Subsystems/PCGSubsystem.h  

void CleanupLocalComponentsImmediate ( UPCGComponent* InOriginalComponent,
bool bRemoveComponents
)

 Immediately cleanup the local components associated with an original component. Subsystems/PCGSubsystem.h  

void ClearExecutedStacks ( const FPCGStack& BeginningWithStack
)

   Subsystems/PCGSubsystem.h  

void ClearExecutedStacks ( const UPCGGraph* InContainingGraph
)

   Subsystems/PCGSubsystem.h  

void ClearExecutedStacks ( const UPCGComponent* InRootComponent
)

   Subsystems/PCGSubsystem.h  

void ClearExecutionMetadata ( UPCGComponent* InComponent
)

   Subsystems/PCGSubsystem.h  

void ClearExecutionMetadata ( const FPCGStack& BaseStack
)

   Subsystems/PCGSubsystem.h  

void ClearLandscapeCache()

 Clears the landscape data cache Subsystems/PCGSubsystem.h  

void ClearPCGLink ( UPCGComponent* InComponent,
const FBox& InBounds,
AActor* InNewActor
)

 Move all resources from sub actors to a new actor Subsystems/PCGSubsystem.h  

void CreateMissingPartitionActors()

   Subsystems/PCGSubsystem.h  

void DeleteSerializedPartitionActors ( bool bOnlyDeleteUnused,
bool bOnlyChildren
)

 Delete serialized partition actors in the level. Subsystems/PCGSubsystem.h  

void DestroyAllPCGWorldActors()

   Subsystems/PCGSubsystem.h  

void DestroyCurrentPCGWorldActor()

   Subsystems/PCGSubsystem.h  

void DirtyGraph ( UPCGComponent* Component,
const FBox& InBounds,
EPCGComponentDirtyFlag DirtyFlag
)

 Immediately dirties the partition actors in the given bounds Subsystems/PCGSubsystem.h  

APCGPartitionActor * FindOrCreatePCGPartitionActor ( const FGuid& Guid,
uint32 GridSize,
const FIntVector& GridCoords,
bool bRuntimeGenerated,
bool bCanCreateActor
) const

   Subsystems/PCGSubsystem.h  

APCGPartitionActor * FindOrCreatePCGPartitionActor ( const FPCGGridDescriptor& GridDescriptor,
const FIntVector& GridCoords,
bool bCanCreateActor,
bool bHideFromOutliner
) const

 Creates a new partition actor if one does not already exist with the same grid size, coords, and generation mode. Subsystems/PCGSubsystem.h  

APCGWorldActor * FindPCGWorldActor()

   Subsystems/PCGSubsystem.h  

void ForAllIntersectingPartitionedComponents ( const FBoxCenterAndExtent& InBounds,
TFunctionRef< void(UPCGComponent*)> InFunc
) const

 Get all components in specified bounds. Subsystems/PCGSubsystem.h  

FPCGTaskId ForAllOverlappingCells ( const FBox& InBounds,
const PCGHiGenGrid::FSizeArray& InGridSizes,
bool bCanCreateActor,
const TArray< FPCGTaskId >& Dependencies,
TFunctionRef< FPCGTaskId(APCGPartitionActor*, const FBox&)> InFunc
) const

 Call InFunc to all partition grid cells matching 'InGridSizes' and overlapping with 'InBounds'. Subsystems/PCGSubsystem.h  

FPCGTaskId ForAllOverlappingCells ( UPCGComponent* InPCGComponent,
const FBox& InBounds,
const PCGHiGenGrid::FSizeArray& InGridSizes,
bool bCanCreateActor,
const TArray< FPCGTaskId >& Dependencies,
TFunctionRef< FPCGTaskId(APCGPartitionActor*, const FBox&)> InFunc,
TFunctionRef< FPCGTaskId(const FPCGGridDescriptor&, const FIntVector&, const FBox&)> InUnloadedFu...
) const

   Subsystems/PCGSubsystem.h  

void ForAllOverlappingComponentsInHierarchy ( UPCGComponent* InComponent,
const TFunctionRef< void(UPCGComponent*)>& InFunc
) const

 Traverses the hierarchy associated with the given component and calls InFunc for each overlapping component. Subsystems/PCGSubsystem.h  

void ForAllRegisteredIntersectingLocalComponents ( UPCGComponent* InOriginalComponent,
const FBoxCenterAndExtent& InBounds,
const TFunctionRef< void(UPCGComponent*)>& InFunc
) const

 Call the InFunc function to all local component registered to the original component within some bounds. Subsystems/PCGSubsystem.h  

void ForAllRegisteredLocalComponents ( UPCGComponent* InOriginalComponent,
const TFunctionRef< void(UPCGComponent*)>& InFunc
) const

 Call the InFunc function to all local component registered to the original component. Thread safe Subsystems/PCGSubsystem.h  

void GenerateAllPCGComponents ( bool bForce
) const

 Will gather all the components registered, and ask for generate. Subsystems/PCGSubsystem.h  

TArray< UPCGComponent * > GetAllIntersectingComponents ( const FBoxCenterAndExtent& InBounds
) const

 Gather all the PCG components within some bounds. Subsystems/PCGSubsystem.h  

TSet< UPCGComponent * > GetAllRegisteredComponents()

   Subsystems/PCGSubsystem.h  

TSet< UPCGComponent * > GetAllRegisteredPartitionedComponents()

   Subsystems/PCGSubsystem.h  

TArray< FPCGStack > GetExecutedStacks ( const UPCGComponent* InComponent,
const UPCGGraph* InSubgraph,
bool bOnlyWithSubgraphAsCurrentFrame
)

   Subsystems/PCGSubsystem.h  

TArray< FPCGStack > GetExecutedStacks ( const FPCGStack& BeginningWithStack
)

   Subsystems/PCGSubsystem.h  

FPCGGenSourceManager * GetGenSourceManager()

   Subsystems/PCGSubsystem.h  

UPCGLandscapeCache * GetLandscapeCache()

   Subsystems/PCGSubsystem.h  

UPCGComponent * GetLocalComponent ( const FPCGGridDescriptor& GridDescriptor,
const FIntVector& CellCoords,
const UPCGComponent* InOriginalComponent
) const

 Retrieves a local component using grid descriptor and grid coordinates, returns nullptr if no such component is found. Subsystems/PCGSubsystem.h  

UPCGComponent * GetLocalComponent ( uint32 GridSize,
const FIntVector& CellCoords,
const UPCGComponent* InOriginalComponent,
bool bTransient
) const

   Subsystems/PCGSubsystem.h  

const FPCGNodeVisualLogs & GetNodeVisualLogs()

 Get graph warnings and errors for all nodes. Subsystems/PCGSubsystem.h  

FPCGNodeVisualLogs & GetNodeVisualLogsMutable()

   Subsystems/PCGSubsystem.h  

TSet< TObjectPtr< APCGPartitionActor > > GetPCGComponentPartitionActorMappings ( UPCGComponent* InComponent
) const

 Retrieves partition actors for this original component Subsystems/PCGSubsystem.h  

APCGWorldActor * GetPCGWorldActor()

   Subsystems/PCGSubsystem.h  

APCGPartitionActor * GetRegisteredPCGPartitionActor ( uint32 GridSize,
const FIntVector& GridCoords,
bool bRuntimeGenerated
) const

   Subsystems/PCGSubsystem.h  

APCGPartitionActor * GetRegisteredPCGPartitionActor ( const FPCGGridDescriptor& GridDescriptor,
const FIntVector& GridCoords
) const

 Retrieves a registered partition actor using grid size and grid coordinates, returns nullptr if no such partition actor is found. Subsystems/PCGSubsystem.h  

FPCGRuntimeGenScheduler * GetRuntimeGenScheduler()

   Subsystems/PCGSubsystem.h  

void LogAbnormalComponentStates ( bool bGroupByState
) const

   Subsystems/PCGSubsystem.h  

void NotifyLandscapeEditModeExited()

 Notify that we exited the Landscape edit mode. Subsystems/PCGSubsystem.h  

void NotifySelectionKeyChanged ( const FPCGSelectionKey& InSelectionKey,
const UObject* InOriginatingChangeObject,
TArrayView< const FBox > InBounds
)

 Notification that a Selection key needs refreshing Subsystems/PCGSubsystem.h  

void OnOriginalComponentRegistered ( UPCGComponent* InComponent
)

   Subsystems/PCGSubsystem.h  

void OnOriginalComponentUnregistered ( UPCGComponent* InComponent
)

   Subsystems/PCGSubsystem.h  

void OnPCGQualityLevelChanged()

   Subsystems/PCGSubsystem.h  

void PropagateEditingModeToLocalComponents ( UPCGComponent* InOriginalComponent,
EPCGEditorDirtyMode EditingMode
)

 Propagates transient state change from an original component to the relevant partition actors Subsystems/PCGSubsystem.h  

void RefreshAllComponentsFiltered ( const TFunction< bool(UPCGComponent*)>& ComponentFilter,
EPCGChangeType ChangeType
)

 Refresh all components selected by the filter (runtime generated or otherwise). Subsystems/PCGSubsystem.h  
Asks the runtime generation scheduler to refresh all GenerateAtRuntime components. Subsystems/PCGSubsystem.h  

void RefreshRuntimeGenComponent ( UPCGComponent* RuntimeComponent,
EPCGChangeType ChangeType
)

 Asks the runtime generation scheduler to refresh a given GenerateAtRuntime component. Subsystems/PCGSubsystem.h  

void RegisterBeginTickAction ( FTickAction&& Action
)

   Subsystems/PCGSubsystem.h  

bool RegisterOrUpdatePCGComponent ( UPCGComponent* InComponent,
bool bDoActorMapping
)

 Register a new PCG Component or update it, will be added to the octree if it doesn't exists yet. Subsystems/PCGSubsystem.h  
Register a new Partition actor, will be added to a map and will query all intersecting volume to bind to them if asked. Subsystems/PCGSubsystem.h  

void RegisterPCGWorldActor ( APCGWorldActor* InActor
)

   Subsystems/PCGSubsystem.h  

bool RemapPCGComponent ( const UPCGComponent* OldComponent,
UPCGComponent* NewComponent,
bool bDoActorMapping
)

 In case of BP Actors, we need to remap the old component destroyed by the construction script to the new one. Subsystems/PCGSubsystem.h  

bool RemoveAndCopyConstructionScriptSourceComponent ( AActor* InComponentOwner,
FName InComponentName,
UPCGComponent*& OutSourceComponent
)

   Subsystems/PCGSubsystem.h  

void ResetPartitionActorsMap()

 If the partition grid size change, call this to empty the Partition actors map Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleCleanup ( UPCGComponent* PCGComponent,
bool bRemoveComponents,
const TArray< FPCGTaskId >& Dependencies
)

 Schedule cleanup(owner->graph). Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleComponent ( UPCGComponent* PCGComponent,
EPCGHiGenGrid Grid,
bool bForce,
const TArray< FPCGTaskId >& InDependencies
)

 Schedule graph(owner->graph) Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGeneric ( TFunction< bool()> InOperation,
TFunction< void()> InAbortOperation,
UPCGComponent* SourceComponent,
const TArray< FPCGTaskId >& TaskExecutionDependencies
)

 General job scheduling Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGeneric ( TFunction< bool()> InOperation,
UPCGComponent* SourceComponent,
const TArray< FPCGTaskId >& TaskExecutionDependencies
)

 General job scheduling Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGeneric ( const FPCGScheduleGenericParams& InParams
)

 General job scheduling. Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGenericWithContext ( TFunction< bool(FPCGContext*)> InOperation,
TFunction< void(FPCGContext*)> InAbortOperation,
UPCGComponent* SourceComponent,
const TArray< FPCGTaskId >& TaskExecutionDependencies,
const TArray< FPCGTaskId >& TaskDataDependencies
)

 General job scheduling with context Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGenericWithContext ( TFunction< bool(FPCGContext*)> InOperation,
UPCGComponent* SourceComponent,
const TArray< FPCGTaskId >& TaskExecutionDependencies,
const TArray< FPCGTaskId >& TaskDataDependencies
)

 General job scheduling with context Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGraph ( UPCGGraph* Graph,
UPCGComponent* SourceComponent,
FPCGElementPtr PreGraphElement,
FPCGElementPtr InputElement,
const TArray< FPCGTaskId >& Dependencies,
const FPCGStack* InFromStack,
bool bAllowHierarchicalGeneration
)

   Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGraph ( const FPCGScheduleGraphParams& InParams
)

 Schedule graph (used internally for dynamic subgraph execution) Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleGraph ( UPCGComponent* SourceComponent,
const TArray< FPCGTaskId >& Dependencies
)

 Schedule graph (used internally for dynamic subgraph execution) Subsystems/PCGSubsystem.h  

FPCGTaskId ScheduleRefresh ( UPCGComponent* SourceComponent,
bool bForceRefresh
)

 Schedule refresh on the current or next frame Subsystems/PCGSubsystem.h  

void SetConstructionScriptSourceComponent ( UPCGComponent* InComponent
)

   Subsystems/PCGSubsystem.h  
Unregister a Partition actor, will be removed from the map and remove itself to all intersecting volumes. Subsystems/PCGSubsystem.h  

void UnregisterPCGComponent ( UPCGComponent* InComponent,
bool bForce
)

 Unregister a PCG Component, will be removed from the octree. Subsystems/PCGSubsystem.h  

void UnregisterPCGWorldActor ( APCGWorldActor* InActor
)

   Subsystems/PCGSubsystem.h  

void UpdateComponentTracking ( UPCGComponent* InComponent,
bool bShouldDirtyActors,
const TArray< FPCGSelectionKey >* OptionalChangedKeys
)

 Update the tracking on a given component. Subsystems/PCGSubsystem.h  

Overridden from UWorldSubsystem

Name Remarks Include Path Unreal Specifiers

virtual void PostInitialize()

   Subsystems/PCGSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   Subsystems/PCGSubsystem.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsTickableInEditor()

   Subsystems/PCGSubsystem.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   Subsystems/PCGSubsystem.h  

virtual ETickableTickType GetTickableTickType()

   Subsystems/PCGSubsystem.h  

virtual void Tick ( float DeltaSeconds
)

 Need UpdateStreamingState? Subsystems/PCGSubsystem.h  

Overridden from IPCGBaseSubsystem

Name Remarks Include Path Unreal Specifiers

virtual UWorld * GetSubsystemWorld()

   Subsystems/PCGSubsystem.h  

Protected

Overridden from IPCGBaseSubsystem

Name Remarks Include Path Unreal Specifiers

virtual void CancelGenerationInternal ( IPCGGraphExecutionSource* Source,
bool bCleanupUnusedResources
)

   Subsystems/PCGSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

 Add UObject references for GC Subsystems/PCGSubsystem.h  

static UPCGSubsystem * GetActiveEditorInstance()

 Returns PIE world if it is active, otherwise returns editor world. Subsystems/PCGSubsystem.h  

static UPCGSubsystem * GetInstance ( UWorld* World
)

 Will return the subsystem from the World if it exists and if it is initialized Subsystems/PCGSubsystem.h  

static int32 GetPCGQualityLevel()

 Returns current quality level between Low (0) and Cinematic (4). Subsystems/PCGSubsystem.h  

static UPCGSubsystem * GetSubsystemForCurrentWorld()

 To be used when a PCG component can not have a world anymore, to unregister itself. Subsystems/PCGSubsystem.h  

static bool IsPartitionActorCreationDisabledForWorld ( UWorld* InWorld
)

   Subsystems/PCGSubsystem.h  

static void SetDisablePartitionActorCreationForWorld ( UWorld* InWorld,
bool bDisable
)

 Used by UPCGWorldPartitonBuilder to disable PA creation while outside of a certain scope. Subsystems/PCGSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page