IPCGBaseSubsystem

API > API/Plugins > API/Plugins/PCG

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

Syntax

class IPCGBaseSubsystem

Derived Classes

Structs

Name Remarks
FGraphExecution  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CancelAllGeneration()

 Cancels everything running Subsystems/IPCGBaseSubsystem.h  

void CancelGeneration ( UPCGGraph* Graph
)

 Cancels currently running generation on given graph Subsystems/IPCGBaseSubsystem.h  
Cancels currently running generation Subsystems/IPCGBaseSubsystem.h  

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. Subsystems/IPCGBaseSubsystem.h  

void ClearOutputData ( FPCGTaskId InTaskId
)

 Clears the output data for a given task. Subsystems/IPCGBaseSubsystem.h  

void DeinitializeBaseSubsystem()

   Subsystems/IPCGBaseSubsystem.h  

void FlushCache()

 Flushes the graph cache and graph compiler cache, and in editor trigger a GC. Subsystems/IPCGBaseSubsystem.h  

IPCGGraphCache * GetCache()

 Returns the interface to the cache, required for element per-data caching Subsystems/IPCGBaseSubsystem.h  

UPCGComputeGraph * GetComputeGraph ( const UPCGGraph* InGraph,
uint32 GridSize,
uint32 ComputeGraphIndex
)

   Subsystems/IPCGBaseSubsystem.h  

uint32 GetGraphCacheEntryCount ( IPCGElement* InElement
) const

 Returns how many times InElement is present in the cache. Subsystems/IPCGBaseSubsystem.h  

FPCGGraphCompiler * GetGraphCompiler()

   Subsystems/IPCGBaseSubsystem.h  

FPCGOnPCGSourceGenerationDone & GetOnPCGSourceGenerationDone()

   Subsystems/IPCGBaseSubsystem.h  

FPCGOnPCGSourceUnregistered & GetOnPCGSourceUnregistered()

   Subsystems/IPCGBaseSubsystem.h  

bool GetOutputData ( FPCGTaskId InTaskId,
FPCGDataCollection& OutData
)

 Gets the output data for a given task Subsystems/IPCGBaseSubsystem.h  

bool GetStackContext ( UPCGGraph* InGraph,
uint32 GridSize,
bool bIsPartitioned,
FPCGStackContext& OutStackContext
)

 Gets the base execution stack information for a specific graph & grid size. Subsystems/IPCGBaseSubsystem.h  

bool GetStackContext ( const IPCGGraphExecutionSource* InSource,
FPCGStackContext& OutStackContext
)

 Gets the execution stack information for the given component (depending on partitioning, grid size, etc.) but with no component frames. Subsystems/IPCGBaseSubsystem.h  

void InitializeBaseSubsystem()

   Subsystems/IPCGBaseSubsystem.h  

bool IsAnyGraphCurrentlyExecuting()

 Returns true if any task is scheduled or executing for any graph Subsystems/IPCGBaseSubsystem.h  

bool IsGraphCacheDebuggingEnabled()

 True if graph cache debugging is enabled. Subsystems/IPCGBaseSubsystem.h  

bool IsGraphCurrentlyExecuting ( UPCGGraph* Graph
)

 Returns true if there are any tasks for this graph currently scheduled or executing. Subsystems/IPCGBaseSubsystem.h  

void OnScheduleGraph ( const FPCGStackContext& StackContext
)

 Subsystem must not be used without this condition being true. Subsystems/IPCGBaseSubsystem.h  

FPCGTaskId ScheduleGeneric ( const FPCGScheduleGenericParams& InParams
)

 General job scheduling. Subsystems/IPCGBaseSubsystem.h  

FPCGTaskId ScheduleGraph ( const FPCGScheduleGraphParams& InParams
)

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

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual UWorld * GetSubsystemWorld()

   Subsystems/IPCGBaseSubsystem.h  

virtual void NotifyGraphChanged ( UPCGGraph* InGraph,
EPCGChangeType ChangeType
)

 Propagate to the graph compiler graph changes Subsystems/IPCGBaseSubsystem.h  

virtual void OnPCGSourceGenerationDone ( IPCGGraphExecutionSource* InExecutionSource,
EPCGGenerationStatus InStatus
)

   Subsystems/IPCGBaseSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

   Subsystems/IPCGBaseSubsystem.h  

void CancelGeneration ( IPCGGraphExecutionSource* Source,
bool bCleanupUnusedResources
)

   Subsystems/IPCGBaseSubsystem.h  

FPCGPerExecutionCache * GetCacheInternal()

   Subsystems/IPCGBaseSubsystem.h  

void SetDisableClearResults ( bool bInDisableClearResults
)

   Subsystems/IPCGBaseSubsystem.h  

double Tick()

 Tick the graph executor. Return expected end time. Subsystems/IPCGBaseSubsystem.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void CancelGenerationInternal ( IPCGGraphExecutionSource* Source,
bool bCleanupUnusedResources
)

   Subsystems/IPCGBaseSubsystem.h  

virtual double GetTickEndTime ()

 Returns the expected end time of the tick. Subsystems/IPCGBaseSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static SourceType * CreateExecutionSource ( const typename SourceType::ParamsType& InParams,
UObject* Outer
)

 Creates an execution source from the params and optionally tracks its lifetime and generation. Subsystems/IPCGBaseSubsystem.h  

static TOptional< typename T::ValueType > GetExecutionCacheEntry ( const IPCGGraphExecutionSource* InSource,
TPCGPerExecutionCacheId< T > InCacheId
)

 Returns the cached value if the entry exists for the given source's task, unset otherwise. Subsystems/IPCGBaseSubsystem.h  

static T::ValueType GetOrCreateExecutionCacheValue ( const IPCGGraphExecutionSource* InSource,
TPCGPerExecutionCacheId< T > InCacheId,
const FuncType& InMakeEntry,
bool bValidateWritable
)

 Returns the cached value if present, otherwise calls InMakeEntry() to produce one. Subsystems/IPCGBaseSubsystem.h  

static void SetExecutionCacheEntry ( const IPCGGraphExecutionSource* InSource,
TPCGPerExecutionCacheId< T > InCacheId,
typename T::ValueType InValue,
bool bValidateWritable
)

 Stores a new value for the given source's task and typed ID. Subsystems/IPCGBaseSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page