FbxLayerElementArray Class Reference

FbxLayerElementArray is the base class for FbxLayerElementArrayTemplate, it provides lock handling and data array manipulation of the data buffer for FbxLayerElement. More...

#include <fbxlayer.h>

Inheritance diagram for FbxLayerElementArray:

Public Types
enum	ELockMode { eReadLock = 1, eWriteLock = 2, eReadWriteLock = 3 }
	Identifies the access mode to the data buffer. More...

Public Member Functions
bool	IsInUse () const
	Returns whether this Array is accessed in any way. More...
int	ReadLock () const
	Increments the number of read locks on this array. More...
int	ReadUnlock () const
	Releases a read lock on this array. More...
bool	WriteLock () const
	Locks this array for writing. More...
void	WriteUnlock () const
	Releases the write lock on this array. More...
bool	ReadWriteLock () const
	Locks this array for writing. More...
void	ReadWriteUnlock () const
	Releases the write lock on this array. More...
virtual void *	GetLocked (ELockMode pLockMode, EFbxType pDataType)
	Grants a locked access to the data buffer. More...
void *	GetLocked (ELockMode pLockMode=eReadWriteLock)
	Grants a locked access to the data buffer. More...
template<class T >
T *	GetLocked (T *, ELockMode pLockMode=eReadWriteLock)
	Grants a locked access to the data buffer. More...
virtual void	Release (void **pDataPtr, EFbxType pDataType)
	Unlock the data buffer. More...
void	Release (void **pDataPtr)
	Unlock the data buffer. More...
template<class T >
void	Release (T **pDataPtr, T *dummy)
	Unlock the data buffer. More...
virtual size_t	GetStride () const
	Returns the Stride size which equals the size of the data type of the data buffer. More...

Protected Member Functions
void *	GetDataPtr ()
void *	GetReference (int pIndex, EFbxType pValueType)
void	GetReferenceTo (int pIndex, void **pRef, EFbxType pValueType)
void	SetStatus (LockAccessStatus::ELockAccessStatus pVal) const
void	SetImplementation (void *pImplementation)
void *	GetImplementation ()
virtual void	ConvertDataType (EFbxType pDataType, void **pDataPtr, size_t *pStride)

Protected Attributes
EFbxType	mDataType

Constructor and Destructor
	FbxLayerElementArray (EFbxType pDataType)
	Constructor. More...
virtual	~FbxLayerElementArray ()
	Destructor. More...

Status handling
void	ClearStatus ()
	Clears the access state and sets it to eSuccess. More...
LockAccessStatus::ELockAccessStatus	GetStatus () const
	Retrieves the access state. More...

Locks handling
bool	IsWriteLocked () const
	Returns whether write is locked. More...
int	GetReadLockCount () const
	Retrieves the read lock count. More...

Data array manipulation
int	GetCount () const
	Returns the count of items in the data buffer. More...
bool	SetCount (int pCount, EFbxMemoryClearMode pInitializeMode=eClearToZero)
	Sets the count of items in the data buffer. More...
void	Clear ()
	Clears the data buffer. More...
bool	Resize (int pItemCount, EFbxMemoryClearMode pInitializeMode=eClearToZero)
	Resizes the data buffer. More...
bool	AddMultiple (int pItemCount, EFbxMemoryClearMode pInitializeMode=eClearToZero)
	Appends space to the data buffer. More...
int	Add (const void *pItem, EFbxType pValueType)
	Appends a new item to the end of the data buffer. More...
int	InsertAt (int pIndex, const void *pItem, EFbxType pValueType)
	Inserts a new item at the specified position of the data buffer. More...
void	SetAt (int pIndex, const void *pItem, EFbxType pValueType)
	Sets the value for the specified item. More...
void	SetLast (const void *pItem, EFbxType pValueType)
	Sets the value of the last item. More...
void	RemoveAt (int pIndex, void **pItem, EFbxType pValueType)
	Removes the specified item from the data buffer. More...
void	RemoveLast (void **pItem, EFbxType pValueType)
	Removes the last item from the data buffer. More...
bool	RemoveIt (void **pItem, EFbxType pValueType)
	Removes one item from the data buffer. More...
bool	GetAt (int pIndex, void **pItem, EFbxType pValueType) const
	Returns the specified item's value. More...
