kfbxmesh.h

Go to the documentation of this file.

#ifndef _FBXSDK_MESH_H_
#define _FBXSDK_MESH_H_

/**************************************************************************************

 Copyright © 2001 - 2007 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material
 (collectively the "Data") in these files contain unpublished information
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by
 Canada and United States of America federal copyright law and by international
 treaties.

 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE,
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE.
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE.

 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE.

**************************************************************************************/

#include <kaydaradef.h>
#ifndef KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>

#include <kfbxplugins/kfbxgeometry.h>

#include <kfbxmath/kfbxvector4.h>
#include <kfbxmath/kfbxvector2.h>

#include <klib/karrayul.h>
       
#include <fbxfilesdk_nsbegin.h>

class KFbxMesh;
class KFbxMesh_internal;
class KFbxSdkManager;

class KFBX_DLL KFbxMesh : public KFbxGeometry 
{
    KFBXOBJECT_DECLARE(KFbxMesh);

public:
    virtual EAttributeType GetAttributeType() const;


    void BeginPolygon(int pMaterial = -1, int pTexture = -1, int pGroup = -1, bool pLegacy=true);

    void BeginPolygonExt(int pMaterial, int* pTextures);

    void AddPolygon(int pIndex, int pTextureUVIndex = -1);

    void EndPolygon();

    int GetPolygonCount();

    int GetPolygonSize(int pPolygonIndex);

    int GetPolygonGroup(int pPolygonIndex);

    int GetPolygonVertex(int pPolygonIndex, int pPositionInPolygon);

    void GetPolygonVertexNormal(int &pPolyIndex, int &pVertexIndex, KFbxVector4 &pNormal);
    
    int* GetPolygonVertices();

    int GetPolygonVertexCount();
    
    int RemovePolygon(int pPolygonIndex);
    


    void InitTextureUV(int pCount, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES);

    void AddTextureUV(KFbxVector2 pUV, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES);

    int GetTextureUVCount(KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES);
    
    int GetUVLayerCount();
    
    KArrayTemplate<KFbxLayerElement::ELayerElementType> GetAllChannelUV(int layer);
        
    KFbxVector2* GetTextureUV(KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES);


    
    void InitMaterialIndices(KFbxLayerElement::EMappingMode pMappingMode);

    K_DEPRECATED KFbxLayerElement::EMappingMode GetMaterialMappingMode();

    int* GetMaterialIndices();

    void InitEmissiveTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitEmissiveFactorTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitAmbientTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitAmbientFactorTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitDiffuseTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitDiffuseFactorTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitSpecularTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitSpecularFactorTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitShininessTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitBumpTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitNormalMapTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitTransparentTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitTransparencyFactorTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitReflectionTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitReflectionFactorTexturesIndices(KFbxLayerElement::EMappingMode pMappingMode);

    K_DEPRECATED KFbxLayerElement::EMappingMode GetEmissiveTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetEmissiveFactorTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetAmbientTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetAmbientFactorTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetDiffuseTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetDiffuseFactorTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetSpecularTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetSpecularFactorTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetShininessTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetBumpTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetTransparentTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetTransparencyFactorTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetReflectionTexturesMappingMode();

    K_DEPRECATED KFbxLayerElement::EMappingMode GetReflectionFactorTexturesMappingMode();

    int* GetEmissiveTexturesIndices();

    int* GetEmissiveFactorTexturesIndices();

    int* GetAmbientTexturesIndices();

    int* GetAmbientFactorTexturesIndices();

    int* GetDiffuseTexturesIndices();

    int* GetDiffuseFactorTexturesIndices();

    int* GetSpecularTexturesIndices();

    int* GetSpecularFactorTexturesIndices();

    int* GetShininessTexturesIndices();

    int* GetBumpTexturesIndices();

    int* GetTransparentTexturesIndices();

    int* GetTransparencyFactorTexturesIndices();

    int* GetReflectionTexturesIndices();

    int* GetReflectionFactorTexturesIndices();

    int* GetTexturesIndices(KFbxLayerElement::ELayerElementType pTextureType);

    void InitTextureUVIndices(KFbxLayerElement::EMappingMode pMappingMode, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES);

    K_DEPRECATED KFbxLayerElement::EMappingMode GetTextureUVMappingMode(KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES);

    int GetTextureUVIndex(int pPolygonIndex, int pPositionInPolygon, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES);


    void SetTextureUVIndex(int pPolygonIndex, int pPositionInPolygon, int pIndex, KFbxLayerElement::ELayerElementType pTypeIdentifier/*=KFbxLayerElement::eDIFFUSE_TEXTURES*/);
    
    K_DEPRECATED KFbxLayerElement::EMappingMode GetNormalsMappingMode();

    K_DEPRECATED void SetNormalsMappingMode(KFbxLayerElement::EMappingMode pMappingMode);



    void Reset();

    void ComputeVertexNormals(bool pCW =  false);

    bool CheckIfVertexNormalsCCW();

    typedef enum 
    {
        eBY_NORMAL  
    } ESplitObject;

    class KDuplicateVertex
    {
    public:
        KDuplicateVertex() :
          lVertexPolyIndex(0),
          lNewVertexIndex(0),
          lNormal(0,0,0)
          {
          };

        int lVertexPolyIndex ; 
        int lNewVertexIndex;   
        KFbxVector4 lNormal;    
        KFbxVector2 lUV;        

        int lEdgeIndex;         
    };

    class KVertexNormalInfo
    {
    public:
        KVertexNormalInfo():
          mTotalNormal(0,0,0),
          mNumNormal(0)
          {
          };

