Navigation
API > API/Plugins > API/Plugins/PCG
An abstract collection of FPCGIndexRange data that represents a concrete set of indices.
| Name | FPCGIndexCollection |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Helpers/Parsing/PCGIndexing.h |
| Include Path | #include "Helpers/Parsing/PCGIndexing.h" |
Syntax
class FPCGIndexCollection
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Helpers/Parsing/PCGIndexing.h | |||
FPCGIndexCollection
(
const int32 InArraySize |
The constructor must accept the size of the array to support negative terminating indices. | Helpers/Parsing/PCGIndexing.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ArraySize | int32 | The size of the representative array associated with this collection. | Helpers/Parsing/PCGIndexing.h | |
| IndexRanges | TArray< FPCGIndexRange, TInlineAllocator< 64 > > | A collection of the abstract index ranges in the collection. | Helpers/Parsing/PCGIndexing.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddRange
(
int32 StartIndex, |
Add a new index range to the collection directly via start and end indices. | Helpers/Parsing/PCGIndexing.h | |
bool AddRange
(
const FPCGIndexRange& NewRange |
Add a new index range to the collection directly via an index range. | Helpers/Parsing/PCGIndexing.h | |
bool ContainsIndex
(
int32 Index |
Returns true if this collection contains the given index. | Helpers/Parsing/PCGIndexing.h | |
int32 GetArraySize() |
Returns the abstract size of the array tied to the collection. | Helpers/Parsing/PCGIndexing.h | |
int32 GetTotalIndexCount() |
Gets the total number of concrete indices within the collection. | Helpers/Parsing/PCGIndexing.h | |
int32 GetTotalRangeCount() |
Gets the number of range structures currently in the collection. | Helpers/Parsing/PCGIndexing.h | |
bool IsEmpty() |
The index collection has no ranges. | Helpers/Parsing/PCGIndexing.h | |
bool IsValid() |
The index collection has a valid array size. | Helpers/Parsing/PCGIndexing.h | |
bool RangeIsValid
(
const FPCGIndexRange& Range |
Validates that a range is acceptable for this collection. Returns true if valid, false otherwise | Helpers/Parsing/PCGIndexing.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FPCGIndexCollection Invalid() |
Helpers/Parsing/PCGIndexing.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPCGIndexCollection & operator+=
(
const FPCGIndexCollection& Other |
Helpers/Parsing/PCGIndexing.h | ||
bool operator==
(
const FPCGIndexCollection& Other |
Helpers/Parsing/PCGIndexing.h |