bool	GetFirst (void **pItem, EFbxType pValueType) const
	Returns the first item's value. More...
bool	GetLast (void **pItem, EFbxType pValueType) const
	Returns the last item's value. More...
int	Find (const void *pItem, EFbxType pValueType) const
	Searches for an item in the data buffer. More...
int	FindAfter (int pAfterIndex, const void *pItem, EFbxType pValueType) const
	Searches for an item after the specified index in the data buffer. More...
int	FindBefore (int pBeforeIndex, const void *pItem, EFbxType pValueType) const
	Searches for an item before the specified index in the data buffer. More...
bool	IsEqual (const FbxLayerElementArray &pArray) const
	Equivalence operator. More...
template<class T >
int	Add (T const &pItem)
	Appends a new item to the end of the data buffer. More...
template<class T >
int	InsertAt (int pIndex, T const &pItem)
	Inserts a new item at the specified position of the data buffer. More...
template<class T >
void	SetAt (int pIndex, T const &pItem)
	Sets the value of the specified item. More...
template<class T >
void	SetLast (T const &pItem)
	Sets the value of the last item. More...
template<class T >
void	RemoveAt (int pIndex, T *pItem)
	Removes the specified item from the data buffer. More...
template<class T >
void	RemoveLast (T *pItem)
	Removes the last item from the data buffer. More...
template<class T >
bool	RemoveIt (T *pItem)
	Removes one item from the data buffer. More...
template<class T >
bool	GetAt (int pIndex, T *pItem) const
	Returns the specified item's value. More...
template<class T >
bool	GetFirst (T *pItem) const
	Returns the first item's value. More...
template<class T >
bool	GetLast (T *pItem) const
	Returns the last item's value. More...
template<class T >
int	Find (T const &pItem) const
	Searches for an item in the data buffer. More...
template<class T >
int	FindAfter (int pAfterIndex, T const &pItem) const
	Searches for an item after the specified index in the data buffer. More...
template<class T >
int	FindBefore (int pBeforeIndex, T const &pItem) const
	Searches for one item before the specified index in the data buffer. More...
template<typename T >
void	CopyTo (FbxArray< T > &pDst)
	Copies the items in the data buffer to an array. More...

Detailed Description

FbxLayerElementArray is the base class for FbxLayerElementArrayTemplate, it provides lock handling and data array manipulation of the data buffer for FbxLayerElement.

Definition at line 338 of file fbxlayer.h.

Member Enumeration Documentation

enum ELockMode

Identifies the access mode to the data buffer.

• eReadLock Read mode.
• eWriteLock Write mode.
• eReadWriteLock Read-write mode.

Enumerator
eReadLock
eWriteLock
eReadWriteLock

Definition at line 425 of file fbxlayer.h.

    {
        eReadLock = 1,
        eWriteLock = 2,
        eReadWriteLock = 3
    };

Constructor & Destructor Documentation

FbxLayerElementArray

(

EFbxType

pDataType

)

Constructor.

Parameters

pDataType

The data type of the items in the data array.

virtual ~FbxLayerElementArray ( )

virtual

Destructor.

Member Function Documentation

void ClearStatus ( )

inline

Clears the access state and sets it to eSuccess.

Definition at line 362 of file fbxlayer.h.

{ mStatus = LockAccessStatus::eSuccess; }

LockAccessStatus::ELockAccessStatus GetStatus ( ) const

inline

Retrieves the access state.

Definition at line 365 of file fbxlayer.h.

{ return mStatus; }

bool IsWriteLocked ( ) const

inline

Returns whether write is locked.

Returns

True if write is locked, false otherwise.

Definition at line 376 of file fbxlayer.h.

{ return mWriteLock; };

int GetReadLockCount ( ) const

inline

Retrieves the read lock count.

Returns

The read lock count.

Definition at line 381 of file fbxlayer.h.

{ return mReadLockCount; }

bool IsInUse

(

)

const

Returns whether this Array is accessed in any way.

Returns

True if it is in use, false otherwise.

int ReadLock

(

)

const

Increments the number of read locks on this array.

Returns

The current number of read locks (including the one just grabbed) or 0 if a write lock is active.

int ReadUnlock

(

)

const

Releases a read lock on this array.

Returns

The remaining read locks or -1 if a write lock is active.