          KFbxVector4 mTotalNormal; 
          int mNumNormal;          
    };

    typedef KArrayTemplate< KDuplicateVertex > KArrayOfDuplicateVertex;

    bool CheckSamePointTwice();

    int RemoveBadPolygons();



    void BuildSplitList(KArrayTemplate<KArrayOfDuplicateVertex* >&pSplitList, ESplitObject pObject);

    void SplitPointsForHardEdge(KArrayTemplate<KArrayOfDuplicateVertex* > &pSplitList, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES); 

    bool BuildMergeList(KArrayTemplate<int> &pMergeList,ESplitObject pObject , bool pExport = false);

    void MergePointsForPolygonVerteNormals(KArrayTemplate<int> &pMergeList);




    void BuildMeshEdgeArray();

    int GetMeshEdgeCount();
    
    int GetMeshEdgeIndex( int pStartVertexIndex, int pEndVertexIndex, bool& pReversed );

    int GetMeshEdgeIndexForPolygon( int pPolygon, int pPositionInPolygon );

    void GetMeshEdgeVertices( int pEdgeIndex, int& pStartVertexIndex, int& pEndVertexIndex );

    void BeginGetMeshEdgeVertices();

    void EndGetMeshEdgeVertices();

    void SetMeshEdgeCount( int pEdgeCount );

    void SetMeshEdge( int pEdgeIndex, int pValue );

    int AddMeshEdgeIndex( int pStartVertexIndex, int pEndVertexIndex, bool pCheckForDuplicates );

    int SetMeshEdgeIndex( int pEdgeIndex, int pStartVertexIndex, int pEndVertexIndex, bool pCheckForDuplicates );

    void BeginAddMeshEdgeIndex();

    void EndAddMeshEdgeIndex();


    int AddMeshEdgeIndexForPolygon( int pPolygonIndex, int pPositionInPolygon );

    bool SetMeshEdgeIndex( int pEdgeIndex, int pPolygonIndex, int pPositionInPolygon );


    struct KFbxComponentMap
    {
        KArrayTemplate<int> mData;
        KArrayTemplate<int> mOffsets;

        int GetDataCount(int pIndex) { return mOffsets[pIndex + 1] - mOffsets[pIndex]; }
        int GetData(int pIndex, int pSubIndex) { return mData[ mOffsets[pIndex] + pSubIndex ]; }
        int GetComponentCount() { return mOffsets.GetCount() - 1; }
    };

    void ComputeComponentMaps( KFbxComponentMap& pEdgeToPolyMap, KFbxComponentMap& pPolyToEdgeMap );

    bool IsTriangleMesh() const;


//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//

#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:

    virtual KObject*  GetFbxObject_internal();
    virtual KObject const*  GetFbxObject_internal() const;

    // Clone
    virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType) const;

protected:
    static char const* GetNamePrefix() { return 0; }

    void InitTextureIndices(KFbxLayerElementTexture* pLayerElementTexture, KFbxLayerElement::EMappingMode pMappingMode);
    int* GetTextureIndices(KFbxLayerElementTexture* pLayerElementTexture);
    void RemoveTextureIndex(KFbxLayerElementTexture* pLayerElementTextures, int pPolygonIndex, int pOffset);
    void RemoveUVIndex(KFbxLayerElementUV* pLayerElementUV, int pPolygonIndex, int pOffset);

    bool IsBadPoly(int pPolygonIndex);

    KFbxMesh(KFbxSdkManager& pManager, char const* pName);
    ~KFbxMesh();

    virtual void Destruct(bool pRecursive, bool pDependents);

    KFbxMesh& operator= (KFbxMesh const& pMesh);

    virtual KString     GetTypeName() const;
    virtual KStringList GetTypeFlags() const;

    int    mUCount, mVCount;
    int    mUCountExtent, mVCountExtent;
    int    mUStep, mVStep;
    bool    mUClosed, mVClosed;
    bool    mUCapped, mVCapped;

    struct KFbxPolygon 
    {
        int mIndex;
        int mSize;
        int mGroup;
    };

    struct KFbxSplitEdgeData
    {
        int mOriginalEdge;
        bool mIsNew;
    };

    KArrayTemplate<KFbxPolygon> mPolygons;
    KArrayTemplate<int> mPolygonVertices;

    struct KFbxPolyIndex 
    {
        int mPolygonIndex;
        int mSubPolygonIndex;
    };

    struct KFbxV2PVMap
    {
        KFbxPolyIndex* mV2PV;
        int* mV2PVOffset;
        int* mV2PVCount;
        bool mValid;
    };

    KFbxV2PVMap mV2PVMap;

    struct KFbxEdgeLookup
    {
        KArrayTemplate<int> mPVFlags;
        bool mValid;
    };

    KFbxEdgeLookup mPVEndFlags;

    // Internal Property Handler
    KFbxMesh_internal* mPH;

protected:
    KArrayTemplate< int > mEdgeArray;

    // finds the poly index for the given edge
    int FindPolygonIndex( int pEdgeIndex );

    void PolySetTexture(KFbxLayer* pLayer, int pTextureIndex, 
                        KFbxLayerElement::ELayerElementType pTextureType);
    
    friend class KFbxReaderFbx;
    friend class KFbxReaderFbx6;
    friend class KFbxWriterFbx;
    friend class KFbxWriterFbx6;
    friend class KFbxGeometryConverter;
    friend class KFbxWriter3DS;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};


typedef KFbxMesh* HKFbxMesh;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_MESH_H_