FManagedBitArrayBase Class Reference

#include <ManagedArray.h>

Inheritance diagram for FManagedBitArrayBase:

Public Member Functions
FORCEINLINE	FManagedBitArrayBase ()
FORCEINLINE	FManagedBitArrayBase (const FManagedBitArrayBase &Other)=delete
FORCEINLINE	FManagedBitArrayBase (FManagedBitArrayBase &&Other)
FORCEINLINE FManagedBitArrayBase &	operator= (FManagedBitArrayBase &&Other)
FORCEINLINE FManagedBitArrayBase &	operator= (TBitArray<> &&Other)
virtual	~FManagedBitArrayBase ()
virtual void	RemoveElements (const TArray< int32 > &SortedDeletionList) override
virtual void	Init (const FManagedArrayBase &NewArray) override
virtual SIZE_T	GetAllocatedSize () const override
virtual void	CopyRange (const FManagedArrayBase &ConstArray, int32 Start, int32 Stop, int32 Offset=0) override
void	Fill (const bool Value)
void	Fill (const TArray< bool > &BoolArray)
virtual void	ExchangeArrays (FManagedArrayBase &NewArray) override
FORCEINLINE bool	IsValidIndex (int32 Index) const
FORCEINLINE FBitReference	operator[] (int Index)
FORCEINLINE const FConstBitReference	operator[] (int Index) const
FORCEINLINE const TBitArray &	GetConstArray ()
FORCEINLINE const TBitArray &	GetConstArray () const
TArray< bool >	GetAsBoolArray () const
FORCEINLINE size_t	GetTypeSize () const override
FORCEINLINE int32	Num () const override
FORCEINLINE int32	Max () const override
FORCEINLINE bool	Contains (const bool Item) const
int32	Find (const bool Item) const
int32	Count (const bool Item) const
FORCEINLINE void	RangeCheck (int32 Index) const
virtual void	Serialize (Chaos::FChaosArchive &Ar)
Public Member Functions inherited from FManagedArrayBase
	FManagedArrayBase ()
virtual	~FManagedArrayBase ()
FORCEINLINE void	ClearDirtyFlag ()
FORCEINLINE_DEBUGGABLE void	MarkDirty ()
FORCEINLINE bool	IsDirty () const
virtual void	Reindex (const TArray< int32 > &Offsets, const int32 &FinalSize, const TArray< int32 > &SortedDeletionList, const TSet< int32 > &DeletionSet)

Protected Member Functions
void	Resize (const int32 Size)
void	Reserve (const int32 Size)
void	Empty ()
void	Reorder (const TArray< int32 > &NewOrder) override
Protected Member Functions inherited from FManagedArrayBase
virtual void	ReindexFromLookup (const TArray< int32 > &InverseNewOrder)
virtual void	Convert (const FManagedArrayBase &)
virtual void	SetDefaults (uint32 StartSize, uint32 NumElements, bool bHasGroupIndexDependency)
Protected Member Functions inherited from FNoncopyable
	FNoncopyable ()
	~FNoncopyable ()

Protected Attributes
TBitArray	Array

Constructor & Destructor Documentation

FManagedBitArrayBase() [1/3]

FORCEINLINE FManagedBitArrayBase::FManagedBitArrayBase ( )

inline

FManagedBitArrayBase() [2/3]

FORCEINLINE FManagedBitArrayBase::FManagedBitArrayBase ( const FManagedBitArrayBase &  Other )

delete

FManagedBitArrayBase() [3/3]

FORCEINLINE FManagedBitArrayBase::FManagedBitArrayBase ( FManagedBitArrayBase &&  Other )

inline

~FManagedBitArrayBase()

virtual FManagedBitArrayBase::~FManagedBitArrayBase ( )

inlinevirtual

Member Function Documentation

Contains()

FORCEINLINE bool FManagedBitArrayBase::Contains ( const bool  Item ) const

inline

CopyRange()

virtual void FManagedBitArrayBase::CopyRange ( const FManagedArrayBase &  ConstArray, int32  Start, int32  Stop, int32  Offset = 0  )

inlineoverridevirtual

Copy from a predefined Array of matching type

Reimplemented from FManagedArrayBase.

Count()

int32 FManagedBitArrayBase::Count ( const bool  Item ) const

inline

Count the number of entries match Item.

Empty()

void FManagedBitArrayBase::Empty ( )

inlineprotectedvirtual

Protected clear to prevent external clearing of the array

Reimplemented from FManagedArrayBase.

ExchangeArrays()

virtual void FManagedBitArrayBase::ExchangeArrays ( FManagedArrayBase &  Src )

inlineoverridevirtual

Perform a memory move between the two arrays

