KFbxLayerElementTemplate Class Template Reference

#include <kfbxlayer.h>
Inheritance diagram for KFbxLayerElementTemplate:
Inheritance graph
[legend]

List of all members.

Detailed Description

template<class Type>
class KFbxLayerElementTemplate< Type >

This class complements the KFbxLayerElement class.

It provides interfaces to access the direct array and index array of different layer elements.

Definition at line 1037 of file kfbxlayer.h.


Public Member Functions
KFbxLayerElementArrayTemplate
< Type > & 		 GetDirectArray () const
  Returns the direct array of Layer Elements.
KFbxLayerElementArrayTemplate
< Type > & 		 GetDirectArray ()
  Returns the direct array of Layer Elements.
KFbxLayerElementArrayTemplate
< int > & 		 GetIndexArray () const
  Returns the index array of Layer Elements.
KFbxLayerElementArrayTemplate
< int > & 		 GetIndexArray ()
  Returns the index array of Layer Elements.
bool  Clear ()
  Removes all elements from the direct and the index arrays.
bool  operator== (const KFbxLayerElementTemplate &pOther) const
  Equivalence operator.
KFbxLayerElementTemplate &  operator= (KFbxLayerElementTemplate const &pOther)
  Assignment operator.
int  RemapIndexTo (KFbxLayerElement::EMappingMode pNewMapping)
  Changes the Mapping mode to the new one and re-computes the index array.

Member Function Documentation

KFbxLayerElementArrayTemplate<Type>& GetDirectArray (  )  const [inline]

Returns the direct array of Layer Elements.

Returns:
A reference to the Layer Elements direct array.
Remarks:
You cannot put elements in the direct array when the mapping mode is set to eINDEX.

Definition at line 1045 of file kfbxlayer.h.

Referenced by KFbxLayerElementUserData::Clear(), KFbxLayerElementUserData::GetArrayCount(), KFbxLayerElementUserData::GetDirectArrayCount(), KFbxLayerElementUserData::GetDirectArrayVoid(), KFbxLayerElementUserData::operator=(), KFbxLayerElementTemplate< KFbxSurfaceMaterial * >::operator=(), KFbxLayerElementTemplate< KFbxSurfaceMaterial * >::operator==(), KFbxLayerElementUserData::RemoveFromAllDirectArrays(), and KFbxLayerElementUserData::ResizeAllDirectArrays().

KFbxLayerElementArrayTemplate<Type>& GetDirectArray (  )  [inline]

Returns the direct array of Layer Elements.

Returns:
A reference to the Layer Elements direct array.
Remarks:
You cannot put elements in the direct array when the mapping mode is set to eINDEX.

Definition at line 1055 of file kfbxlayer.h.

KFbxLayerElementArrayTemplate<int>& GetIndexArray (  )  const [inline]

Returns the index array of Layer Elements.

Returns:
A reference to the index array.
Remarks:
You cannot put elements in the index array when the mapping mode is set to eDIRECT.

Definition at line 1065 of file kfbxlayer.h.

Referenced by KFbxLayerElementUserData::operator=(), KFbxLayerElementTemplate< KFbxSurfaceMaterial * >::operator=(), and KFbxLayerElementTemplate< KFbxSurfaceMaterial * >::operator==().

KFbxLayerElementArrayTemplate<int>& GetIndexArray (  )  [inline]

Returns the index array of Layer Elements.

Returns:
A reference to the index array.
Remarks:
You cannot put elements in the index array when the mapping mode is set to eDIRECT.

Definition at line 1075 of file kfbxlayer.h.

bool Clear (  )  [inline, virtual]

Removes all elements from the direct and the index arrays.

Remarks:
This function fails if there is a lock on the arrays.
Returns:
True if successful, false if a lock is present.

Reimplemented from KFbxLayerElement.

Reimplemented in KFbxLayerElementUserData.

Definition at line 1085 of file kfbxlayer.h.

Referenced by KFbxLayerElementUserData::Clear(), and KFbxLayerElementUserData::operator=().

bool operator== ( const KFbxLayerElementTemplate< Type > &  pOther  )  const [inline]

Equivalence operator.

Parameters:
pOther  Another element compared to this object
Returns:
True if equal, false if unequal.

Definition at line 1103 of file kfbxlayer.h.

KFbxLayerElementTemplate& operator= ( KFbxLayerElementTemplate< Type > const &  pOther  )  [inline]

Assignment operator.

Parameters:
pOther  Another element assigned to this one

Definition at line 1153 of file kfbxlayer.h.

int RemapIndexTo ( KFbxLayerElement::EMappingMode  pNewMapping  )  [inline]

Changes the Mapping mode to the new one and re-computes the index array.

Parameters:
pNewMapping  New mapping mode.
Returns:
If the remapping is successful, returns 1. If an error occurs, returns 0. In case the function cannot remap to the desired mode because of incompatible modes or unsupported modes, returns -1.

Definition at line 1185 of file kfbxlayer.h.