#include <fbxarray.h>

Class Description

template<class T>
class FbxArray< T >

Class for array of basic elements such as pointers and basic types.

This class will not call constructor and destructor for elements, thus it is not suitable for object references. Memory allocations are always done in a single contiguous memory region.

Examples:: ExportScene01/main.cxx, ExportScene03/main.cxx, SwitchBinding/main.cxx, ViewScene/main.cxx, ViewScene/SceneCache.h, ViewScene/SceneContext.cxx, ViewScene/SceneContext.h, ViewScene/SetCamera.cxx, and ViewScene/SetCamera.h.

Definition at line 23 of file fbxarray.h.

Public Types
typedef int(*	CompareFunc) (const void , const void )
	Element compare function pointer definition. More...

Public Member Functions
	FbxArray ()
	Constructor. More...

	FbxArray (const int pCapacity)
	Reserve constructor. More...

	FbxArray (const FbxArray &pArray)
	Copy constructor. More...

	~FbxArray ()
	Destructor. More...

int	InsertAt (const int pIndex, const T &pElement, bool pCompact=false)
	Insert an element at the given position, growing the array if capacity is not sufficient. More...

int	Add (const T &pElement)
	Append an element at the end of the array, doubling the array if capacity is not sufficient. More...

int	AddUnique (const T &pElement)
	Append an element at the end of array, if not already present, doubling the array if capacity is not sufficient. More...

int	AddCompact (const T &pElement)
	Append an element at the end of the array, growing the array by one element if capacity is not sufficient. More...

int	Size () const
	Retrieve the number of element contained in the array. More...

int	Capacity () const
	Retrieve the current allocated memory capacity of the array. More...

T &	operator[] (const int pIndex) const
	Retrieve a reference of the element at given index position in the array. More...

T	GetAt (const int pIndex) const
	Retrieve a copy of the element at given index position in the array. More...

T	GetFirst () const
	Retrieve a copy of the first element. More...

T	GetLast () const
	Retrieve a copy of the last element. More...

int	Find (const T &pElement, const int pStartIndex=0) const
	Find first matching element, from first to last. More...

int	FindReverse (const T &pElement, const int pStartIndex=0x7fffffff) const
	Find first matching element, from last to first. More...

bool	Reserve (const int pCapacity)
	Request for allocation of additional memory without inserting new elements. More...

void	SetAt (const int pIndex, const T &pElement)
	Set the element at given position in the array. More...

void	SetFirst (const T &pElement)
	Set the value of the first element. More...

void	SetLast (const T &pElement)
	Set the value of the last element. More...

T	RemoveAt (const int pIndex)
	Remove an element at the given position in the array. More...

T	RemoveFirst ()
	Remove the first element in the array. More...

T	RemoveLast ()
	Remove the last element in the array. More...

bool	RemoveIt (const T &pElement)
	Remove first matching element in the array. More...

void	RemoveRange (const int pIndex, const int pCount)
	Remove a range of elements at the given position in the array. More...

bool	Resize (const int pSize)
	Inserts or erases elements at the end such that Size() becomes pSize, increasing capacity if needed. More...

bool	Grow (const int pSize)
	Increase size of array by the specified size. More...

bool	Shrink (const int pSize)
	Reduce size of array by the specified size. More...

bool	Compact ()
	Compact the array so that its capacity is the same as its size. More...

void	Clear ()
	Reset the number of element to zero and free the memory allocated. More...

void	Sort (CompareFunc pCompareFunc)
	Sort the array using the specified compare function pointer. More...

T *	GetArray () const
	Get pointer to internal array of elements. More...

	operator T* ()
	Cast operator. More...

void	AddArray (const FbxArray< T > &pOther)
	Append another array at the end of this array. More...

void	AddArrayNoDuplicate (const FbxArray< T > &pOther)
	Append the elements of another array at the end of this array if they are not present. More...