Implements FManagedArrayBase.

Fill() [1/2]

void FManagedBitArrayBase::Fill ( const bool  Value )

inline

Fill the array with Value.

Fill() [2/2]

void FManagedBitArrayBase::Fill ( const TArray< bool > &  BoolArray )

inline

Find()

int32 FManagedBitArrayBase::Find ( const bool  Item ) const

inline

Find first index of the element

GetAllocatedSize()

virtual SIZE_T FManagedBitArrayBase::GetAllocatedSize ( ) const

inlineoverridevirtual

Get allocated memory

Reimplemented from FManagedArrayBase.

GetAsBoolArray()

TArray< bool > FManagedBitArrayBase::GetAsBoolArray ( ) const

inline

Helper function to convert the bitArray to a bool array this is creating a new array and copy convert each bit to a bool

GetConstArray() [1/2]

FORCEINLINE const TBitArray & FManagedBitArrayBase::GetConstArray ( )

inline

Helper function for returning the internal const array

Returns

const array of all the elements

GetConstArray() [2/2]

FORCEINLINE const TBitArray & FManagedBitArrayBase::GetConstArray ( ) const

inline

GetTypeSize()

FORCEINLINE size_t FManagedBitArrayBase::GetTypeSize ( ) const

inlineoverridevirtual

Helper function for returning a typed pointer to the first array entry.

Returns

Pointer to first array entry or nullptr if ArrayMax == 0. Helper function for returning a typed pointer to the first array entry.

Pointer to first array entry or nullptr if ArrayMax == 0. Helper function returning the size of the inner type.

Size in bytes of array type.

Reimplemented from FManagedArrayBase.

Init()

virtual void FManagedBitArrayBase::Init ( const FManagedArrayBase &  NewArray )

inlineoverridevirtual

Init from a predefined Array of matching type

Reimplemented from FManagedArrayBase.

IsValidIndex()

FORCEINLINE bool FManagedBitArrayBase::IsValidIndex ( int32  Index ) const

inline

return true if index is in array range.

Parameters

Index

Index to check.

Max()

FORCEINLINE int32 FManagedBitArrayBase::Max ( ) const

inlineoverridevirtual

The reserved length of the array.

Reimplemented from FManagedArrayBase.

Num()

FORCEINLINE int32 FManagedBitArrayBase::Num ( ) const

inlineoverridevirtual

Returning the size of the array

Returns

Array size

Reimplemented from FManagedArrayBase.

operator=() [1/2]

FORCEINLINE FManagedBitArrayBase & FManagedBitArrayBase::operator= ( FManagedBitArrayBase &&  Other )

inline

operator=() [2/2]

FORCEINLINE FManagedBitArrayBase & FManagedBitArrayBase::operator= ( TBitArray<> &&  Other )

inline

operator[]() [1/2]

FORCEINLINE FBitReference FManagedBitArrayBase::operator[] ( int  Index )

inline

Returning a reference to the element at index.

Returns

Array element reference

operator[]() [2/2]

FORCEINLINE const FConstBitReference FManagedBitArrayBase::operator[] ( int  Index ) const

inline

RangeCheck()

FORCEINLINE void FManagedBitArrayBase::RangeCheck ( int32  Index ) const

inline

Checks if index is in array range.

Parameters

Index

Index to check.

RemoveElements()

virtual void FManagedBitArrayBase::RemoveElements ( const TArray< int32 > &  SortedDeletionList )

inlineoverridevirtual

Remove elements

Reimplemented from FManagedArrayBase.

Reorder()

void FManagedBitArrayBase::Reorder ( const TArray< int32 > &  NewOrder )

inlineoverrideprotectedvirtual

Reorder elements given a new ordering. Sizes must match

Parameters

NewOrder

Mapping from indices in the new array -> indices in the old array

Implements FManagedArrayBase.

Reserve()

void FManagedBitArrayBase::Reserve ( const int32  Size )

inlineprotectedvirtual

Protected Reserve to prevent external reservation of the array

Parameters

New	array reservation size.

Reimplemented from FManagedArrayBase.

Resize()

void FManagedBitArrayBase::Resize ( const int32  Size )

inlineprotectedvirtual

Protected Resize to prevent external resizing of the array

Parameters

New	array size.

Reimplemented from FManagedArrayBase.

Serialize()

virtual void FManagedBitArrayBase::Serialize ( Chaos::FChaosArchive &  Ar )

inlinevirtual

Serialization Support

Parameters

Chaos::FChaosArchive&

Ar

Reimplemented from FManagedArrayBase.

Member Data Documentation

Array

TBitArray FManagedBitArrayBase::Array

protected

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/ManagedArray.h