UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Geometry::FIndexFlagSet Class Reference

#include <SparseIndexCollectionTypes.h>

Public Member Functions

 FIndexFlagSet (bool bSetSparse=true, int MaxIndex=-1)
 
 FIndexFlagSet (int MaxIndex, int SubsetCountEst)
 
void InitAuto (int MaxIndex, int SubsetCountEst)
 
void InitManual (bool bSetSparse, int MaxIndex=-1)
 
bool Contains (int Index) const
 
void Add (int Index)
 
void Remove (int Index)
 
int Count () const
 
const bool operator[] (unsigned int Index) const
 

Detailed Description

This class provides optionally sparse or dense boolean flags for a set of integer indices

Constructor & Destructor Documentation

◆ FIndexFlagSet() [1/2]

UE::Geometry::FIndexFlagSet::FIndexFlagSet ( bool  bSetSparse = true,
int  MaxIndex = -1 
)
inline

◆ FIndexFlagSet() [2/2]

UE::Geometry::FIndexFlagSet::FIndexFlagSet ( int  MaxIndex,
int  SubsetCountEst 
)
inline

Member Function Documentation

◆ Add()

void UE::Geometry::FIndexFlagSet::Add ( int  Index)
inline
Parameters
Indexindex to add to set

◆ Contains()

bool UE::Geometry::FIndexFlagSet::Contains ( int  Index) const
inline
Parameters
Indexindex to check for set membership
Returns
true if Index is in set

◆ Count()

int UE::Geometry::FIndexFlagSet::Count ( ) const
inline

Returns number of values in set

◆ InitAuto()

void UE::Geometry::FIndexFlagSet::InitAuto ( int  MaxIndex,
int  SubsetCountEst 
)
inline

Initialize to either sparse or dense automatically, based on max index and estimated number of set indices

◆ InitManual()

void UE::Geometry::FIndexFlagSet::InitManual ( bool  bSetSparse,
int  MaxIndex = -1 
)
inline

Initialize to sparse or dense based on the explicit caller choice

Parameters
bSetSparseif true, will use sparse storage; otherwise will use dense
MaxIndexmaximum valid index in set; must be non-negative for dense case

◆ operator[]()

const bool UE::Geometry::FIndexFlagSet::operator[] ( unsigned int  Index) const
inline

Array-style accessor that returns true if Index is in set, false otherwise

◆ Remove()

void UE::Geometry::FIndexFlagSet::Remove ( int  Index)
inline
Parameters
Indexindex to remove from set

The documentation for this class was generated from the following file: