1. Epic GamesDeveloper
  3. FPCGDataCollection

FPCGDataCollection

API > API/Plugins > API/Plugins/PCG

References

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

Syntax

USTRUCT (BlueprintType )  
struct FPCGDataCollection

Variables

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

Functions

  Type Name Description
Public function void

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

 Add data and CRC to collection.
Public function void

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

 Add data and CRCs to collection.
Public function 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.
Public function void

AddReferences ( FReferenceCollector& Collector
)

  
Public function void

ComputeCrcs ( bool bFullDataCrc
)

 Computes CRCs for all data items.
Public function Const TArray< FPCGTaggedData > Returns all params in the collection
Public function Const TArray< FPCGTaggedData > Returns all settings in the collection
Public function Const UPCGParamData * Returns the first/only param found on the default params pin
Public function Const int32

GetInputCountByPin ( const FName& InPinLabel
)

 Gets number of data items on a given pin
Public function Const TArray< FPCGTaggedData > Returns all spatial data in the collection
Public function Const void

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

 Returns all data and corresponding cached data CRCs for a given pin.
Public function Const TArray< FPCGTaggedData >

GetInputsByPin ( const FName& InPinLabel
)

 Returns all data on a given pin.
Public function Const TArray< FPCGTaggedData >

GetParamsByPin ( const FName& InPinLabel
)

 Returns all params on a given pin
Public function Const UPCGParamData * Only used as a temporary solution for old graph with nodes that didn't have params pins.
Public function Const void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Memory size calculation. Forward call to the data objects in the collection.
Public function Const const UPCGSettings *

GetSettings ( const UPCGSettings* InDefaultSettings
)

  
Public function Const const SettingsType *  
Public function Const const UPCGSettingsInterface *

GetSettingsInterface ( const UPCGSettingsInterface* InDefaultSettingsInterface
)

  
Public function Const const UPCGSettingsInterface *  
Public function Const int32

GetSpatialInputCountByPin ( const FName& InPinLabel
)

 Gets number of spatial data items on a given pin
Public function Const TArray< FPCGTaggedData >

GetSpatialInputsByPin ( const FName& InPinLabel
)

 Returns all spatial data on a given pin
Public function Const const UPCGSpatialData *

GetSpatialUnionOfInputsByPin ( const FName& InPinLabel,
bool& bOutUnionDataCreated
)

  
Public function Const const UPCGSpatialData *

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

 Returns spatial union of all data on a given pin, returns null if no such data exists.
Public function Const TArray< FPCGTaggedData >

GetTaggedInputs ( const FString& InTag
)

 Returns all spatial data in the collection with the given tag
Public function Const TArray< FPCGTaggedData >

GetTaggedParams ( const FString& InTag
)

 Returns all params in the collection with a given tag
Public function Const TArray< FPCGTaggedData >

GetTaggedTypedInputs ( const FString& InTag
)

 Returns all data in the collection with the given tag and given type
Public function void

Reset ()

 Cleans up the collection, but does not unroot any previously rooted data.
Public function int32 Strips all empty point data from the collection.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FPCGDataCollection& Other
)

  
Public function Const bool

operator== ( const FPCGDataCollection& Other
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page