1. Epic GamesDeveloper
  3. IPCGElement

IPCGElement

Base class for the processing bit of a PCG node/settings

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

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

Syntax

class IPCGElement

Remarks

Base class for the processing bit of a PCG node/settings

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

Abort ( FPCGContext* Context
)

 Public function called when an element is cancelled, passing its current context if any.
Protected function Virtual Const void

AbortInternal ( FPCGContext* Context
)

 This function will be called once and only once if the element is aborted.
Public function Virtual Const bool Returns true if the element, in its current phase can be executed only from the main thread
Protected function Virtual FPCGContext * Let each element optionally act as a concrete factory for its own context
Public function Const void

DebugDisplay ( FPCGContext* Context
)

 Note: must be called from the main thread.
Protected function Virtual Const void Passes through data when the element is Disabled.
Public function Const bool

Execute ( FPCGContext* Context
)

 Public function that executes the element on the appropriately created context.
Protected function Const bool Core execution method for the given element. Will be called until it returns true.
Protected function Virtual Const EPCGElementExecutionLoopMode

ExecutionLoopMode ( const UPCGSettings* Settings
)

 Describes internal execution behavior, which is used to break down inputs/outputs for caching purposes.
Public function Virtual Const void

GetDependenciesCrc ( const FPCGDataCollection& InInput,
const UPCGSettings* InSettings,
UPCGComponent* InComponent,
FPCGCrc& OutCrc
)

 Calculate a Crc that provides a receipt for the input data that can be paired with output data from the cache.
Public function Virtual FPCGContext *

Initialize ( const FPCGDataCollection& InputData,
TWeakObjectPtr< UPCGComponent > SourceComponent,
const UPCGNode* Node
)

 Creates a custom context object paired to this element
Public function Virtual Const bool

IsCacheable ( const UPCGSettings* InSettings
)

 Returns true if the node can be cached (e.g. does not create artifacts & does not depend on untracked data
Public function Const bool

IsCacheableInstance ( const UPCGSettingsInterface* InSettingsInterface
)

 Returns true if the node can be cached - also checks for instance flags, if any.
Protected function Virtual Const bool Controls whether an element can skip its execution wholly when the input data has the cancelled tag
Public function Virtual Const bool Is this element used for dispatching compute graphs.
Public function Virtual Const bool Is this element used for marshaling data across higen grids.
Protected function Virtual Const bool

IsPassthrough ( const UPCGSettings* InSettings
)

 Used to specify that the element passes through the data without any manipulation - used to correct target pins, etc.
Protected function Const void

PostExecute ( FPCGContext* Context
)

 This function will be called once and once only, at the end of an execution
Protected function Virtual Const void Core post execute method for the given element.
Protected function Virtual Const void Implements output breakdown for caching purposes, if the ExecutionLoopMode is set to something else than not a loop.
Protected function Const void

PreExecute ( FPCGContext* Context
)

 This function will be called once and once only, at the beginning of an execution
Protected function Virtual Const void

PreExecutePrimaryLoopElement ( FPCGContext* Context,
const UPCGSettings* Settings
)

 Implements input breakdown for caching purposes, if the ExecutionLoopMode is set to something else than not a loop.
Protected function Virtual Const bool The prepare data phase is one where it is more likely to be able to multithread
Public function Const EPCGCachingStatus

RetrieveResultsFromCache ( IPCGGraphCache* Cache,
const UPCGNode* Node,
const FPCGDataCollection& Input,
UPCGComponent* Component,
FPCGDataCollection& Output,
FPCGCrc* OutCrc
)

 Gather input data (pre-context creation) and tries to retrieve matching data from the cache if the element is cacheable.
Public function Virtual Const bool Whether to do a 'deep' fine-grained CRC of the output data to pass to downstream nodes.
Protected function Virtual Const bool  
Public function Virtual Const bool Returns true if the node outputs requires to update the output tagged data to detect if the data is used multiple times.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page