1. Epic GamesDeveloper
  3. UPCGSubsystem

UPCGSubsystem

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

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

  • UTickableWorldSubsystem
  • UPCGSubsystem

References

   
Module PCG
Header /Engine/Plugins/PCG/Source/PCG/Public/PCGSubsystem.h
Include #include "PCGSubsystem.h"

Syntax

UCLASS ()  
class UPCGSubsystem : public UTickableWorldSubsystem

Remarks

UPCGSubsystem

Variables

  Type Name Description
Public variable friend FPCGActorAndComponentMapping  
Public variable FPCGOnComponentGenerationCompleteOrCancelled OnComponentGenerationCompleteOrCancelled  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

BuildLandscapeCache ( bool bQuiet
)

 Builds the landscape data cache
Public function void Cancels everything running
Public function void Cancels currently running generation on given graph
Public function void Cancels currently running generation
Public function void

CleanFromCache ( const IPCGElement* InElement,
const UPCGSettings* InSettings
)

 Cleans up the graph cache on an element basis. InSettings is used for debugging and is optional.
Public function void

CleanupLocalComponentsImmediate ( UPCGComponent* InOriginalComponent,
bool bRemoveComponents
)

 Immediately cleanup the local components associated with an original component.
Public function void

ClearExecutedStacks ( const UPCGGraph* InContainingGraph
)

  
Public function void

ClearExecutedStacks ( FPCGStack BeginningWithStack
)

  
Public function void  
Public function void

ClearExecutionMetadata ( const FPCGStack& BaseStack
)

 Clear any data collected during execution, normally called prior to generating the component.
Public function void Clears the landscape data cache
Public function void

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

 Move all resources from sub actors to a new actor
Public function Virtual void  
Public function void

DeleteSerializedPartitionActors ( bool bOnlyDeleteUnused,
bool bOnlyChildren
)

 Delete serialized partition actors in the level.
Public function void  
Public function void  
Public function void
DirtyGraph

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

 Immediately dirties the partition actors in the given bounds
Public function Const APCGPartitionActor *

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

 Creates a new partition actor if one does not already exist with the same grid size, coords, and generation mode.
Public function APCGWorldActor *  
Public function void Flushes the graph cache completely, use only for debugging
Public function Const void

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

 Get all components in specified bounds.
Public function Const FPCGTaskId

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

 Call InFunc to all partition grid cells matching 'InGridSizes' and overlapping with 'InBounds'.
Public function Const void Traverses the hierarchy associated with the given component and calls InFunc for each overlapping component.
Public function Const void

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

 Call the InFunc function to all local component registered to the original component within some bounds.
Public function Const void

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

 Call the InFunc function to all local component registered to the original component. Thread safe
Public function Static UPCGSubsystem * Returns PIE world if it is active, otherwise returns editor world.
Public function Const TArray< UPCGComponent * >

GetAllIntersectingComponents ( const FBoxCenterAndExtent& InBounds
)

 Gather all the PCG components within some bounds.
Public function Const TSet< UPCGComponent * >  
Public function Const TSet< UPCGComponent * >  
Public function TArray< FPCGStack >

GetExecutedStacks ( const UPCGComponent* InComponent,
const UPCGGraph* InSubgraph
)

 Get a list of stacks that were executed during the last execution.
Public function Const FPCGGenSourceManager *  
Public function Const uint32 Returns how many times InElement is present in the cache.
Public function FPCGGraphCompiler * Returns the graph compiler so we can figure out task info in the profiler view
Public function Static UPCGSubsystem *

GetInstance ( UWorld* World
)

 Will return the subsystem from the World if it exists and if it is initialized
Public function UPCGLandscapeCache *  
Public function Const UPCGComponent *

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

 Retrieves a local component using grid size and grid coordinates, returns nullptr if no such component found.
Public function Const const FPCGNodeVisualLogs & Get graph warnings and errors for all nodes.
Public function FPCGNodeVisualLogs &  
Public function bool Gets the output data for a given task
Public function Static int32 Returns current quality level between Low (0) and Cinematic (4).
Public function APCGWorldActor *  
Public function Const APCGPartitionActor *

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

 Retrieves a registered partition actor using grid size and grid coordinates, returns nullptr if no such partition actor is found.
Public function bool

GetStackContext ( const UPCGComponent* InComponent,
FPCGStackContext& OutStackContext
)

 Get the execution stack information for the given component.
Public function Virtual Const TStatId  
Public function Static UPCGSubsystem * To be used when a PCG component can not have a world anymore, to unregister itself.
Public function Virtual Const ETickableTickType  
Public function Const bool Returns true if any task is scheduled or executing for any graph
Public function Const bool True if graph cache debugging is enabled.
Public function bool Returns true if there are any tasks for this graph currently scheduled or executing.
Public function Const bool Subsystem must not be used without this condition being true.
Public function Virtual Const bool  
Public function Const void

LogAbnormalComponentStates ( bool bGroupByState
)

  
Public function void

NotifyGraphChanged ( UPCGGraph* InGraph,
EPCGChangeType ChangeType
)

 Propagate to the graph compiler graph changes
Public function void Notify that we exited the Landscape edit mode.
Public function void  
Public function void  
Public function void  
Public function void

OnScheduleGraph ( const FPCGStackContext& StackContext
)

 Called by graph executor when a graph is scheduled.
Public function Virtual void  
Public function void Propagates transient state change from an original component to the relevant partition actors
Public function void

RefreshRuntimeGenComponent ( UPCGComponent* RuntimeComponent,
EPCGChangeType ChangeType
)

 Asks the runtime generation scheduler to refresh a given GenerateAtRuntime component.
Public function 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.
Public function void

RegisterPartitionActor ( APCGPartitionActor* InActor,
bool bDoComponentMapping
)

 Register a new Partition actor, will be added to a map and will query all intersecting volume to bind to them if asked.
Public function void  
Public function 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.
Public function bool

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

  
Public function void If the partition grid size change, call this to empty the Partition actors map
Public function FPCGTaskId

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

 Schedule cleanup(owner->graph).
Public function FPCGTaskId

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

 Schedule graph(owner->graph)
Public function FPCGTaskId

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

 General job scheduling
Public function FPCGTaskId

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

 General job scheduling
Public function 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
Public function FPCGTaskId

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

 General job scheduling with context
Public function FPCGTaskId

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

 Schedule graph (used internally for dynamic subgraph execution)
Public function FPCGTaskId

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

 Schedule graph (used internally for dynamic subgraph execution)
Public function FPCGTaskId

ScheduleRefresh ( UPCGComponent* SourceComponent,
bool bForceRefresh
)

 Schedule refresh on the current or next frame
Public function void  
Public function Virtual void

Tick ( float DeltaSeconds
)

 Need UpdateStreamingState?
Public function void Unregister a Partition actor, will be removed from the map and remove itself to all intersecting volumes.
Public function void

UnregisterPCGComponent ( UPCGComponent* InComponent,
bool bForce
)

 Unregister a PCG Component, will be removed from the octree.
Public function void  
Public function void

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

 Update the tracking on a given component.

Enums

  Type Name Description
Private enum EOperation    

Typedefs

Name Description
FConstructionScriptSourceComponents  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page