Table of Contents

Wwise SDK 2019.1.6
CAkKeyArray< T_KEY, T_ITEM, U_POOL, TGrowBy, TMovePolicy > Class Template Reference
Inheritance diagram for CAkKeyArray< T_KEY, T_ITEM, U_POOL, TGrowBy, TMovePolicy >:
AkArray< MapStruct< T_KEY, T_ITEM >, const MapStruct< T_KEY, T_ITEM > &, U_POOL, TGrowBy, TMovePolicy >

Public Member Functions

T_ITEM *  Exists (T_KEY in_Key)
 
T_ITEM *  Set (T_KEY in_Key, const T_ITEM &in_Item)
 
T_ITEM *  SetFirst (T_KEY in_Key, const T_ITEM &in_Item)
 
T_ITEM *  Set (T_KEY in_Key)
 
AkArray< MapStruct< T_KEY, T_ITEM >, const MapStruct< T_KEY, T_ITEM > &, U_POOL, TGrowBy, TMovePolicy >::Iterator  FindEx (T_KEY in_Item) const
 
void  Unset (T_KEY in_Key)
 
void  UnsetSwap (T_KEY in_Key)
 
- Public Member Functions inherited from AkArray< MapStruct< T_KEY, T_ITEM >, const MapStruct< T_KEY, T_ITEM > &, U_POOL, TGrowBy, TMovePolicy >
  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 (const MapStruct< T_KEY, T_ITEM > & in_Item) const
  Returns the iterator th the specified item, will be End() if the item is not found. More...
 
Iterator  BinarySearch (const MapStruct< T_KEY, T_ITEM > & 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)
 
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 MapStruct< T_KEY, T_ITEM > *  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 MapStruct< T_KEY, T_ITEM > *  Exists (const MapStruct< T_KEY, T_ITEM > & in_Item) const
  Returns a pointer to the specified item in the list if it exists, 0 if not found. More...
 
AkForceInline MapStruct< T_KEY, T_ITEM > *  AddLast ()
 
AkForceInline MapStruct< T_KEY, T_ITEM > *  AddLast (const MapStruct< T_KEY, T_ITEM > & in_rItem)
  Add an item in the array, and fills it with the provided item. More...
 
MapStruct< T_KEY, T_ITEM > &  Last ()
  Returns a reference to the last item in the array. More...
 
void  RemoveLast ()
  Removes the last item from the array. More...
 
AKRESULT  Remove (const MapStruct< T_KEY, T_ITEM > & in_rItem)
  Removes the specified item if found in the array. More...
 
AKRESULT  RemoveSwap (const MapStruct< T_KEY, T_ITEM > & in_rItem)
 
void  RemoveAll ()
  Removes all items in the array. More...
 
AkForceInline MapStruct< T_KEY, T_ITEM > &  operator[] (unsigned int uiIndex) const
  Operator [], return a reference to the specified index. More...
 
MapStruct< T_KEY, T_ITEM > *  Insert (unsigned int in_uIndex)
 
bool  GrowArray (AkUInt32 in_uGrowBy=TGrowBy)
  Resize the array. More...
 
bool  Resize (AkUInt32 in_uiSize)
  Resize the array to the specified size. More...
 
void  Transfer (AkArray< MapStruct< T_KEY, T_ITEM >, const MapStruct< T_KEY, T_ITEM > &, U_POOL, TGrowBy, TMovePolicy > &in_rSource)
 
AKRESULT  Copy (const AkArray< MapStruct< T_KEY, T_ITEM >, const MapStruct< T_KEY, T_ITEM > &, U_POOL, TGrowBy, TMovePolicy > &in_rSource)
 

Additional Inherited Members

- Protected Attributes inherited from AkArray< MapStruct< T_KEY, T_ITEM >, const MapStruct< T_KEY, T_ITEM > &, U_POOL, TGrowBy, TMovePolicy >
MapStruct< T_KEY, T_ITEM > *  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_KEY, class T_ITEM, class U_POOL = ArrayPoolDefault, AkUInt32 TGrowBy = 1, class TMovePolicy = AkAssignmentMovePolicy<MapStruct<T_KEY, T_ITEM> >>
class CAkKeyArray< T_KEY, T_ITEM, U_POOL, TGrowBy, TMovePolicy >

Definition at line 37 of file AkKeyArray.h.


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