KFbxLayerElementUserData
#include<kfbxlayer.h>

Inheritance diagram for KFbxLayerElementUserData:

Inheritance graph
[legend]

List of all members.

Detailed Description

layer element UserData class

Definition at line1023of filekfbxlayer.h.


Constructor and Destructor.

 KFbxLayerElementUserData(int pId, KArrayTemplate<KFbxDataType>&pDataTypes, KArrayTemplate<const char *>&pDataNames)
 Constructs a user data layer element.
 KFbxLayerElementUserData(KFbxLayerElementUserDataconst&pOther)
 Copy constructor.
 ~KFbxLayerElementUserData()
 Destructor.

Public Member Functions

KFbxLayerElementArrayTemplate
<void *>* 
GetDirectArrayVoid(int pIndex, bool *pStatus=NULL)
 Gets the direct array with the given attribute index.
KFbxLayerElementArrayTemplate
<void *>const * 
GetDirectArrayVoid(int pIndex, bool *pStatus=NULL) const
 Gets the direct array with the given attribute index.
KFbxLayerElementArrayTemplate
<void *>* 
GetDirectArrayVoid(const char *pName, bool *pStatus=NULL)
 Gets the direct array with the given attribute name.
KFbxLayerElementArrayTemplate
<void *>const * 
GetDirectArrayVoid(const char *pName, bool *pStatus=NULL) const
 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.
KFbxLayerElementUserDataoperator=(KFbxLayerElementUserDataconst&pOther)
 Assignment does a deep copy.
void Clear()
 Clears all of the data from this layer element.

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 line1330of filekfbxlayer.h.

KFbxLayerElementUserData(KFbxLayerElementUserDataconst& pOther ) [inline, protected]

Copy constructor.

A deep copy is made.

Parameters:
pOther AnotherKFbxLayerElementUserDataobject to be copied.

Definition at line1345of filekfbxlayer.h.

~KFbxLayerElementUserData( ) [inline, protected]

Destructor.

Definition at line1351of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::Clear().

Member Function Documentation

KFbxLayerElementArrayTemplate<void*>* GetDirectArrayVoid(int pIndex,
bool * pStatus=NULL 
)[inline]

Gets the direct array with the given attribute index.

Parameters:
pIndex Given attribute index.
pStatus 
Returns:
direct array.

Definition at line1035of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::GetDirectArray().

Referenced byKFbxGetDirectArray().

KFbxLayerElementArrayTemplate<void*>const* GetDirectArrayVoid(int pIndex,
bool * pStatus=NULL 
)const[inline]

Gets the direct array with the given attribute index.

Parameters:
pIndex Given attribute index.
pStatus 
Returns:
direct array.

Definition at line1055of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::GetDirectArray().

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

Gets the direct array with the given attribute name.

Parameters:
pName Given attribute name.
pStatus 
Returns:
direct array.

Definition at line1076of filekfbxlayer.h.

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

Gets the direct array with the given attribute name.

Parameters:
pName Given attribute name.
pStatus 
Returns:
direct array.

Definition at line1094of filekfbxlayer.h.

KFbxDataTypeGetDataType(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 line1111of filekfbxlayer.h.

KFbxDataTypeGetDataType(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 line1123of filekfbxlayer.h.

const char* GetDataName(int pIndex ) const[inline]

Gets the attribute name at the given index.

Parameters:
pIndex Attribute index
Returns:
The name, orNULLif pIndex is out of range.

Definition at line1140of filekfbxlayer.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 line1151of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::GetDirectArray().

void RemoveFromAllDirectArrays(int pIndex ) [inline]

Removes a single element at pIndex from all direct arrays.

Parameters:
pIndex The index to remove.

Definition at line1173of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::GetDirectArray().

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 line1196of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::GetDirectArray().

int GetId( ) const[inline]

Query the id.

Returns:
The Id expressed as an int

Definition at line1220of filekfbxlayer.h.

int GetDirectArrayCount( ) const[inline]

Get the direct array count.

Returns:
The direct array count expressed as an int

Definition at line1225of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::GetDirectArray().

Referenced byoperator=().

KFbxLayerElementUserData&operator=(KFbxLayerElementUserDataconst& pOther ) [inline]

void Clear( ) [inline]

Clears all of the data from this layer element.

Reimplemented fromKFbxLayerElementTemplate<void *>.

Definition at line1286of filekfbxlayer.h.

ReferencesKFbxLayerElementTemplate::Clear(), andKFbxLayerElementTemplate::GetDirectArray().