1. Epic GamesDeveloper
  3. FPCGDataCollection

FPCGDataCollection

API > API/Plugins > API/Plugins/PCG

   
Name FPCGDataCollection
Type struct
Header File /Engine/Plugins/PCG/Source/PCG/Public/PCGData.h
Include Path #include "PCGData.h"

Syntax

USTRUCT (BlueprintType )  
struct FPCGDataCollection

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCancelExecution bool This flag is used to cancel further computation or for the debug/isolate feature PCGData.h  
bCancelExecutionOnEmpty bool Deprecated - Will be removed in 5.4 PCGData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Data
DataCrcs TArray< FPCGCrc > Per-data CRC which will capture tags, data, output pin and in some cases input pin too. PCGData.h  
InactiveOutputPinBitmask uint64 After the task is complete, bit j is set if output pin index j is deactivated. PCGData.h  
TaggedData TArray< FPCGTaggedData >   PCGData.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Data

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddData ( const FPCGTaggedData& InData,
const FPCGCrc& InDataCrc
)

 Add data and CRC to collection. PCGData.h  

void AddData ( const TConstArrayView< FPCGTaggedData >& InData,
const TConstArrayView< FPCGCrc >& InDataCrcs
)

 Add data and CRCs to collection. PCGData.h  

void AddDataForPin ( const TConstArrayView< FPCGTaggedData >& InData,
const TConstArrayView< FPCGCrc >& InDataCrcs,
uint32 InputPinLabelCrc
)

 Add data and CRCs to collection with pin label combined into the CRC. PCGData.h  

void AddReferences ( FReferenceCollector& Collector
)

   PCGData.h  

void ClearUsage ( EPCGDataUsage InUsage
) const

   PCGData.h  

void ComputeCrcs ( bool bFullDataCrc
)

 Computes CRCs for all data items. PCGData.h  

const TArray< FPCGTaggedData > & GetAllInputs()

 Returns all inputs in the collection. PCGData.h  

TArray< FPCGTaggedData > GetAllParams()

 Returns all params in the collection PCGData.h  

TArray< FPCGTaggedData > GetAllSettings()

 Returns all settings in the collection PCGData.h  

TArray< FPCGTaggedData > GetAllSpatialInputs()

 Returns all spatial data in the collection. PCGData.h  

UPCGParamData * GetFirstParamsOnParamsPin()

 Returns the first/only param found on the default params pin PCGData.h  

int32 GetInputCountByPin ( const FName& InPinLabel
) const

 Gets number of data items on a given pin PCGData.h  

TArray< FPCGTaggedData > GetInputs()

 Returns all spatial data in the collection PCGData.h  

void GetInputsAndCrcsByPin ( const FName& InPinLabel,
TArray< FPCGTaggedData, AllocatorType1 >& OutData,
TArray< FPCGCrc, AllocatorType2 >& OutDataCrcs
) const

 Returns all data and corresponding cached data CRCs for a given pin. PCGData.h  

TArray< FPCGTaggedData > GetInputsByPin ( const FName& InPinLabel
) const

 Returns all data on a given pin. PCGData.h  

TArray< FPCGTaggedData > GetParamsByPin ( const FName& InPinLabel
) const

 Returns all params on a given pin PCGData.h  
Only used as a temporary solution for old graph with nodes that didn't have params pins. PCGData.h  

void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
) const

 Memory size calculation. Forward call to the data objects in the collection. PCGData.h  

const UPCGSettings * GetSettings ( const UPCGSettings* InDefaultSettings
) const

   PCGData.h  

const SettingsType * GetSettings ()

   PCGData.h  

const UPCGSettingsInterface * GetSettingsInterface ( const UPCGSettingsInterface* InDefaultSettingsInterface
) const

   PCGData.h  
  PCGData.h  

int32 GetSpatialInputCountByPin ( const FName& InPinLabel
) const

 Gets number of spatial data items on a given pin PCGData.h  

TArray< FPCGTaggedData > GetSpatialInputsByPin ( const FName& InPinLabel
) const

 Returns all spatial data on a given pin PCGData.h  

const UPCGSpatialData * GetSpatialUnionOfInputsByPin ( const FName& InPinLabel,
bool& bOutUnionDataCreated
) const

   PCGData.h  

const UPCGSpatialData * GetSpatialUnionOfInputsByPin ( FPCGContext* InContext,
const FName& InPinLabel,
bool& bOutUnionDataCreated
) const

 Returns spatial union of all data on a given pin, returns null if no such data exists. PCGData.h  

TArray< FPCGTaggedData > GetTaggedInputs ( const FString& InTag
) const

 Returns all spatial data in the collection with the given tag PCGData.h  

TArray< FPCGTaggedData > GetTaggedParams ( const FString& InTag
) const

 Returns all params in the collection with a given tag PCGData.h  

TArray< FPCGTaggedData > GetTaggedTypedInputs ( const FString& InTag
) const

 Returns all data in the collection with the given tag and given type PCGData.h  

bool HasUsage ( EPCGDataUsage InUsage
) const

   PCGData.h  

void MarkUsage ( EPCGDataUsage InUsage
) const

   PCGData.h  

void Reset()

 Cleans up the collection, but does not unroot any previously rooted data. PCGData.h  

int32 StripEmptyPointData()

 Strips all empty point data from the collection. PCGData.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FPCGDataCollection& Other
) const

   PCGData.h  

FPCGDataCollection & operator+= ( const FPCGDataCollection& Other
)

   PCGData.h  

bool operator== ( const FPCGDataCollection& Other
) const

   PCGData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page