FbxLayerElementTemplate< Type > Class Template Reference

#include <fbxlayer.h>

Class Description

template<class Type>
class FbxLayerElementTemplate< Type >

This class complements the FbxLayerElement class.

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

Definition at line 1022 of file fbxlayer.h.

Inheritance diagram for FbxLayerElementTemplate< Type >:

Public Member Functions
FbxLayerElementArrayTemplate< Type > &	GetDirectArray () const
	Returns the direct array of Layer Elements. More...
FbxLayerElementArrayTemplate< Type > &	GetDirectArray ()
	Returns the direct array of Layer Elements. More...
FbxLayerElementArrayTemplate< int > &	GetIndexArray () const
	Returns the index array of Layer Elements. More...
FbxLayerElementArrayTemplate< int > &	GetIndexArray ()
	Returns the index array of Layer Elements. More...
bool	Clear ()
	Removes all elements from the direct and the index arrays. More...
bool	operator== (const FbxLayerElementTemplate &pOther) const
	Equivalence operator. More...
FbxLayerElementTemplate &	operator= (FbxLayerElementTemplate const &pOther)
	Assignment operator. More...
int	RemapIndexTo (FbxLayerElement::EMappingMode pNewMapping)
	Changes the Mapping mode to the new one and re-computes the index array. More...
Public Member Functions inherited from FbxLayerElement
void	SetMappingMode (EMappingMode pMappingMode)
	Sets the Mapping Mode. More...
void	SetReferenceMode (EReferenceMode pReferenceMode)
	Sets the Reference Mode. More...
EMappingMode	GetMappingMode () const
	Returns the Mapping Mode. More...
EReferenceMode	GetReferenceMode () const
	Returns the Reference Mode. More...
void	SetName (const char *pName)
	Sets the name of this object. More...
const char *	GetName () const
	Returns the name of this object. More...
bool	operator== (const FbxLayerElement &pOther) const
	Equivalence operator. More...
FbxLayerElement &	operator= (FbxLayerElement const &pOther)
	Assignment operator. More...
void	Destroy ()
	Removes this layer element from its owner and delete it. More...

Additional Inherited Members
Public Types inherited from FbxLayerElement
enum	EType {   eUnknown, eNormal, eBiNormal, eTangent,   eMaterial, ePolygonGroup, eUV, eVertexColor,   eSmoothing, eVertexCrease, eEdgeCrease, eHole,   eUserData, eVisibility, eTextureDiffuse, eTextureDiffuseFactor,   eTextureEmissive, eTextureEmissiveFactor, eTextureAmbient, eTextureAmbientFactor,   eTextureSpecular, eTextureSpecularFactor, eTextureShininess, eTextureNormalMap,   eTextureBump, eTextureTransparency, eTextureTransparencyFactor, eTextureReflection,   eTextureReflectionFactor, eTextureDisplacement, eTextureDisplacementVector, eTypeCount }
	Layer Element type identifier. More...
enum	EMappingMode {   eNone, eByControlPoint, eByPolygonVertex, eByPolygon,   eByEdge, eAllSame }
	Determines how the element is mapped to a surface. More...
enum	EReferenceMode { eDirect, eIndex, eIndexToDirect }
	Determines how the mapping information is stored in the array of coordinates. More...
Static Public Attributes inherited from FbxLayerElement
static const int	sTypeTextureStartIndex = int(eTextureDiffuse)
	The start index of texture type layer elements. More...
static const int	sTypeTextureEndIndex = int(eTypeCount) - 1
	The end index of texture type layer elements. More...
static const int	sTypeTextureCount = sTypeTextureEndIndex - sTypeTextureStartIndex + 1
	The count of texture type layer elements. More...
static const int	sTypeNonTextureStartIndex = int(eNormal)
	The start index of non-texture type layer elements. More...
static const int	sTypeNonTextureEndIndex = int(eVisibility)
	The end index of non-texture type layer elements. More...
static const int	sTypeNonTextureCount = sTypeNonTextureEndIndex - sTypeNonTextureStartIndex + 1
	The count of non-texture type layer elements. More...
static const char *const	sTextureNames []
	Array of names of texture type layer elements. More...
static const char *const	sTextureUVNames []
	Array of names of UV layer elements. More...
static const char *const	sNonTextureNames []
	Array of names of non-texture type layer elements. More...
static const FbxDataType	sTextureDataTypes []
	Array of texture types. More...
static const char *const	sTextureChannelNames []
	Array of texture channels. More...

Member Function Documentation

GetDirectArray() [1/2]

FbxLayerElementArrayTemplate<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 reference mode is set to eIndex.