void	RemoveArray (const FbxArray< T > &pOther)
	Remove the elements of another array from this array is they are present. More...

FbxArray< T > &	operator= (const FbxArray< T > &pOther)
	Operator to copy elements of an array. More...

bool	operator== (const FbxArray< T > &pOther) const
	Operator to compare elements of an array. More...

Member Typedef Documentation

◆ CompareFunc

typedef int(* CompareFunc) (const void *, const void *)

Element compare function pointer definition.

Definition at line 27 of file fbxarray.h.

Constructor & Destructor Documentation

◆ FbxArray() [1/3]

FbxArray ( )

inline

Constructor.

Definition at line 30 of file fbxarray.h.

30 : mSize(0), mCapacity(0), mArray(NULL){}

NULL

#define NULL

Definition: fbxarch.h:210

◆ FbxArray() [2/3]

FbxArray ( const int pCapacity )

inline

Reserve constructor.

Definition at line 33 of file fbxarray.h.

33 : mSize(0), mCapacity(0), mArray(NULL){ if( pCapacity > 0 ) Reserve(pCapacity); }

NULL

#define NULL

Definition: fbxarch.h:210

FbxArray::Reserve

bool Reserve(const int pCapacity)

Request for allocation of additional memory without inserting new elements.

Definition: fbxarray.h:191

◆ FbxArray() [3/3]

FbxArray ( const FbxArray< T > & pArray )

inline

Copy constructor.

Definition at line 36 of file fbxarray.h.

36 : mSize(0), mCapacity(0), mArray(NULL){ *this = pArray; }

NULL

#define NULL

Definition: fbxarch.h:210

◆ ~FbxArray()

~FbxArray ( )

inline

Destructor.

Remarks: The destructor for each element will not be called.

Definition at line 40 of file fbxarray.h.

40 { Clear(); }

FbxArray::Clear

void Clear()

Reset the number of element to zero and free the memory allocated.

Definition: fbxarray.h:352

Member Function Documentation

◆ InsertAt()

int InsertAt	(	const int	pIndex,
		const T &	pElement,
		bool	pCompact = `false`
	)

inline

Insert an element at the given position, growing the array if capacity is not sufficient.

Parameters

pIndex	Position where to insert the element. Must be a positive value.
pElement	Element to insert in the array.
pCompact	If `true` and capacity is exceeded, grow capacity by one, otherwise double capacity (default).

Returns: -1 if insert failed, otherwise the position of the inserted element in the array.

Remarks: If the given index is greater than Size(), the element is appended at the end. Use compact mode only if you need to save memory.

Definition at line 48 of file fbxarray.h.

     {
         FBX_ASSERT_RETURN_VALUE(pIndex >= 0, -1);
         int lIndex = FbxMin(pIndex, mSize);
         if( mSize >= mCapacity )
         {
             T lElement = pElement;  //Copy element because we might move memory
             int lNewCapacity = FbxMax(pCompact ? mCapacity + 1 : mCapacity * 2, 1); //We always double capacity when not compacting
             T* lArray = Allocate(lNewCapacity);
             FBX_ASSERT_RETURN_VALUE(lArray, -1);
             mArray = lArray;
             mCapacity = lNewCapacity;
             return InsertAt(pIndex, lElement);  //Insert copied element because reference might be moved
         }
 
         if( lIndex < mSize )    //Move elements to leave a space open to insert the new element
         {
             //If pElement is inside memmove range, copy element and insert copy instead
             if( (&pElement >= &mArray[lIndex]) && (&pElement < &mArray[mSize]) )
             {
                 T lElement = pElement;
                 return InsertAt(pIndex, lElement);
             }
             memmove(&mArray[lIndex + 1], &mArray[lIndex], (mSize - lIndex) * sizeof(T));
         }
 
         memcpy(&mArray[lIndex], &pElement, sizeof(T));
         mSize++;
 
         return lIndex;
     }

◆ Add()

int Add ( const T & pElement )

inline

