Navigation
API > API/Plugins > API/Plugins/PCG
| Name | FPCGComponentExecutionState |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/PCGComponent.h |
| Include Path | #include "PCGComponent.h" |
Syntax
class FPCGComponentExecutionState : public IPCGGraphExecutionState
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Component | UPCGComponent * | PCGComponent.h |
Functions
Public
Overridden from IPCGGraphExecutionState
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddToManagedResources
(
UPCGManagedResource* InResource |
PCGComponent.h | ||
virtual void Cancel() |
Cancel execution of this ExecutionState. | PCGComponent.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 | PCGComponent.h | |
virtual FPCGTaskId GenerateLocalGetTaskId
(
EPCGHiGenGrid Grid |
Requests the execution source to generate only on the specified grid level (all grid levels if EPCGHiGenGrid::Uninitialized). | PCGComponent.h | |
virtual FBox GetBounds() |
Returns the ExecutionState bounds if the ExecutionState is a spatial one. | PCGComponent.h | |
virtual FString GetDebugName() |
Returns a Debug name that can be used for logging. | PCGComponent.h | |
virtual FPCGDynamicTrackingPriority GetDynamicTrackingPriority() |
Get an execution priority | PCGComponent.h | |
virtual PCGUtils::FExtraCapture & GetExtraCapture () |
PCGComponent.h | ||
virtual const PCGUtils::FExtraCapture & GetExtraCapture () |
Returns the FExtraCapture object for this ExecutionState | PCGComponent.h | |
virtual uint32 GetGenerationGridSize() |
Get the size for the HiGen grid this execution source executes on. | PCGComponent.h | |
virtual FPCGTaskId GetGenerationTaskId() |
Gets the task ID for the current generation task if it exists. | PCGComponent.h | |
virtual UPCGGraph * GetGraph() |
Returns the UPCGGraph this ExecutionState is executing. | PCGComponent.h | |
virtual UPCGGraphInstance * GetGraphInstance() |
Returns the UPCGGrahInstance this ExecutionState is executing. | PCGComponent.h | |
virtual FPCGGridDescriptor GetGridDescriptor
(
uint32 InGridSize |
Returns a GridDescriptor based on this execution source for the specified grid size. | PCGComponent.h | |
virtual FPCGGraphExecutionInspection & GetInspection () |
PCGComponent.h | ||
virtual const FPCGGraphExecutionInspection & GetInspection () |
Returns the FPCGGraphExecutionInspection object for this ExecutionState | PCGComponent.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. | PCGComponent.h | |
virtual FBox GetLocalSpaceBounds() |
Returns the ExecutionState's local bounds if this ExecutionState is a spatial one. | PCGComponent.h | |
virtual FBox GetOriginalBounds() |
Returns the ExecutionState's original source bounds if this ExecutionState is a local source. | PCGComponent.h | |
virtual FBox GetOriginalLocalSpaceBounds() |
Returns the ExecutionState's original source local space bounds if this ExecutionState is a local source. | PCGComponent.h | |
virtual IPCGGraphExecutionSource * GetOriginalSource() |
If this is a local execution source returns the original execution source, otherwise returns self. | PCGComponent.h | |
virtual FTransform GetOriginalTransform() |
Returns a the original source Transform if the ExecutionState is a local source. | PCGComponent.h | |
virtual int32 GetSeed() |
Returns a Seed for graph execution. | PCGComponent.h | |
virtual UPCGData * GetSelfData() |
Returns a UPCGData representation of the ExecutionState. | PCGComponent.h | |
virtual FTransform GetTransform() |
Returns a Transform if the ExecutionState is a spatial one. | PCGComponent.h | |
virtual UWorld * GetWorld() |
Returns a World, can be null | PCGComponent.h | |
virtual bool HasAuthority() |
Returns true if the ExecutionState has network authority | PCGComponent.h | |
virtual bool IsGenerating() |
Indicates if the current source is generating. | PCGComponent.h | |
virtual bool IsLocalSource() |
Returns true if this execution source is a local source of a partitioned execution source. | PCGComponent.h | |
virtual bool IsManagedByRuntimeGenSystem () |
@todo_pcg: The execution source should probably just have an execution domain instead of directly querying runtime gen vs etc. | PCGComponent.h | |
virtual bool IsPartitioned() |
Returns true if this execution source uses partitioned generation. | PCGComponent.h | |
virtual bool IsRefreshInProgress() |
Indicates if the current source is waiting for a refresh | PCGComponent.h | |
virtual void OnGraphExecutionAborted
(
bool bQuiet, |
Notify ExecutionState that its execution is being aborted. | PCGComponent.h | |
virtual void RegisterDynamicTracking
(
const FPCGSelectionKeyToSettingsMap& InKeysToSettings |
Register multiple tracking dependencies, so ExecutionState can be updated when they change | PCGComponent.h | |
virtual void RegisterDynamicTracking
(
const UPCGSettings* InSettings, |
Register tracking dependencies, so ExecutionState can be updated when they change | PCGComponent.h | |
virtual const FPCGDataCollection * RetrieveOutputDataForPin
(
const FString& InResourceKey |
Lookup data using a resource key that identifies the pin. | PCGComponent.h | |
virtual void StoreOutputDataForPin
(
const FString& InResourceKey, |
Store data with a resource key that identifies the pin. | PCGComponent.h | |
virtual bool Use2DGrid() |
Returns true if execution source should output on a 2D grid. | PCGComponent.h |