bool WriteLock

(

)

const

Locks this array for writing.

The data in the array is wiped out.

Returns

True if a write lock has been successfully granted, false if one or more read locks are active.

void WriteUnlock

(

)

const

Releases the write lock on this array.

bool ReadWriteLock

(

)

const

Locks this array for writing.

The data that already exists in the array is kept and is valid.

Returns

True if a write lock has been successfully granted, false if one or more read locks are active.

void ReadWriteUnlock

(

)

const

Releases the write lock on this array.

virtual void* GetLocked ( ELockMode  pLockMode, EFbxType  pDataType  )

virtual

Grants a locked access to the data buffer.

Parameters

pLockMode	Access mode to the data buffer.
pDataType	If defined, tries to return the data as this type.

Returns

A pointer to the data buffer or NULL if a failure occurs.

Remarks

In the case of a failure, the Status is updated with the reason for the failure. Also, when a type conversion occurs, a second buffer of the new type is allocated. In this case, the LockMode does not apply to the returned buffer since it is a copy but it does apply to the internal data of this object. The returned buffer still remains a property of this object and is deleted when the pointer is released or the object is destroyed. At the moment of release or destruction, the values in this buffer are copied back into this object.

void* GetLocked ( ELockMode  pLockMode = eReadWriteLock )

inline

Grants a locked access to the data buffer.

Parameters

pLockMode

Access mode to the data buffer.

Returns

A pointer to the data buffer or NULL if a failure occurs.

Remarks

In the case of a failure, the Status is updated with the reason for the failure. Also, when a type conversion occurs, a second buffer of the new type is allocated. In this case, the LockMode does not apply to the returned buffer since it is a copy but it does apply to the internal data of this object. The returned buffer still remains a property of this object and is deleted when the pointer is released or the object is destroyed. At the moment of release or destruction, the values in this buffer are copied back into this object.

Definition at line 457 of file fbxlayer.h.

{ return GetLocked(pLockMode, mDataType); }

T* GetLocked ( T *  , ELockMode  pLockMode = eReadWriteLock  )

inline

Grants a locked access to the data buffer.

Parameters

pLockMode

Access mode to the data buffer.

Returns

A pointer to the data buffer or NULL if a failure occurs.

Remarks

In the case of a failure, the Status is updated with the reason for the failure. Also, when a type conversion occurs, a second buffer of the new type is allocated. In this case, the LockMode does not apply to the returned buffer since it is a copy but it does apply to the internal data of this object. The returned buffer still remains a property of this object and is deleted when the pointer is released or the object is destroyed. At the moment of release or destruction, the values in this buffer are copied back into this object.

Definition at line 470 of file fbxlayer.h.

{T v; return (T*)GetLocked(pLockMode, FbxTypeOf(v)); }

virtual void Release ( void **  pDataPtr, EFbxType  pDataType  )

virtual

Unlock the data buffer.

Parameters

pDataPtr	The buffer to be released.
pDataType	The data type of the data buffer.

Remarks

The passed pointer must be the one obtained by the call to GetLocked(). Any other pointer causes this method to fail and the Status is updated with the reason for the failure. If the passed pointer refers a converted data buffer (see comment of GetLocked), this method copies the GetCount() items of the received buffer back into this object. Any other items that may have been added using a realloc call are ignored.

void Release ( void **  pDataPtr )

inline

Unlock the data buffer.

Parameters

pDataPtr

The buffer to be released.

Remarks

The passed pointer must be the one obtained by the call to GetLocked(). Any other pointer causes this method to fail and the Status is updated with the reason for the failure. If the passed pointer refers a converted data buffer (see comment of GetLocked), this method copies the GetCount() items of the received buffer back into this object. Any other items that may have been added using a realloc call are ignored.

Definition at line 493 of file fbxlayer.h.

{ Release(pDataPtr, mDataType); }

void Release ( T **  pDataPtr, T *  dummy  )

inline

Unlock the data buffer.

Parameters

pDataPtr	The buffer to be released.
dummy	The data type of dummy is used to specialize this function.

Remarks

The passed pointer must be the one obtained by the call to GetLocked(). Any other pointer causes this method to fail and the Status is updated with the reason for the failure. If the passed pointer refers a converted data buffer (see comment of GetLocked), this method copies the GetCount() items of the received buffer back into this object. Any other items that may have been added using a realloc call are ignored.