Definition at line 1030 of file fbxlayer.h.

    { 
        FBX_ASSERT(mReferenceMode == FbxLayerElement::eDirect || mReferenceMode == FbxLayerElement::eIndexToDirect);
        return *mDirectArray; 
    }

GetDirectArray() [2/2]

FbxLayerElementArrayTemplate<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 reference mode is set to eIndex.

Definition at line 1040 of file fbxlayer.h.

    { 
        FBX_ASSERT(mReferenceMode == FbxLayerElement::eDirect || mReferenceMode == FbxLayerElement::eIndexToDirect);
        return *mDirectArray; 
    }

GetIndexArray() [1/2]

FbxLayerElementArrayTemplate<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 1050 of file fbxlayer.h.

    { 
        FBX_ASSERT(mReferenceMode == FbxLayerElement::eIndex || mReferenceMode == FbxLayerElement::eIndexToDirect);
        return *mIndexArray; 
    }

GetIndexArray() [2/2]

FbxLayerElementArrayTemplate<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 1060 of file fbxlayer.h.

    { 
        FBX_ASSERT(mReferenceMode == FbxLayerElement::eIndex || mReferenceMode == FbxLayerElement::eIndexToDirect);
        return *mIndexArray; 
    }

Clear()

bool Clear ( )

inlinevirtual

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 FbxLayerElement.

Definition at line 1070 of file fbxlayer.h.

    {
        bool ret = true;
        mDirectArray->Clear();
        ret = (mDirectArray->GetStatus() == LockAccessStatus::eSuccess);

        mIndexArray->Clear();
        ret |= (mIndexArray->GetStatus() == LockAccessStatus::eSuccess);

        return ret;
    }

operator==()

bool operator== ( const FbxLayerElementTemplate< Type > &  pOther ) const

inline

Equivalence operator.

Parameters

pOther

Another element compared to this object

Returns

True if equal, false if unequal.

Definition at line 1088 of file fbxlayer.h.

    {
        bool ret = true;

        if (pOther.GetReferenceMode() == FbxLayerElement::eDirect || 
            pOther.GetReferenceMode() == FbxLayerElement::eIndexToDirect)
        {
            const FbxLayerElementArrayTemplate<Type>& directArray = pOther.GetDirectArray();
            if( directArray.GetCount() != mDirectArray->GetCount() || 
                !directArray.ReadLock() || !mDirectArray->ReadLock() )
            {
                ret = false;
            }

            if( ret && !mDirectArray->IsEqual(directArray) )
                ret = false;

            directArray.ReadUnlock();
            mDirectArray->ReadUnlock();
        }

        if (ret)
        {
            if (pOther.GetReferenceMode() == FbxLayerElement::eIndex || 
                pOther.GetReferenceMode()  == FbxLayerElement::eIndexToDirect)
            {
                const FbxLayerElementArrayTemplate<int>& indexArray = pOther.GetIndexArray();
                if( indexArray.GetCount() != mIndexArray->GetCount() ||
                    !indexArray.ReadLock() || !mIndexArray->ReadLock() )
                {
                    ret = false;
                }

                if( ret && !mIndexArray->IsEqual(indexArray) )
                    ret = false;

                indexArray.ReadUnlock();
                mIndexArray->ReadUnlock();
            }
        }

        if (ret == false)
            return false;

        return FbxLayerElement::operator==(pOther);
    }

operator=()

FbxLayerElementTemplate& operator= ( FbxLayerElementTemplate< Type > const &  pOther )

inline

Assignment operator.

Parameters

pOther

Another element assigned to this one

Definition at line 1138 of file fbxlayer.h.

    {
        FBX_ASSERT(mDirectArray != NULL);
        FBX_ASSERT(mIndexArray != NULL);

        if (pOther.GetReferenceMode() == FbxLayerElement::eDirect || 
            pOther.GetReferenceMode() == FbxLayerElement::eIndexToDirect)
        {
            const FbxLayerElementArrayTemplate<Type>& directArray = pOther.GetDirectArray();
            *mDirectArray = directArray;
        }

        if (pOther.GetReferenceMode() == FbxLayerElement::eIndex || 
            pOther.GetReferenceMode()  == FbxLayerElement::eIndexToDirect)
        {
            const FbxLayerElementArrayTemplate<int>& indexArray = pOther.GetIndexArray();
            *mIndexArray = indexArray;
        }
        
        FbxLayerElement* myself = (FbxLayerElement*)this;
        FbxLayerElement* myOther = (FbxLayerElement*)&pOther;
        *myself = *myOther;
        return *this; 
    }

RemapIndexTo()

int RemapIndexTo ( FbxLayerElement::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 1170 of file fbxlayer.h.

    {
        return RemapIndexArrayTo(this, pNewMapping, mIndexArray);
    }

---

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

• fbxsdk/scene/geometry/fbxlayer.h