Version
arrow_right Table of Contents

Other Documentation

Wwise SDK 2021.1.10
List of all members | Classes | Public Member Functions | Protected Attributes
AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > Class Template Reference

Specific implementation of array. More...

#include <AkArray.h>

Inheritance diagram for AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy >:
AkArrayAllocatorNoAlign< T_MEMID >

Classes

struct   Iterator
  Iterator. More...
 

Public Member Functions

  AkArray ()
  Constructor. More...
 
  ~AkArray ()
  Destructor. More...
 
Iterator  Begin () const
  Returns the iterator to the first item of the array, will be End() if the array is empty. More...
 
Iterator  End () const
  Returns the iterator to the end of the array. More...
 
Iterator  FindEx (ARG_T in_Item) const
  Returns the iterator th the specified item, will be End() if the item is not found. More...
 
Iterator  BinarySearch (ARG_T in_Item) const
 
Iterator  Erase (Iterator &in_rIter)
  Erase the specified iterator from the array. More...
 
void  Erase (unsigned int in_uIndex)
  Erase the item at the specified index. More...
 
Iterator  EraseSwap (Iterator &in_rIter)
 
void  EraseSwap (unsigned int in_uIndex)
 
bool  IsGrowingAllowed ()
 
AKRESULT  Reserve (AkUInt32 in_ulReserve)
  Pre-Allocate a number of spaces in the array. More...
 
AkUInt32  Reserved () const
 
void  Term ()
  Term the array. Must be called before destroying the object. More...
 
AkForceInline AkUInt32  Length () const
  Returns the numbers of items in the array. More...
 
AkForceInline T *  Data () const
  Returns a pointer to the first item in the array. More...
 
AkForceInline bool  IsEmpty () const
  Returns true if the number items in the array is 0, false otherwise. More...
 
AkForceInline T *  Exists (ARG_T in_Item) const
  Returns a pointer to the specified item in the list if it exists, 0 if not found. More...
 
AkForceInline T *  AddLast ()
 
AkForceInline T *  AddLast (ARG_T in_rItem)
  Add an item in the array, and fills it with the provided item. More...
 
T &  Last ()
  Returns a reference to the last item in the array. More...
 
void  RemoveLast ()
  Removes the last item from the array. More...
 
AKRESULT  Remove (ARG_T in_rItem)
  Removes the specified item if found in the array. More...
 
AKRESULT  RemoveSwap (ARG_T in_rItem)
 
void  RemoveAll ()
  Removes all items in the array. More...
 
AkForceInline T &  operator[] (unsigned int uiIndex) const
  Operator [], return a reference to the specified index. More...
 
T *  Insert (unsigned int in_uIndex)
 
bool  GrowArray ()
 
bool  GrowArray (AkUInt32 in_uGrowBy)
  Resize the array. More...
 
bool  Resize (AkUInt32 in_uiSize)
  Resize the array to the specified size. More...
 
void  Transfer (AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
 
AKRESULT  Copy (const AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy > &in_rSource)
 
- Public Member Functions inherited from AkArrayAllocatorNoAlign< T_MEMID >
AkForceInline void *  Alloc (size_t in_uSize)
 
AkForceInline void *  ReAlloc (void *in_pCurrent, size_t in_uOldSize, size_t in_uNewSize)
 
AkForceInline void  Free (void *in_pAddress)
 
AkForceInline void  TransferMem (void *&io_pDest, AkArrayAllocatorNoAlign< T_MEMID > in_srcAlloc, void *in_pSrc)
 

Protected Attributes

T *  m_pItems
  pointer to the beginning of the array. More...
 
AkUInt32  m_uLength
  number of items in the array. More...
 
AkUInt32  m_ulReserved
  how many we can have at most (currently allocated). More...
 

Detailed Description

template<class T, class ARG_T, class TAlloc = ArrayPoolDefault, class TGrowBy = AkGrowByPolicy_DEFAULT, class TMovePolicy = AkAssignmentMovePolicy<T>>
class AkArray< T, ARG_T, TAlloc, TGrowBy, TMovePolicy >

Specific implementation of array.

Definition at line 199 of file AkArray.h.