Append an element at the end of the array, doubling the array if capacity is not sufficient.

Parameters

pElement Element to append to the array.

Returns: -1 if add failed, otherwise the position of the added element in the array.

Definition at line 83 of file fbxarray.h.

     {
         return InsertAt(mSize, pElement);
     }

◆ AddUnique()

int AddUnique ( const T & pElement )

inline

Append an element at the end of array, if not already present, doubling the array if capacity is not sufficient.

Parameters

pElement Element to append to the array.

Returns: -1 if add failed, otherwise the position of the added element in the array.

Definition at line 91 of file fbxarray.h.

     {
         int lIndex = Find(pElement);
         return ( lIndex == -1 ) ? Add(pElement) : lIndex;
     }

◆ AddCompact()

int AddCompact ( const T & pElement )

inline

Append an element at the end of the array, growing the array by one element if capacity is not sufficient.

Parameters

pElement Element to append to the array.

Returns: -1 if add failed, otherwise the position of the added element in the array.

Definition at line 100 of file fbxarray.h.

     {
         return InsertAt(mSize, pElement, true);
     }

◆ Size()

int Size ( ) const

inline

Retrieve the number of element contained in the array.

To increase the capacity without increasing the size, please use Reserve().

Returns: The number of element in the array.

Remarks: The size of the array cannot exceed its capacity.

Definition at line 108 of file fbxarray.h.

108 { return mSize; }

◆ Capacity()

int Capacity ( ) const

inline

Retrieve the current allocated memory capacity of the array.

Returns: The capacity of the array in number of element.

Remarks: The capacity will always be greater or equal to its size.

Definition at line 113 of file fbxarray.h.

113 { return mCapacity; }

◆ operator[]()

T& operator[] ( const int pIndex ) const

inline

Retrieve a reference of the element at given index position in the array.

Parameters

pIndex Position of element in the array.

Returns: A reference to the element at the specified position in the array.

Remarks: No error will be thrown if the index is out of bounds.

Definition at line 119 of file fbxarray.h.

     {
     #ifdef _DEBUG
         FBX_ASSERT_MSG(pIndex >= 0, "Index is out of range!");
         if( pIndex >= mSize )
         {
             if( pIndex < mCapacity )
             {
                 FBX_ASSERT_NOW("Index is out of range, but not outside of capacity! Call SetAt() to use reserved memory.");
             }
             else FBX_ASSERT_NOW("Index is out of range!");
         }
     #endif
         return (T&)mArray[pIndex];
     }

◆ GetAt()

T GetAt ( const int pIndex ) const

inline

Retrieve a copy of the element at given index position in the array.

Parameters

pIndex Position of element in the array.

Returns: The value of the element at the specified position in the array.

Remarks: No error will be thrown if the index is out of bounds.

Definition at line 139 of file fbxarray.h.

     {
         return operator[](pIndex);
     }

◆ GetFirst()

T GetFirst ( ) const

inline

Retrieve a copy of the first element.

Returns: Copy of the first element.

Remarks: The array should have at least one element and no error will be thrown if the array is empty.

Definition at line 147 of file fbxarray.h.

     {
         return GetAt(0);
     }

◆ GetLast()

T GetLast ( ) const

inline

Retrieve a copy of the last element.

Returns: Copy of the last element.

Remarks: The array should have at least one element and no error will be thrown if the array is empty.

Definition at line 155 of file fbxarray.h.

     {
         return GetAt(mSize-1);
     }

◆ Find()

int Find	(	const T &	pElement,
		const int	pStartIndex = `0`
	)		const

inline

Find first matching element, from first to last.

Parameters

pElement	The element to be compared to each of the elements.
pStartIndex	The position to start searching from.

Returns: Position of first matching element or -1 if there is no matching element.

Definition at line 164 of file fbxarray.h.

     {
         FBX_ASSERT_RETURN_VALUE(pStartIndex >= 0, -1);
         for( int i = pStartIndex; i < mSize; ++i )
         {
             if( operator[](i) == pElement ) return i;
         }
         return -1;
     }