Definition at line 505 of file fbxlayer.h.

    { 
        T*** voidPtr = &pDataPtr;
        Release((void**)*voidPtr, FbxTypeOf(*dummy));
    }

virtual size_t GetStride ( ) const

virtual

Returns the Stride size which equals the size of the data type of the data buffer.

int GetCount

(

)

const

Returns the count of items in the data buffer.

bool SetCount	(	int	pCount,
		EFbxMemoryClearMode	pInitializeMode = eClearToZero
	)

Sets the count of items in the data buffer.

Parameters

pCount	The count of items to be set.
pInitializeMode	Whether to clear the memory of any newly created items.

Returns

True if the operation is successful and False if an error occurred.

void Clear

(

)

Clears the data buffer.

bool Resize	(	int	pItemCount,
		EFbxMemoryClearMode	pInitializeMode = eClearToZero
	)

Resizes the data buffer.

Parameters

pItemCount

The new size of the data buffer.

Returns

True if the operation is successful and False if an error occurred.

bool AddMultiple	(	int	pItemCount,
		EFbxMemoryClearMode	pInitializeMode = eClearToZero
	)

Appends space to the data buffer.

Parameters

pItemCount

The appended space size

Returns

True if the operation is successful and False if an error occurred.

int Add	(	const void *	pItem,
		EFbxType	pValueType
	)

Appends a new item to the end of the data buffer.

Parameters

pItem	Pointer of the new item to be added
pValueType	Data type of the new item

Returns

The index of the new item

int InsertAt	(	int	pIndex,
		const void *	pItem,
		EFbxType	pValueType
	)

Inserts a new item at the specified position of the data buffer.

Parameters

pIndex	The specified position
pItem	Pointer of the new item to be inserted
pValueType	Data type of the new item

Returns

The index of the inserted item

Remarks

The input index must be within valid range and no error will be thrown if it is invalid.

void SetAt	(	int	pIndex,
		const void *	pItem,
		EFbxType	pValueType
	)

Sets the value for the specified item.

Parameters

pIndex	The index of the item to be updated.
pItem	Pointer of the item whose value is copied to pIndex'th item
pValueType	Data type of the item

Remarks

The input index must be within valid range and no error will be thrown if it is invalid.

void SetLast	(	const void *	pItem,
		EFbxType	pValueType
	)

Sets the value of the last item.

Parameters

pItem	Pointer of the item whose value is copied to the last item
pValueType	Data type of the item

Remarks

The array should contain at least one item and no error will be thrown if it is empty.

void RemoveAt	(	int	pIndex,
		void **	pItem,
		EFbxType	pValueType
	)

Removes the specified item from the data buffer.

Parameters

pIndex	The index of the item to be removed
pItem	Place to hold the value of the removed item.
pValueType	Data type of the item

Remarks

The input index must be within valid range and no error will be thrown if it is invalid.

void RemoveLast	(	void **	pItem,
		EFbxType	pValueType
	)

Removes the last item from the data buffer.

Parameters

pItem	Place to hold the value of the removed item.
pValueType	Data type of the item

Remarks

The array should contain at least one item and no error will be thrown if it is empty.

bool RemoveIt	(	void **	pItem,
		EFbxType	pValueType
	)

Removes one item from the data buffer.

Parameters

pItem	The first item who equals pItem is to be removed
pValueType	Data type of the item

Returns

True if the item is removed successfully, false otherwise

bool GetAt	(	int	pIndex,
		void **	pItem,
		EFbxType	pValueType
	)		const

Returns the specified item's value.

Parameters

pIndex	Index of the item
pItem	Place to hold the item's value
pValueType	Data type of the item

Returns

True if the item's value is returned successfully, false otherwise

Remarks

If the index is invalid, pItem is set to zero.

bool GetFirst	(	void **	pItem,
		EFbxType	pValueType
	)		const

Returns the first item's value.

Parameters

pItem	Place to hold the item's value
pValueType	Data type of the item

Returns

True if the item's value is returned successfully, false otherwise

bool GetLast	(	void **	pItem,
		EFbxType	pValueType
	)		const

Returns the last item's value.

Parameters

pItem	Place to hold the item's value
pValueType	Data type of the item

Returns

