KFbxLayerElementUserData Class Reference

Inherits KFbxLayerElementTemplate< void * >.

Inheritance diagram for KFbxLayerElementUserData:

List of all members.

---

Detailed Description

Definition at line 341 of file kfbxlayer.h.

Public Member Functions
	~KFbxLayerElementUserData ()
KArrayTemplate< void * > *	GetDirectArrayVoid (int pIndex, bool *pStatus=NULL)
KArrayTemplate< void * > *	GetDirectArrayVoid (const char *pName, bool *pStatus=NULL)
	Gets the direct array with the given attribute name.
KFbxDataType	GetDataType (int pIndex) const
	Gets the data type for the given index.
KFbxDataType	GetDataType (const char *pName) const
	Gets the data type for the given attribute.
const char *	GetDataName (int pIndex) const
	Gets the attribute name at the given index.
void	ResizeAllDirectArrays (int pSize)
	Resize all direct arrays to the given size.
void	RemoveFromAllDirectArrays (int pIndex)
	Removes a single element at pIndex from all direct arrays.
int	GetArrayCount (int pIndex) const
	Get the direct array count for the attribute at pIndex.
int	GetId () const
	Query the id.
int	GetDirectArrayCount () const
	Get the direct array count.
KFbxLayerElementUserData &	operator= (KFbxLayerElementUserData const &pOther)
	Assignment does a deep copy.
void	Clear ()
	Clears all of the data from this layer element.
Protected Member Functions
	KFbxLayerElementUserData (int pId, KArrayTemplate< KFbxDataType > &pDataTypes, KArrayTemplate< const char * > &pDataNames)
	Constructs a user data layer element.
	KFbxLayerElementUserData (KFbxLayerElementUserData const &pOther)

---

Constructor & Destructor Documentation

KFbxLayerElementUserData	(	int	pId,
		KArrayTemplate< KFbxDataType > &	pDataTypes,
		KArrayTemplate< const char * > &	pDataNames
	)			[inline, protected]

Constructs a user data layer element.

Parameters:

	pId	An indentifier for this UserData layer element
	pDataTypes	Attribute data types for this layer element
	pDataNames	Attribute names for this layer element

Definition at line 583 of file kfbxlayer.h.

References KBaseArray::GetCount(), and K_ASSERT.

---

Member Function Documentation

KArrayTemplate<void *>* GetDirectArrayVoid	(	const char *	pName,
		bool *	pStatus = NULL
	)			[inline]

Gets the direct array with the given attribute name.

Definition at line 373 of file kfbxlayer.h.

KFbxDataType GetDataType

(

int

pIndex

)

const [inline]

Gets the data type for the given index.

Parameters:

pIndex

The index of the attribute being queried

Returns:

The data type, or DTNone if pIndex is out of range

Definition at line 389 of file kfbxlayer.h.

KFbxDataType GetDataType

(

const char *

pName

)

const [inline]

Gets the data type for the given attribute.

Parameters:

pName

The name of the attribute being queried

Returns:

The data type, or DTNone if no attribute has the given name

Definition at line 401 of file kfbxlayer.h.

const char* GetDataName

(

int

pIndex

)

const [inline]

Gets the attribute name at the given index.

Parameters:

pIndex

Attribute index

Returns:

The name, or NULL if pIndex is out of range.

Definition at line 418 of file kfbxlayer.h.

void ResizeAllDirectArrays

(

int

pSize

)

[inline]

Resize all direct arrays to the given size.

Parameters:

pSize

The new size of the direct arrays.

Definition at line 429 of file kfbxlayer.h.

References K_ASSERT_MSG_NOW.

void RemoveFromAllDirectArrays

(

int

pIndex

)

[inline]

Removes a single element at pIndex from all direct arrays.

Parameters:

pIndex

The index to remove.

Definition at line 451 of file kfbxlayer.h.

References K_ASSERT_MSG_NOW.

int GetArrayCount

(

int

pIndex

)

const [inline]

Get the direct array count for the attribute at pIndex.

Parameters:

pIndex

The index to query

Returns:

The direct array count

Definition at line 474 of file kfbxlayer.h.

References K_ASSERT_MSG_NOW.

int GetId

(

)

const [inline]

Query the id.

Returns:

The Id expressed as an int

Definition at line 498 of file kfbxlayer.h.

int GetDirectArrayCount

(

)

const [inline]

Get the direct array count.

Returns:

The direct array count expressed as an int

Definition at line 503 of file kfbxlayer.h.

Referenced by operator=().

KFbxLayerElementUserData& operator=

(

KFbxLayerElementUserData const &

pOther

)

[inline]

Assignment does a deep copy.

Definition at line 506 of file kfbxlayer.h.

References KFbxLayerElementTemplate::Clear(), KBaseArray::GetCount(), GetDirectArrayCount(), K_ASSERT_MSG_NOW, mDataNames, mDataTypes, and mId.

void Clear

(

)

[inline]

Clears all of the data from this layer element.

Reimplemented from KFbxLayerElementTemplate< void * >.

Definition at line 547 of file kfbxlayer.h.

References KFbxLayerElementTemplate::Clear().