◆ FindReverse()

int FindReverse	(	const T &	pElement,
		const int	pStartIndex = `0x7fffffff`
	)		const

inline

Find first matching element, from last to first.

Parameters

pElement	The element to be compared to each of the elements.
pStartIndex	The position to start searching from.

Returns: Position of first matching element or -1 if there is no matching element.

Definition at line 178 of file fbxarray.h.

     {
         for( int i = FbxMin(pStartIndex, mSize-1); i >= 0; --i )
         {
             if( operator[](i) == pElement ) return i;
         }
         return -1;
     }

◆ Reserve()

bool Reserve ( const int pCapacity )

inline

Request for allocation of additional memory without inserting new elements.

After the memory has been reserved, please use SetAt() to initialize elements.

Parameters

pCapacity The number of additional element memory allocation requested.

Returns: true if the memory allocation succeeded or if the capacity is unchanged, false otherwise.

Remarks: If the requested capacity is less than or equal to the current capacity, this call has no effect. In either case, Size() is unchanged.

Definition at line 191 of file fbxarray.h.

     {
         FBX_ASSERT_RETURN_VALUE(pCapacity > 0, false);
         if( pCapacity > mCapacity )
         {
             T* lArray = Allocate(pCapacity);
             FBX_ASSERT_RETURN_VALUE(lArray, false);
             mArray = lArray;
             mCapacity = pCapacity;
 
             //Initialize new memory to zero
             memset(&mArray[mSize], 0, (mCapacity - mSize) * sizeof(T));
         }
         return true;
     }

◆ SetAt()

void SetAt	(	const int	pIndex,
		const T &	pElement
	)

inline

Set the element at given position in the array.

Parameters

pIndex	Position of element in the array.
pElement	The new element.

Remarks: If the index is outside range, and outside capacity, this call has no effect. However, if index is within capacity range, element count is increased such that Size() will become pIndex + 1.

Definition at line 212 of file fbxarray.h.

     {
         FBX_ASSERT_RETURN(pIndex >= 0 && pIndex < mCapacity);
         if( pIndex >= mSize ) mSize = pIndex + 1;
         if( mArray ) memcpy(&mArray[pIndex], &pElement, sizeof(T));
     }

◆ SetFirst()

void SetFirst ( const T & pElement )

inline

Set the value of the first element.

Parameters

pElement The new value of the last element.

Remarks: The array should have at least one element and no error will be thrown if the array is empty.

Definition at line 222 of file fbxarray.h.

     {
         SetAt(0, pElement);
     }

◆ SetLast()

void SetLast ( const T & pElement )

inline

Set the value of the last element.

Parameters

pElement The new value of the last element.

Remarks: The array should have at least one element and no error will be thrown if the array is empty.

Definition at line 230 of file fbxarray.h.

     {
         SetAt(mSize-1, pElement);
     }

◆ RemoveAt()

T RemoveAt ( const int pIndex )

inline

Remove an element at the given position in the array.

Parameters

pIndex Position of the element to remove.

Returns: Removed element.

Remarks: No error will be thrown if the index is out of bounds.

Definition at line 239 of file fbxarray.h.

     {
         T lElement = GetAt(pIndex);
         if( pIndex + 1 < mSize )
         {
             memmove(&mArray[pIndex], &mArray[pIndex + 1], (mSize - pIndex - 1) * sizeof(T));
         }
         mSize--;
         return lElement;
     }

◆ RemoveFirst()

T RemoveFirst ( )

inline

Remove the first element in the array.

Returns: Removed element.

Remarks: The array should have at least one element and no error will be thrown if the array is empty.

Definition at line 253 of file fbxarray.h.

     {
         return RemoveAt(0);
     }

◆ RemoveLast()

T RemoveLast ( )

inline

Remove the last element in the array.

