1. Epic GamesDeveloper
  3. UPCGSubsystem

UPCGSubsystem

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

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UPCGSubsystem : public UTickableWorldSubsystem

Remarks

UPCGSubsystem

Variables

  Type Name Description
Public variable friend UPCGActorAndComponentMapping  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddSerializedTrackedActorsForDeprecation ( const ActorContainer& InActors
)

 For deprecation only, register tracked actors from serialized components
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 FPCGTaskId

CleanupGraph ( UPCGComponent* Component,
const FBox& InBounds,
bool bRemoveComponents,
bool bSave
)

 Schedules an operation to cleanup the graph in the given bounds
Public function void

CleanupPartitionActors ( const FBox& InBounds
)

 Partition actors methods
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 void

DeletePartitionActors ( bool bOnlyDeleteUnused
)

  
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 APCGWorldActor *  
Public function void Flushes the graph cache completely, use only for debugging
Public function Const void Traverses the hierarchy associated with the given component and calls InFunc for each overlapping component.
Public function Const void

ForAllRegisteredLocalComponents ( UPCGComponent* OriginalComponent,
const TFunction< 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 TSet< UPCGComponent * >  
Public function Const uint32 Returns how many times InElement is present in the cache.
Public function Const const 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 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 APCGWorldActor *  
Public function Static UPCGSubsystem * To be used when a PCG component can not have a world anymore, to unregister itself.
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 void Propagate to the graph compiler graph changes
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 void If the partition grid size change, call this to empty the Partition actors map
Public function FPCGTaskId

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

 Schedule cleanup(owner->graph). Note that in non-partitioned mode, cleanup is immediate.
Public function FPCGTaskId

ScheduleComponent ( UPCGComponent* PCGComponent,
bool bSave,
const TArray< FPCGTaskId >& InDependencies
)

 Schedule graph (owner -> graph)
Public function FPCGTaskId

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

 General job scheduling
Public function FPCGTaskId

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

 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
)

 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

UnregisterPartitionActor ( APCGPartitionActor* InActor
)

 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 bInShouldDirtyActors
)

 Update the tracking on a given component.

Overridden from UWorldSubsystem

  Type Name Description
Public function Virtual void Called once all UWorldSubsystems have been initialized

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaSeconds
)

 Need UpdateStreamingState?

Enums

  Type Name Description
Private enum EOperation    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page