Navigation
API > API/Plugins > API/Plugins/PCG
References
| Module | PCG |
| Header | /Engine/Plugins/Experimental/PCG/Source/PCG/Public/PCGData.h |
| Include | #include "PCGData.h" |
Syntax
struct FPCGDataCollection
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bCancelExecution | This flag is used to cancel further computation or for the debug/isolate feature | |
| bool | bCancelExecutionOnEmpty | ||
| FPCGCrc | Crc | A snapshot of the internal state of the data. | |
| TArray< FPCGTaggedData > | TaggedData |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddToRootSet
(
FPCGRootSet& RootSet |
||
| FPCGCrc | ComputeCrc
(
bool bFullDataCrc |
Computes Crc for this data. | |
| TArray< FPCGTaggedData > | GetAllParams () |
Returns all params in the collection | |
| TArray< FPCGTaggedData > | Returns all settings in the collection | ||
| UPCGParamData * | Returns the first/only param found on the default params pin | ||
| int32 | GetInputCountByPin
(
const FName& InPinLabel |
Gets number of data items on a given pin | |
| TArray< FPCGTaggedData > | GetInputs () |
Returns all spatial data in the collection | |
| TArray< FPCGTaggedData > | GetInputsByPin
(
const FName& InPinLabel |
Returns all data on a given pin | |
| TArray< FPCGTaggedData > | GetParamsByPin
(
const FName& InPinLabel |
Returns all params on a given pin | |
| UPCGParamData * | GetParamsWithDeprecation
(
const UPCGNode* Node |
Only used as a temporary solution for old graph with nodes that didn't have params pins. | |
| void | GetResourceSizeEx
(
FResourceSizeEx& CumulativeResourceSize |
Memory size calculation. Forward call to the data objects in the collection. | |
| const UPCGSettings * | GetSettings
(
const UPCGSettings* InDefaultSettings |
||
| const SettingsType * | GetSettings () |
||
| const UPCGSettingsInterface * | GetSettingsInterface
(
const UPCGSettingsInterface* InDefaultSettingsInterface |
||
| const UPCGSettingsInterface * | |||
| int32 | GetSpatialInputCountByPin
(
const FName& InPinLabel |
Gets number of spatial data items on a given pin | |
| TArray< FPCGTaggedData > | GetSpatialInputsByPin
(
const FName& InPinLabel |
Returns all spatial data on a given pin | |
| const UPCGSpatialData * | GetSpatialUnionOfInputsByPin
(
const FName& InPinLabel, |
Returns spatial union of all data on a given pin, returns null if no such data exists. | |
| TArray< FPCGTaggedData > | GetTaggedInputs
(
const FString& InTag |
Returns all spatial data in the collection with the given tag | |
| TArray< FPCGTaggedData > | GetTaggedParams
(
const FString& InTag |
Returns all params in the collection with a given tag | |
| TArray< FPCGTaggedData > | GetTaggedTypedInputs
(
const FString& InTag |
Returns all data in the collection with the given tag and given type | |
| void | RemoveFromRootSet
(
FPCGRootSet& RootSet |
||
| void | Reset () |
Cleans up the collection, but does not unroot any previously rooted data. |
Operators
| Type | Name | Description | |
|---|---|---|---|
| bool | operator!=
(
const FPCGDataCollection& Other |
||
| bool | operator==
(
const FPCGDataCollection& Other |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| UPCGParamData * | GetParams () |
GetParams is deprecated, please use GetParamsByPin or GetFirstParamsOnParamsPin. |