FPCGPointArrayProperty | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/PCG

Templated struct used to store NumValues of the same type. If all values are equal then they are stored into the Value field and Values is not allocated If some values differ then Values is allocated and stores the different values

It provides a GetValueRange()/GetConstValueRange() implementation so that those NumValues can be indexed without user knowing of the internal allocations.


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

Syntax

template<typename T>  
struct FPCGPointArrayProperty

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FPCGPointArrayProperty()		PCGPointArray.h

Variables

Protected

Name	Type	Remarks	Include Path
NumValues	int32	Number of values represented by this FPCGPointArrayProperty.	PCGPointArray.h
Value	T	Value representing all values if array is unallocated.	PCGPointArray.h
Values	TArray< T >	Array containing values if allocated.	PCGPointArray.h

Functions

Public

Name	Remarks	Include Path
void Allocate ( bool bInitializeValues )	If 'Values' isn't currently allocated, allocate it and copy 'Value' at every index of 'Values[0, NumValues - 1]'	PCGPointArray.h
void CopyTo ( FPCGPointArrayProperty< T >& OutProperty, int32 StartReadIndex, int32 StartWriteIndex, int32 Count ) const		PCGPointArray.h
void CopyUnallocatedProperty ( FPCGPointArrayProperty< T >& OutProperty ) const		PCGPointArray.h
void Free()	Free 'Values', effectively resets all values to 'Value'	PCGPointArray.h
TConstPCGValueRange< T > GetConstValueRange()	Returns a TConstPCGValueRange of NumValues	PCGPointArray.h
TArray< T > GetCopy()	Returns a TArray copy of size NumValues	PCGPointArray.h
SIZE_T GetSizeBytes()		PCGPointArray.h
const T & GetValue ( int32 Index ) const	Return value at Index	PCGPointArray.h
TPCGValueRange< T > GetValueRange ( bool bAllocate, bool bInitializeValues )	Returns a TPCGValueRange of NumValues and optionally allocate 'Values'	PCGPointArray.h
bool IsAllocated()	Returns true if 'Values' is allocated	PCGPointArray.h
void MoveRange ( int32 RangeStartIndex, int32 MoveToIndex, int32 NumElements )	Move ranges of values(moves them back into the array).Used by the PCGAsync api	PCGPointArray.h
int32 Num()		PCGPointArray.h
void Serialize ( FArchive& Ar )		PCGPointArray.h
void SetNum ( int32 NewNum, bool bAllocate, bool bInitializeValues )	Set the 'NumValues', optionally allocating 'Values'	PCGPointArray.h
void SetValue ( const T& InValue )	Set all values('Value/Values') to InValue	PCGPointArray.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
bool operator== ( const FPCGPointArrayProperty< T >& Other ) const	Defined for serialization purposes(FPCGPointArray trait WithIdenticalViaEquality)	PCGPointArray.h

Navigation