True if the item's value is returned successfully, false otherwise

int Find	(	const void *	pItem,
		EFbxType	pValueType
	)		const

Searches for an item in the data buffer.

Parameters

pItem	The value of the item for which to search.
pValueType	Data type of the item

Returns

The index of the item found, -1 if not found.

Remarks

The index of the first item whose value equals pItem is returned.

int FindAfter	(	int	pAfterIndex,
		const void *	pItem,
		EFbxType	pValueType
	)		const

Searches for an item after the specified index in the data buffer.

Parameters

pAfterIndex	The specified index after which the searching begins
pItem	The value of the item for which to search, the searching begins after pAfterIndex.
pValueType	Data type of the item

Returns

The index of the item found, -1 if not found.

Remarks

The index of the first item whose value equals pItem is returned.

int FindBefore	(	int	pBeforeIndex,
		const void *	pItem,
		EFbxType	pValueType
	)		const

Searches for an item before the specified index in the data buffer.

Parameters

pBeforeIndex	The specified index before which the searching begins
pItem	The value of the item for which to search, the searching begins before pBeforeIndex.
pValueType	The item's data type.

Returns

The index of the item found, -1 if not found.

Remarks

The index of the first item whose value equals pItem is returned.

bool IsEqual

(

const FbxLayerElementArray &

pArray

)

const

Equivalence operator.

Parameters

pArray

Array compared to this one

Returns

True if equal. false otherwise.

int Add ( T const &  pItem )

inline

Appends a new item to the end of the data buffer.

Parameters

pItem

The new item to be added

Returns

The index of the new item

Definition at line 657 of file fbxlayer.h.

{ return Add((const void*)&pItem, FbxTypeOf(pItem)); }

int InsertAt ( int  pIndex, T const &  pItem  )

inline

Inserts a new item at the specified position of the data buffer.

Parameters

pIndex	The specified position
pItem	The new item to be inserted

Returns

The index of the inserted item

Remarks

The input index must be within valid range and no error will be thrown if it is invalid.

Definition at line 665 of file fbxlayer.h.

{ return InsertAt(pIndex, (const void*)&pItem, FbxTypeOf(pItem)); }

void SetAt ( int  pIndex, T const &  pItem  )

inline

Sets the value of the specified item.

Parameters

pIndex	The index of the item to be updated.
pItem	The item whose value is copied to pIndex'th item

Remarks

The input index must be within valid range and no error will be thrown if it is invalid.

Definition at line 672 of file fbxlayer.h.

{ SetAt(pIndex, (const void*)&pItem, FbxTypeOf(pItem)); }

void SetLast ( T const &  pItem )

inline

Sets the value of the last item.

Parameters

pItem

The item whose value is copied to the last item

Remarks

The array should contain at least one item and no error will be thrown if it is empty.

Definition at line 678 of file fbxlayer.h.

{ SetLast((const void*)&pItem, FbxTypeOf(pItem)); }

void RemoveAt ( int  pIndex, T *  pItem  )

inline

Removes the specified item from the data buffer.

Parameters

pIndex	The index of the item to be removed
pItem	Place to hold the value of the removed item.

Remarks

The input index must be within valid range and no error will be thrown if it is invalid.

Definition at line 685 of file fbxlayer.h.

    { 
        T** voidPtr = &pItem;
        RemoveAt(pIndex, (void**)voidPtr, FbxTypeOf(*pItem));
    }

void RemoveLast ( T *  pItem )

inline

Removes the last item from the data buffer.

Parameters

pItem

Place to hold the value of the removed item.

Remarks

The array should contain at least one item and no error will be thrown if it is empty.

Definition at line 695 of file fbxlayer.h.

    { 
        T** voidPtr = &pItem;
        RemoveLast((void**)voidPtr, FbxTypeOf(*pItem));
    }

bool RemoveIt ( T *  pItem )

inline

Removes one item from the data buffer.

Parameters

pItem

The first item who equals pItem is to be removed

Returns

True if the item is removed successfully, false otherwise

Definition at line 705 of file fbxlayer.h.

    { 
        T** voidPtr = &pItem;
        return RemoveIt((void**)voidPtr, FbxTypeOf(*pItem));
    }

bool GetAt ( int  pIndex, T *  pItem  ) const

inline

Returns the specified item's value.