Returns: Removed element.

Remarks: The array should have at least one element and no error will be thrown if the array is empty.

Definition at line 261 of file fbxarray.h.

     {
         return RemoveAt(mSize-1);
     }

◆ RemoveIt()

bool RemoveIt ( const T & pElement )

inline

Remove first matching element in the array.

Parameters

pElement Element to be removed.

Returns: true if a matching element is found and removed, false otherwise.

Definition at line 269 of file fbxarray.h.

     {
         int Index = Find(pElement);
         if( Index >= 0 )
         {
             RemoveAt(Index);
             return true;
         }
         return false;
     }

◆ RemoveRange()

void RemoveRange	(	const int	pIndex,
		const int	pCount
	)

inline

Remove a range of elements at the given position in the array.

Parameters

pIndex	Begin position of the elements to remove.
pCount	The count of elements to remove.

Returns: true if successful, otherwise false.

Definition at line 284 of file fbxarray.h.

     {
         FBX_ASSERT_RETURN(pIndex >= 0);
         FBX_ASSERT_RETURN(pCount >= 0);
         if( pIndex + pCount < mSize )
         {
             memmove(&mArray[pIndex], &mArray[pIndex + pCount], (mSize - pIndex - pCount) * sizeof(T));
         }
         mSize -= pCount;
     }

◆ Resize()

bool Resize ( const int pSize )

inline

Inserts or erases elements at the end such that Size() becomes pSize, increasing capacity if needed.

Please use SetAt() to initialize any new elements.

Parameters

pSize The new count of elements to set the array to. Must be greater or equal to zero.

Returns: true if the memory (re)allocation succeeded, false otherwise.

Remarks: If the requested element count is less than or equal to the current count, elements are freed from memory. Otherwise, the array grows and elements are unchanged.

Definition at line 299 of file fbxarray.h.

     {
         if( pSize == mSize && mSize == mCapacity ) return true;
 
         if( pSize == 0 )
         {
             Clear();
             return true;
         }
 
         FBX_ASSERT_RETURN_VALUE(pSize > 0, false);
         if( pSize != mCapacity )
         {
             T* lArray = Allocate(pSize);
             FBX_ASSERT_RETURN_VALUE(lArray, false);
             mArray = lArray;
         }
 
         if( pSize > mCapacity ) //Initialize new memory to zero
         {
             memset(&mArray[mSize], 0, (pSize - mSize) * sizeof(T));
         }
 
         mSize = pSize;
         mCapacity = pSize;
         return true;
     }

◆ Grow()

bool Grow ( const int pSize )

inline

Increase size of array by the specified size.

Parameters

pSize The size to add to the array size.

Returns: true if operation succeeded, false otherwise.

Definition at line 330 of file fbxarray.h.

     {
         return Resize(mSize + pSize);
     }

◆ Shrink()

bool Shrink ( const int pSize )

inline

Reduce size of array by the specified size.

Parameters

pSize The size to remove from the array size.

Returns: true if operation succeeded, false otherwise.

Definition at line 338 of file fbxarray.h.

     {
         return Resize(mSize - pSize);
     }

◆ Compact()

bool Compact ( )

inline

Compact the array so that its capacity is the same as its size.

Returns: true if operation succeeded, false otherwise.

Definition at line 345 of file fbxarray.h.

     {
         return Resize(mSize);
     }

◆ Clear()

void Clear ( )

inline

Reset the number of element to zero and free the memory allocated.

Remarks: This only free the memory allocated by the array, and doesn't call the destructor of each element.

Definition at line 352 of file fbxarray.h.

     {
         if( mArray != NULL )
         {
             mSize = 0;
             mCapacity = 0;
             FbxFree(mArray);
             mArray = NULL;
         }
     }

◆ Sort()

void Sort ( CompareFunc pCompareFunc )

inline

Sort the array using the specified compare function pointer.

Parameters

pCompareFunc The compare function to use to sort elements.

