KFbxLayerElementArrayTemplate Class Template Reference

#include <kfbxlayer.h>

Inheritance diagram for KFbxLayerElementArrayTemplate:

[legend]

List of all members.

---

Detailed Description

template<class T>
class KFbxLayerElementArrayTemplate< T >

KFbxLayerElementArrayTemplate provides data array manipulation of the data buffer for KFbxLayerElement.

It is the subclass of KFbxLayerElementArray.

Definition at line 892 of file kfbxlayer.h.

Public Member Functions
	KFbxLayerElementArrayTemplate (EFbxType pDataType)
	Constructor.
int	Add (T const &pItem)
	Appends a new item to the end of the data buffer.
int	InsertAt (int pIndex, T const &pItem)
	Inserts a new item at the specified position of the data buffer.
void	SetAt (int pIndex, T const &pItem)
	Sets the value of the specified item.
void	SetLast (T const &pItem)
	Sets the value of the last item.
T	RemoveAt (int pIndex)
	Removes the specified item from the data buffer.
T	RemoveLast ()
	Removes the last item from the data buffer.
bool	RemoveIt (T const &pItem)
	Removes one item from the data buffer.
T	GetAt (int pIndex) const
	Returns the specified item's value.
T	GetFirst () const
	Returns the first item's value.
T	GetLast () const
	Returns the last item's value.
int	Find (T const &pItem)
	Searches for an item in the data buffer.
int	FindAfter (int pAfterIndex, T const &pItem)
	Searches for an item after the specified index in the data buffer.
int	FindBefore (int pBeforeIndex, T const &pItem)
	Searches for one item before the specified index in the data buffer.
T	operator[] (int pIndex) const
	Returns the specified item's value.
KFbxLayerElementArray &	operator= (const KArrayTemplate< T > &pArrayTemplate)
	Assignment operator.
KFbxLayerElementArrayTemplate < T > &	operator= (const KFbxLayerElementArrayTemplate< T > &pArrayTemplate)
	Assignment operator.
Friends
class	KFbxLayerElementUserData

---

Constructor & Destructor Documentation

KFbxLayerElementArrayTemplate

(

EFbxType

pDataType

)

[inline]

Constructor.

Parameters:

pDataType

The data type of the array items.

Definition at line 899 of file kfbxlayer.h.

---

Member Function Documentation

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

Reimplemented from KFbxLayerElementArray.

Definition at line 908 of file kfbxlayer.h.

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

Reimplemented from KFbxLayerElementArray.

Definition at line 915 of file kfbxlayer.h.

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

Reimplemented from KFbxLayerElementArray.

Definition at line 921 of file kfbxlayer.h.

Referenced by KFbxLayerElementArrayTemplate< KFbxSurfaceMaterial * >::operator=().

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

Reimplemented from KFbxLayerElementArray.

Definition at line 926 of file kfbxlayer.h.

T RemoveAt

(

int

pIndex

)

[inline]

Removes the specified item from the data buffer.

Parameters:

pIndex

The index of the item to be removed

Returns:

The value of the item removed

Definition at line 932 of file kfbxlayer.h.

T RemoveLast

(

)

[inline]

Removes the last item from the data buffer.

Returns:

The value of the last item removed

Definition at line 937 of file kfbxlayer.h.

bool RemoveIt

(

T const &

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 943 of file kfbxlayer.h.

T GetAt

(

int

pIndex

)

const [inline]

Returns the specified item's value.

Parameters:

pIndex

Index of the item

Returns:

The value of the specified item

Remarks:

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

Definition at line 950 of file kfbxlayer.h.

Referenced by KFbxLayerElementArrayTemplate< KFbxSurfaceMaterial * >::operator=().

T GetFirst

(

)

const [inline]

Returns the first item's value.

Returns:

The first item's value.

Definition at line 955 of file kfbxlayer.h.

T GetLast

(

)

const [inline]

Returns the last item's value.

Returns:

The last item's value.

Definition at line 960 of file kfbxlayer.h.

int Find

(

T const &

pItem

)

[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 967 of file kfbxlayer.h.

int FindAfter	(	int	pAfterIndex,
		T const &	pItem
	)			[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 975 of file kfbxlayer.h.

int FindBefore	(	int	pBeforeIndex,
		T const &	pItem
	)			[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 983 of file kfbxlayer.h.

T operator[]

(

int

pIndex

)

const [inline]

Returns the specified item's value.

Parameters:

pIndex

Index of the item

Returns:

The value of the item

Remarks:

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

Definition at line 990 of file kfbxlayer.h.

KFbxLayerElementArray& operator=

(

const KArrayTemplate< T > &

pArrayTemplate

)

[inline]

Assignment operator.

Parameters:

pArrayTemplate

The source array whose items are copied to this array.

Definition at line 995 of file kfbxlayer.h.

KFbxLayerElementArrayTemplate<T>& operator=

(

const KFbxLayerElementArrayTemplate< T > &

pArrayTemplate

)

[inline]

Assignment operator.

Parameters:

pArrayTemplate

The source array whose items are copied to this array.

Definition at line 1012 of file kfbxlayer.h.

---

Friends And Related Function Documentation

friend class KFbxLayerElementUserData [friend]

Definition at line 1033 of file kfbxlayer.h.