Navigation
API > API/Plugins > API/Plugins/PCG
Interface returned by a IPCGGraphExecutionSource that is queried / updated during execution of a PCG Graph.
| Name | IPCGGraphExecutionState |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/PCGGraphExecutionStateInterface.h |
| Include Path | #include "PCGGraphExecutionStateInterface.h" |
Syntax
class IPCGGraphExecutionState
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IPCGGraphExecutionState() |
PCGGraphExecutionStateInterface.h |
Structs
| Name | Remarks |
|---|---|
| FCleanupParams | |
| FGenerateParams |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Cancel() |
Cancel execution of this ExecutionState. | PCGGraphExecutionStateInterface.h | |
FPCGTaskId Cleanup () |
PCGGraphExecutionStateInterface.h | ||
FPCGTaskId Generate () |
PCGGraphExecutionStateInterface.h | ||
FBox GetBounds() |
Returns the ExecutionState bounds if the ExecutionState is a spatial one. | PCGGraphExecutionStateInterface.h | |
FString GetDebugName() |
Returns a Debug name that can be used for logging. | PCGGraphExecutionStateInterface.h | |
const PCGUtils::FExtraCapture & GetExtraCapture () |
Returns the FExtraCapture object for this ExecutionState | PCGGraphExecutionStateInterface.h | |
| PCGGraphExecutionStateInterface.h | |||
UPCGGraph * GetGraph() |
Returns the UPCGGraph this ExecutionState is executing. | PCGGraphExecutionStateInterface.h | |
UPCGGraphInstance * GetGraphInstance() |
Returns the UPCGGrahInstance this ExecutionState is executing. | PCGGraphExecutionStateInterface.h | |
| PCGGraphExecutionStateInterface.h | |||
const FPCGGraphExecutionInspection & GetInspection () |
Returns the FPCGGraphExecutionInspection object for this ExecutionState | PCGGraphExecutionStateInterface.h | |
IPCGGraphExecutionSource * GetOriginalSource() |
If this is a local execution source returns the original execution source, otherwise returns self. | PCGGraphExecutionStateInterface.h | |
int32 GetSeed() |
Returns a Seed for graph execution. | PCGGraphExecutionStateInterface.h | |
UPCGData * GetSelfData() |
Returns a UPCGData representation of the ExecutionState. | PCGGraphExecutionStateInterface.h | |
FTransform GetTransform() |
Returns a Transform if the ExecutionState is a spatial one. | PCGGraphExecutionStateInterface.h | |
TargetType * GetTypedTarget() |
PCGGraphExecutionStateInterface.h | ||
UWorld * GetWorld() |
Returns a World, can be null | PCGGraphExecutionStateInterface.h | |
bool HasAuthority() |
Returns true if the ExecutionState has network authority | PCGGraphExecutionStateInterface.h | |
bool IsGenerating() |
Indicates if the current source is generating. | PCGGraphExecutionStateInterface.h | |
bool IsRefreshInProgress() |
Indicates if the current source is waiting for a refresh | PCGGraphExecutionStateInterface.h | |
void OnGraphExecutionAborted
(
bool bQuiet, |
Notify ExecutionState that its execution is being aborted. | PCGGraphExecutionStateInterface.h | |
void RegisterDynamicTracking
(
const FPCGSelectionKeyToSettingsMap& InKeysToSettings |
Register multiple tracking dependencies, so ExecutionState can be updated when they change | PCGGraphExecutionStateInterface.h | |
void RegisterDynamicTracking
(
const UPCGSettings* InSettings, |
Register tracking dependencies, so ExecutionState can be updated when they change | PCGGraphExecutionStateInterface.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddLocalSourceCurrentTrackingKeys
(
const FPCGSelectionKeyToSettingsMap& LocalSourceCurrentExecutionTrackingKeys, |
Add current tracking keys from local source | PCGGraphExecutionStateInterface.h | |
virtual void AddLocalSourceDynamicTrackingKeys
(
const FPCGSelectionKeyToSettingsMap& LocalSourceDynamicTrackingKeys |
Add dynamic tracking keys from local source | PCGGraphExecutionStateInterface.h | |
virtual void AddToManagedResources
(
UPCGManagedResource* InResource |
PCGGraphExecutionStateInterface.h | ||
virtual FPCGTaskId Cleanup
(
const FCleanupParams& InCleanupParams |
Requests the execution source to clean up. | PCGGraphExecutionStateInterface.h | |
virtual void ExecutePreGraph
(
FPCGContext* InContext |
Cache any data that is not thread safe or that needs to be computed only once for the whole execution | PCGGraphExecutionStateInterface.h | |
virtual void ForEachSettingTrackingKey
(
const FPCGSelectionKey& InKey, |
Apply a function to all settings that track a given key. | PCGGraphExecutionStateInterface.h | |
virtual TArray< FPCGSelectionKey > GatherTrackingKeys() |
Returns the tracked keys | PCGGraphExecutionStateInterface.h | |
virtual FPCGTaskId Generate
(
const FGenerateParams& InGenerateParams |
Requests the execution source to generate. | PCGGraphExecutionStateInterface.h | |
virtual FPCGTaskId GenerateLocalGetTaskId
(
EPCGHiGenGrid Grid |
PCGGraphExecutionStateInterface.h | ||
virtual double GetCleanupRadiusFromGrid
(
uint32 InGrid |
Gets the radius outside of which this execution source will be cleaned up when using runtime generation. | PCGGraphExecutionStateInterface.h | |
virtual FPCGDynamicTrackingPriority GetDynamicTrackingPriority() |
Get an execution priority | PCGGraphExecutionStateInterface.h | |
virtual FBox GetGeneratedBounds() |
If this source is generated, returns the generated bounds | PCGGraphExecutionStateInterface.h | |
virtual FIntVector GetGenerationGridCoords() |
Get the grid cell coordinates this execution source executes on. | PCGGraphExecutionStateInterface.h | |
virtual uint32 GetGenerationGridSize() |
Get the size for the HiGen grid this execution source executes on. | PCGGraphExecutionStateInterface.h | |
virtual const FPCGRuntimeGenerationRadii & GetGenerationRadii() |
Gets the radii inside of which this execution source will be generated when using runtime generation. | PCGGraphExecutionStateInterface.h | |
virtual double GetGenerationRadiusFromGrid
(
uint32 InGrid |
Gets the radius inside of which this execution source will be generated when using runtime generation. | PCGGraphExecutionStateInterface.h | |
virtual FPCGTaskId GetGenerationTaskId() |
Gets the task ID for the current generation task if it exists. | PCGGraphExecutionStateInterface.h | |
virtual FPCGGridDescriptor GetGridDescriptor
(
uint32 InGridSize |
Returns a GridDescriptor based on this execution source for the specified grid size. | PCGGraphExecutionStateInterface.h | |
virtual IPCGGraphExecutionSource * GetLocalSource
(
const FPCGGridDescriptor& GridDescriptor, |
Retrieves a local execution source using grid descriptor and grid coordinates, returns nullptr if no such execution source is found. | PCGGraphExecutionStateInterface.h | |
virtual FBox GetLocalSpaceBounds() |
Returns the ExecutionState's local bounds if this ExecutionState is a spatial one. | PCGGraphExecutionStateInterface.h | |
virtual FPCGManagedResourceContainer * GetManagedResourceContainer() |
PCGGraphExecutionStateInterface.h | ||
virtual FTransactionallySafeCriticalSection * GetManagedResourceContainerLock() |
PCGGraphExecutionStateInterface.h | ||
virtual FBox GetOriginalBounds() |
Returns the ExecutionState's original source bounds if this ExecutionState is a local source. | PCGGraphExecutionStateInterface.h | |
virtual FBox GetOriginalLocalSpaceBounds() |
Returns the ExecutionState's original source local space bounds if this ExecutionState is a local source. | PCGGraphExecutionStateInterface.h | |
virtual FTransform GetOriginalTransform() |
Returns a the original source Transform if the ExecutionState is a local source. | PCGGraphExecutionStateInterface.h | |
virtual const UPCGSchedulingPolicyBase * GetRuntimeGenSchedulingPolicy() |
Gets the policy which dictates behavior when using runtime generation. | PCGGraphExecutionStateInterface.h | |
virtual const FPCGSourceDataContainer * GetSourceDataContainer () |
Get the immutable data container from the execution source. | PCGGraphExecutionStateInterface.h | |
virtual FPCGSourceDataContainer * GetSourceDataContainer () |
Get the data container from the execution source. | PCGGraphExecutionStateInterface.h | |
virtual IPCGBaseSubsystem * GetSubsystem () |
Returns the subsystem associated with this source. | PCGGraphExecutionStateInterface.h | |
virtual UObject * GetTarget() |
Returns the execution target for managed resources | PCGGraphExecutionStateInterface.h | |
virtual FBox GetTotalBounds() |
Returns the ExecutionState's generated bounds which includes the artifact bounds. | PCGGraphExecutionStateInterface.h | |
virtual bool IsActive() |
True if the ExecutionState is active. | PCGGraphExecutionStateInterface.h | |
virtual bool IsCacheEnabled() |
Whether this execution source uses the graph cache. | PCGGraphExecutionStateInterface.h | |
virtual bool IsGenerated() |
Indicates if the current source is generated | PCGGraphExecutionStateInterface.h | |
virtual bool IsInPreviewMode() |
Returns true if the generated artifacts are transient | PCGGraphExecutionStateInterface.h | |
virtual bool IsKeyTrackedAndCulled
(
const FPCGSelectionKey& Key, |
Return true if the key is tracked, and if so, bOutIsCulled will contains if the key is culled or not. | PCGGraphExecutionStateInterface.h | |
virtual bool IsLocalSource() |
Returns true if this execution source is a local source of a partitioned execution source. | PCGGraphExecutionStateInterface.h | |
virtual bool IsManagedByRuntimeGenSystem () |
@todo_pcg: The execution source should probably just have an execution domain instead of directly querying runtime gen vs etc. | PCGGraphExecutionStateInterface.h | |
virtual bool IsPartitioned() |
Returns true if this execution source uses partitioned generation. | PCGGraphExecutionStateInterface.h | |
virtual void OnManagedResourceAdded
(
UPCGManagedResource* InResource |
PCGGraphExecutionStateInterface.h | ||
virtual const FPCGDataCollection * RetrieveOutputDataForPin
(
const FString& InResourceKey |
Lookup data using a resource key that identifies the pin. | PCGGraphExecutionStateInterface.h | |
virtual void StoreOutputDataForPin
(
const FString& InResourceKey, |
Store data with a resource key that identifies the pin. | PCGGraphExecutionStateInterface.h | |
virtual bool Use2DGrid() |
Returns true if execution source should output on a 2D grid. | PCGGraphExecutionStateInterface.h | |
virtual bool UseTransactions() |
Whether this execution source will create scoped transaction around operations that impact the world/data. | PCGGraphExecutionStateInterface.h | |
virtual bool WasGeneratedThisSession() |
Whether this execution source has been generated at any point during this editor session. | PCGGraphExecutionStateInterface.h |