UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
TScriptSparseArray< AllocatorType, InDerivedType > Class Template Reference

#include <SparseArray.h>

Public Types

using IntrusiveUnsetOptionalStateType = TScriptSparseArray
 

Public Member Functions

 TScriptSparseArray ()
 
 TScriptSparseArray (FIntrusiveUnsetOptionalState Tag)
 
bool operator== (FIntrusiveUnsetOptionalState Tag) const
 
bool IsValidIndex (int32 Index) const
 
bool IsAllocated (int32 Index) const
 
bool IsEmpty () const
 
int32 Num () const
 
int32 Max () const
 
int32 NumUnchecked () const
 
int32 GetMaxIndex () const
 
bool IsCompact () const
 
void * GetData (int32 Index, const FScriptSparseArrayLayout &Layout)
 
const void * GetData (int32 Index, const FScriptSparseArrayLayout &Layout) const
 
void MoveAssign (DerivedType &Other, const FScriptSparseArrayLayout &Layout)
 
void Empty (int32 Slack, const FScriptSparseArrayLayout &Layout)
 
int32 AddUninitialized (const FScriptSparseArrayLayout &Layout)
 
void RemoveAtUninitialized (const FScriptSparseArrayLayout &Layout, int32 Index, int32 Count=1)
 
 TScriptSparseArray (const TScriptSparseArray &)
 
void operator= (const TScriptSparseArray &)
 

Static Public Member Functions

static constexpr FScriptSparseArrayLayout GetScriptLayout (int32 ElementSize, int32 ElementAlignment)
 

Static Public Attributes

static constexpr bool bHasIntrusiveUnsetOptionalState = true
 

Member Typedef Documentation

◆ IntrusiveUnsetOptionalStateType

template<typename AllocatorType , typename InDerivedType >
using TScriptSparseArray< AllocatorType, InDerivedType >::IntrusiveUnsetOptionalStateType = TScriptSparseArray

Constructor & Destructor Documentation

◆ TScriptSparseArray() [1/3]

template<typename AllocatorType , typename InDerivedType >
TScriptSparseArray< AllocatorType, InDerivedType >::TScriptSparseArray ( )
inline

◆ TScriptSparseArray() [2/3]

template<typename AllocatorType , typename InDerivedType >
TScriptSparseArray< AllocatorType, InDerivedType >::TScriptSparseArray ( FIntrusiveUnsetOptionalState  Tag)
inlineexplicit

◆ TScriptSparseArray() [3/3]

template<typename AllocatorType , typename InDerivedType >
TScriptSparseArray< AllocatorType, InDerivedType >::TScriptSparseArray ( const TScriptSparseArray< AllocatorType, InDerivedType > &  )
inline

Member Function Documentation

◆ AddUninitialized()

template<typename AllocatorType , typename InDerivedType >
int32 TScriptSparseArray< AllocatorType, InDerivedType >::AddUninitialized ( const FScriptSparseArrayLayout &  Layout)
inline

Adds an uninitialized object to the array.

Returns
The index of the added element.

◆ Empty()

template<typename AllocatorType , typename InDerivedType >
void TScriptSparseArray< AllocatorType, InDerivedType >::Empty ( int32  Slack,
const FScriptSparseArrayLayout &  Layout 
)
inline

◆ GetData() [1/2]

template<typename AllocatorType , typename InDerivedType >
void * TScriptSparseArray< AllocatorType, InDerivedType >::GetData ( int32  Index,
const FScriptSparseArrayLayout &  Layout 
)
inline

◆ GetData() [2/2]

template<typename AllocatorType , typename InDerivedType >
const void * TScriptSparseArray< AllocatorType, InDerivedType >::GetData ( int32  Index,
const FScriptSparseArrayLayout &  Layout 
) const
inline

◆ GetMaxIndex()

template<typename AllocatorType , typename InDerivedType >
int32 TScriptSparseArray< AllocatorType, InDerivedType >::GetMaxIndex ( ) const
inline
Returns
The non-inclusive maximum index of elements in the sparse array.

◆ GetScriptLayout()

template<typename AllocatorType , typename InDerivedType >
static constexpr FScriptSparseArrayLayout TScriptSparseArray< AllocatorType, InDerivedType >::GetScriptLayout ( int32  ElementSize,
int32  ElementAlignment 
)
inlinestaticconstexpr

◆ IsAllocated()

template<typename AllocatorType , typename InDerivedType >
bool TScriptSparseArray< AllocatorType, InDerivedType >::IsAllocated ( int32  Index) const
inline

◆ IsCompact()

template<typename AllocatorType , typename InDerivedType >
bool TScriptSparseArray< AllocatorType, InDerivedType >::IsCompact ( ) const
inline

◆ IsEmpty()

template<typename AllocatorType , typename InDerivedType >
bool TScriptSparseArray< AllocatorType, InDerivedType >::IsEmpty ( ) const
inline

◆ IsValidIndex()

template<typename AllocatorType , typename InDerivedType >
bool TScriptSparseArray< AllocatorType, InDerivedType >::IsValidIndex ( int32  Index) const
inline

◆ Max()

template<typename AllocatorType , typename InDerivedType >
int32 TScriptSparseArray< AllocatorType, InDerivedType >::Max ( ) const
inline
Returns
The number of elements the array can hold before reallocation.

◆ MoveAssign()

template<typename AllocatorType , typename InDerivedType >
void TScriptSparseArray< AllocatorType, InDerivedType >::MoveAssign ( DerivedType &  Other,
const FScriptSparseArrayLayout &  Layout 
)
inline

◆ Num()

template<typename AllocatorType , typename InDerivedType >
int32 TScriptSparseArray< AllocatorType, InDerivedType >::Num ( ) const
inline

◆ NumUnchecked()

template<typename AllocatorType , typename InDerivedType >
int32 TScriptSparseArray< AllocatorType, InDerivedType >::NumUnchecked ( ) const
inline

◆ operator=()

template<typename AllocatorType , typename InDerivedType >
void TScriptSparseArray< AllocatorType, InDerivedType >::operator= ( const TScriptSparseArray< AllocatorType, InDerivedType > &  )
inline

◆ operator==()

template<typename AllocatorType , typename InDerivedType >
bool TScriptSparseArray< AllocatorType, InDerivedType >::operator== ( FIntrusiveUnsetOptionalState  Tag) const
inline

◆ RemoveAtUninitialized()

template<typename AllocatorType , typename InDerivedType >
void TScriptSparseArray< AllocatorType, InDerivedType >::RemoveAtUninitialized ( const FScriptSparseArrayLayout &  Layout,
int32  Index,
int32  Count = 1 
)
inline

Removes Count elements from the array, starting from Index, without destructing them.

Member Data Documentation

◆ bHasIntrusiveUnsetOptionalState

template<typename AllocatorType , typename InDerivedType >
constexpr bool TScriptSparseArray< AllocatorType, InDerivedType >::bHasIntrusiveUnsetOptionalState = true
staticconstexpr
The documentation for this class was generated from the following file: