1. Epic GamesDeveloper
  3. Helpers

Helpers

API > API/Plugins > API/Plugins/PCG

Filters

Classes

  Type Name Description
Public struct FExtractorParameters    
Public struct FParseTagResult    
Public struct FPCGAsyncState Helper class to gather information about asynchronus execution. Will be held in the PCGContext.  
Public struct FPCGCopyAttributeParams    
Public class FPCGDataPartitionBase Convenience class to do data partitioning, i.e. building a TMap> Uses CRTP to remove the need for virtual calls.  
Public struct FPCGDynamicTrackingHelper Simple helper class to factorize the logic for gathering dynamic tracking keys and pushing them to the component.  
Public struct FPCGGetAllOverridableParamsConfig    
Public class FPCGGraphParameterExtension Extension helper class to allow templatization without dirtying the PCGGraph.h file  
Public struct FPCGISMComponentBuilderParams    
Public struct FPCGSplineMeshComponentBuilderParameters    
Public class FPCGSubgraphHelpers    
Public class TFunction    
Public class UClass BlueprintType UPCGActorHelpers    
Public class UClass UPCGBlueprintHelpers    
Public class UClass MinimalAPI UPCGFunctionPrototypes Holds function prototypes used to match against actor function signatures.  
Public class UClass UPCGGraphParametersHelpers Blueprint Library to get or set graph parameters on graphs and graph instances  

Enums

  Type Name Description
Public enum UEnum EPCGWorldRaycastMode    

Functions

  Type Name Description
Public function bool

FPCGAsync::AsyncProcessing ( FPCGAsyncState* AsyncState,
int32 NumIterations,
TArray< OutputType, AllocatorType >& OutData,
Func&& InFunc,
const bool bEnableTimeSlicing,
const int32 ChunkSize,
bool bAllowChunkSizeOverride
)

 Helper for generic parallel loops, with support for timeslicing.
Public function bool

FPCGAsync::AsyncProcessingEx ( FPCGAsyncState* AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
ProcessElementFunc&& ProcessElement,
MoveFunc&& MoveData,
FinishedFunc&& Finished,
const bool bEnableTimeSlicing,
const int32 ChunkSize,
const bool bAllowChunkSizeOverride
)

 A Helper for generic parallel loops, with support for timeslicing.
Public function bool

FPCGAsync::AsyncProcessingOneToOneEx ( FPCGAsyncState* AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
ProcessElementFunc&& ProcessElement,
const bool bEnableTimeSlicing,
const int32 ChunkSize,
const bool bAllowChunkSizeOverride
)

 A Helper for generic parallel loops, with support for timeslicing.
Public function bool

FPCGAsync::AsyncProcessingOneToOneRangeEx ( FPCGAsyncState* AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
ProcessRangeFunc&& ProcessRange,
const bool bEnableTimeSlicing,
const int32 ChunkSize,
const bool bAllowChunkSizeOverride
)

 A Helper for generic parallel loops, with support for timeslicing, specialized to work on ranges.
Public function bool

FPCGAsync::AsyncProcessingRangeEx ( FPCGAsyncState* AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
ProcessRangeFunc&& ProcessRange,
MoveDataRangeFunc&& MoveDataRange,
FinishedFunc&& Finished,
const bool bEnableTimeSlicing,
const int32 ChunkSize,
const bool bAllowChunkSizeOverride
)

 A Helper for generic parallel loops, with support for timeslicing, specialized to work on ranges.
Public function bool

FPCGAsync::Private::AsyncProcessing ( FPCGAsyncState& AsyncState,
int32 NumIterations,
InitializeFunc&& Initialize,
InnerLoopFunc&& IterationInnerLoop,
MoveDataRangeFunc&& MoveDataRange,
FinishedFunc&& Finished,
const bool bInEnableTimeSlicing,
const int32 InChunkSize,
const bool bAllowChunkSizeOverride
)

  
Public function uint32