Parameters

pIndex	Index of the item
pItem	Place to hold the item's value

Returns

True if the item's value is returned successfully, false otherwise

Remarks

If the index is invalid, pItem is set to zero.

Definition at line 717 of file fbxlayer.h.

    { 
        T** voidPtr = &pItem;
        return GetAt(pIndex, (void**)voidPtr, FbxTypeOf(*pItem));
    }

bool GetFirst ( T *  pItem ) const

inline

Returns the first item's value.

Parameters

pItem

Place to hold the item's value

Returns

True if the item's value is returned successfully, false otherwise

Definition at line 727 of file fbxlayer.h.

    { 
        T** voidPtr = &pItem;
        return GetFirst((void**)voidPtr, FbxTypeOf(*pItem));
    }

bool GetLast ( T *  pItem ) const

inline

Returns the last item's value.

Parameters

pItem

Place to hold the item's value

Returns

True if the item's value is returned successfully, false otherwise

Definition at line 737 of file fbxlayer.h.

    { 
        T** voidPtr = &pItem;
        return GetLast((void**)voidPtr, FbxTypeOf(*pItem));
    }

int Find ( T const &  pItem ) const

inline

Searches for an item in the data buffer.

Parameters

pItem

The value of the item for which to search.

Returns

The index of the item found, -1 if not found.

Remarks

The index of the first item whose value equals pItem is returned.

Definition at line 748 of file fbxlayer.h.

{ return Find((const void*)&pItem, FbxTypeOf(pItem)); }

int FindAfter ( int  pAfterIndex, T const &  pItem  ) const

inline

Searches for an item after the specified index in the data buffer.

Parameters

pAfterIndex	The specified index after which the searching begins
pItem	The value of the item for which to search, the searching begins after pAfterIndex.

Returns

The index of the item found, -1 if not found.

Remarks

The index of the first item whose value equals pItem is returned.

Definition at line 756 of file fbxlayer.h.

{ return FindAfter(pAfterIndex, (const void*)&pItem, FbxTypeOf(pItem)); }

int FindBefore ( int  pBeforeIndex, T const &  pItem  ) const

inline

Searches for one item before the specified index in the data buffer.

Parameters

pBeforeIndex	The specified index before which the searching begins
pItem	The value of the item for which to search, the searching begins before pBeforeIndex.

Returns

The index of the item found, -1 if not found.

Remarks

The index of the first item whose value equals pItem is returned.

Definition at line 764 of file fbxlayer.h.

{ return FindBefore(pBeforeIndex, (const void*)&pItem, FbxTypeOf(pItem)); }

void CopyTo ( FbxArray< T > &  pDst )

inline

Copies the items in the data buffer to an array.

Parameters

pDst	The destination array where the items are to be copied.

Definition at line 770 of file fbxlayer.h.

    {
        T src;
        T* srcPtr = &src;

        pDst.Clear();
        if (mDataType != FbxTypeOf(src))
        {
            SetStatus(LockAccessStatus::eUnsupportedDTConversion);
            return;
        }

        pDst.Resize(GetCount());
        for (int i = 0; i < GetCount(); i++)
        {
            if (GetAt(i, (void**)&srcPtr, mDataType))
            {
                pDst.SetAt(i, src);
            }
        }
        SetStatus(LockAccessStatus::eSuccess);
    }

void* GetDataPtr ( )

protected

void* GetReference ( int  pIndex, EFbxType  pValueType  )

protected

void GetReferenceTo ( int  pIndex, void **  pRef, EFbxType  pValueType  )

protected

void SetStatus ( LockAccessStatus::ELockAccessStatus  pVal ) const

inlineprotected

Definition at line 799 of file fbxlayer.h.

    {
        const_cast<FbxLayerElementArray*>(this)->mStatus = pVal;
    }

void SetImplementation ( void *  pImplementation )

protected

void* GetImplementation ( )

inlineprotected

Definition at line 805 of file fbxlayer.h.

{ return mImplementation; }

virtual void ConvertDataType ( EFbxType  pDataType, void **  pDataPtr, size_t *  pStride  )

protectedvirtual

Member Data Documentation

EFbxType mDataType

protected

Definition at line 808 of file fbxlayer.h.

---

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

• fbxsdk/scene/geometry/fbxlayer.h