Definition at line 365 of file fbxarray.h.

     {
         qsort(mArray, mSize, sizeof(T), pCompareFunc);
     }

◆ GetArray()

T* GetArray ( ) const

inline

Get pointer to internal array of elements.

Definition at line 371 of file fbxarray.h.

371 { return mArray ? (T*)mArray : NULL; }

NULL

#define NULL

Definition: fbxarch.h:210

◆ operator T*()

operator T* ( )

inline

Cast operator.

Definition at line 374 of file fbxarray.h.

374 { return mArray ? (T*)mArray : NULL; }

NULL

#define NULL

Definition: fbxarch.h:210

◆ AddArray()

void AddArray ( const FbxArray< T > & pOther )

inline

Append another array at the end of this array.

Parameters

pOther The other array to append to this array.

Definition at line 378 of file fbxarray.h.

     {
         if( Grow(pOther.mSize) )
         {
             memcpy(&mArray[mSize - pOther.mSize], pOther.mArray, pOther.mSize * sizeof(T));
         }
     }

◆ AddArrayNoDuplicate()

void AddArrayNoDuplicate ( const FbxArray< T > & pOther )

inline

Append the elements of another array at the end of this array if they are not present.

Parameters

pOther Another array.

Definition at line 388 of file fbxarray.h.

     {
         for( int i = 0, c = pOther.mSize; i < c; ++i )
         {
             AddUnique(pOther[i]);
         }
     }

◆ RemoveArray()

void RemoveArray ( const FbxArray< T > & pOther )

inline

Remove the elements of another array from this array is they are present.

Parameters

pOther Another array.

Definition at line 398 of file fbxarray.h.

     {
         for( int i = 0, c = pOther.mSize; i < c; ++i )
         {
             RemoveIt(pOther[i]);
         }
     }

◆ operator=()

FbxArray<T>& operator= ( const FbxArray< T > & pOther )

inline

Operator to copy elements of an array.

Returns: this array containing a copy of pOther elements.

Definition at line 408 of file fbxarray.h.

     {
         if( this != &pOther )
         {
             if( Resize(pOther.mSize) )
             {
                 memcpy(mArray, pOther.mArray, pOther.mSize * sizeof(T));
             }
         }
         return *this;
     }

◆ operator==()

bool operator== ( const FbxArray< T > & pOther ) const

inline

Operator to compare elements of an array.

Returns: true if the two arrays are equal, otherwise false.

Definition at line 422 of file fbxarray.h.

     {
         if( this == &pOther ) return true;
         if( mSize != pOther.mSize ) return false;
         return memcmp(mArray, pOther.mArray, sizeof(T) * mSize) == 0;
     }

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

fbxsdk/core/base/fbxarray.h

Class Description

template<class T> class FbxArray< T >

Public Types

Public Member Functions

Member Typedef Documentation

◆ CompareFunc

Constructor & Destructor Documentation

◆ FbxArray() [1/3]

◆ FbxArray() [2/3]

◆ FbxArray() [3/3]

◆ ~FbxArray()

Member Function Documentation

◆ InsertAt()

◆ Add()

◆ AddUnique()

◆ AddCompact()

◆ Size()

◆ Capacity()

◆ operator[]()

◆ GetAt()

◆ GetFirst()

◆ GetLast()

◆ Find()

◆ FindReverse()

◆ Reserve()

◆ SetAt()

◆ SetFirst()

◆ SetLast()

◆ RemoveAt()

◆ RemoveFirst()

◆ RemoveLast()

◆ RemoveIt()

◆ RemoveRange()

◆ Resize()

◆ Grow()

◆ Shrink()

◆ Compact()

◆ Clear()

◆ Sort()

◆ GetArray()

◆ operator T*()

◆ AddArray()

◆ AddArrayNoDuplicate()

◆ RemoveArray()

◆ operator=()

◆ operator==()

template<class T>
class FbxArray< T >