GetTypeHash ( const FPCGISMCBuilderParameters& Key
)

  
Public function Const bool

operator== ( const FPCGISMCBuilderParameters& Other
)

  
Public function void

PCGHelpers::ExecuteOnGameThread ( const TCHAR* DebugName,
FunctorType&& Functor
)

  
Public function void

PCGHelpers::ShiftArrayElements ( TArrayView< T > Array,
int32 NumShifts
)

 Shifts the elements of an array a number of times.
Public function void

PCGHelpers::ShuffleArray ( FRandomStream& RandomStream,
TArray< T >& Array
)

 Shuffles the elements of an array randomly and uniformly.
Public function TArray< T >

PCGPropertyHelpers::ExtractAttributeSetAsArrayOfStructs ( const UPCGParamData* InParamData,
const TMap< FName, TTuple< FName, bool > >* OptionalNameMapping,
FPCGContext* OptionalContext
)

 Extract an attribute set in a array of structures.
Public function UPCGParamData *

PCGPropertyHelpers::ExtractPropertyAsAttributeSet ( const FExtractorParameters& Parameters,
FPCGContext* OptionalContext,
TSet< FSoftObjectPath >* OptionalObjectTraversed,
bool bQuiet
)

 Extract a given property in an Attribute Set.
Public function EPCGMetadataTypes

PCGPropertyHelpers::GetMetadataTypeFromProperty ( const FProperty* InProperty
)

 Conversion between property type and PCG type.
Public function decltype(auto)

PCGPropertyHelpers::GetPropertyValueWithCallback ( const ObjectType* InObject,
const FProperty* InProperty,
Func InFunc
)

 PCGPropertyHelpers Implementation.
Public function bool

PCGPropertyHelpers::SetPropertyValueFromCallback ( ObjectType* InObject,
const FProperty* InProperty,
Func InFunc
)

 Set a property value given by a callback function.
Public function const UPCGSpatialData *

PCGSettingsHelpers::ComputeBoundingShape ( FPCGContext* Context,
FName BoundingShapeLabel,
bool& bOutUnionWasCreated
)

  
Public function bool

PCGSettingsHelpers::GetOverrideValue ( const FPCGDataCollection& InInputData,
const UPCGSettings* InSettings,
const FName InPropertyName,
const T& InDefaultValue,
T& OutValue
)

 Advanced method to gather override params when you don't have access to FPCGContext (and therefore don't have access to automatic param override).

Variables

  Type Name Description
Public variable bool bAllowDescriptorChanges  
Public variable TAutoConsoleVariable< float > CVarAsyncOutOfTickBudgetInMilliseconds  
Public variable TAutoConsoleVariable< int32 > CVarAsyncOverrideChunkSize  
Public variable TAutoConsoleVariable< bool > CVarDisableAsyncTimeSlicing  
Public variable TAutoConsoleVariable< bool > CVarDisableAsyncTimeSlicingOnGameThread  
Public variable const FName DefaultPCGActorTag  
Public variable const FName DefaultPCGDebugTag  
Public variable const FName DefaultPCGTag Tag that will be added on every component generated through the PCG system
Public variable const FName ElementIndexAttribute  
Public variable const FName FaceIndexAttribute  
Public variable const FName ImpactAttribute  
Public variable const FName ImpactDistanceAttribute  
Public variable const FName ImpactNormalAttribute  
Public variable const FName ImpactPointAttribute  
Public variable const FName ImpactReflectionAttribute  
Public variable const FName LocalImpactPointAttribute  
Public variable const FName MarkedForCleanupPCGTag  
Public variable int32 NumCustomDataFloats  
Public variable const FName PhysicalMaterialReferenceAttribute  
Public variable const FName RenderMaterialReferenceAttribute  
Public variable const FName StaticMeshReferenceAttribute  
Public variable const FName UVCoordAttribute  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page