kfbxmesh.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXMESH_H
#define FBXFILESDK_KFBXPLUGINS_KFBXMESH_H

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

 Copyright (C) 2001 - 2010 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 <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/kfbxplugins/kfbxgeometry.h>

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

#include <fbxfilesdk/components/kbaselib/klib/karrayul.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxMesh;
class KFbxSdkManager;

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

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();

    inline int GetPolygonCount() const { return mPolygons.GetCount(); }

    inline int GetPolygonSize(int pPolygonIndex) const
    {
        return (pPolygonIndex >= 0 && pPolygonIndex < mPolygons.GetCount()) ? mPolygons[pPolygonIndex].mSize : -1;
    }

    int GetPolygonGroup(int pPolygonIndex) const;

    inline void SetPolygonGroup(int pPolygonIndex, int pGroup) const
    {
        if (pPolygonIndex >= 0 && pPolygonIndex<mPolygons.GetCount())
            mPolygons[pPolygonIndex].mGroup = pGroup;
    }

    inline int GetPolygonVertex(int pPolygonIndex, int pPositionInPolygon) const
    {
        return (pPolygonIndex >= 0 && pPolygonIndex < mPolygons.GetCount() && pPositionInPolygon >= 0 && pPositionInPolygon < mPolygons[pPolygonIndex].mSize) ?
            mPolygonVertices[mPolygons[pPolygonIndex].mIndex + pPositionInPolygon] : -1;
    }

    bool GetPolygonVertexNormal(int pPolyIndex, int pVertexIndex, KFbxVector4& pNormal) const;

    bool GetPolygonVertexNormals(KArrayTemplate<KFbxVector4>& pNormals) const;

    bool GetPolygonVertexUV(int pPolyIndex, int pVertexIndex, const char* pUVSetName, KFbxVector2& pUV) const;

    bool GetPolygonVertexUVs(const char* pUVSetName, KArrayTemplate<KFbxVector2>& pUVs) const;

    int* GetPolygonVertices() const;

    int GetPolygonVertexCount() const;

    int GetPolygonVertexIndex( int pPolygonIndex ) const;

    int RemovePolygon(int pPolygonIndex);

    int RemoveDuplicatedEdges(KArrayTemplate<int>& pEdgeIndexList);



    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() const;

    KArrayTemplate<KFbxLayerElement::ELayerElementType> GetAllChannelUV(int pLayer);



    void InitMaterialIndices(KFbxLayerElement::EMappingMode pMappingMode);

    void InitTextureIndices(KFbxLayerElement::EMappingMode pMappingMode, KFbxLayerElement::ELayerElementType pTextureType);

    void InitTextureUVIndices(KFbxLayerElement::EMappingMode pMappingMode, 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*/);



    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;          
    };

    bool CheckSamePointTwice() const;

    int RemoveBadPolygons();



    bool SplitPoints(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() const;

    int GetMeshEdgeIndex( int pStartVertexIndex, int pEndVertexIndex, bool& pReversed, int pExistedEdgeCount = -1 );

    int GetMeshEdgeIndexForPolygon( int pPolygon, int pPositionInPolygon );

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

    void BeginGetMeshEdgeVertices();

    void EndGetMeshEdgeVertices();

    void SetMeshEdgeCount( int pEdgeCount );

    inline void SetMeshEdge( int pEdgeIndex, int pValue )
    {
        if( pEdgeIndex >= 0 && pEdgeIndex < mEdgeArray.GetCount() ) mEdgeArray[pEdgeIndex] = pValue;
    }

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

    int SetMeshEdgeIndex( int pEdgeIndex, int pStartVertexIndex, int pEndVertexIndex, bool pCheckForDuplicates, int pExistedEdgeCount=-1 );

    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;


    inline void ReservePolygonCount( int pCount ) { mPolygons.Reserve( pCount ); }

    inline void ReservePolygonVertexCount( int pCount ) { mPolygonVertices.Reserve( pCount ); }

    bool GetTextureUV(KFbxLayerElementArrayTemplate<KFbxVector2>** pLockableArray, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES) const;
    bool GetMaterialIndices(KFbxLayerElementArrayTemplate<int>** pLockableArray) const;
    bool GetTextureIndices(KFbxLayerElementArrayTemplate<int>** pLockableArray, KFbxLayerElement::ELayerElementType pTextureType) const;



    double GetEdgeCreaseInfo(int pEdgeIndex);

    bool GetEdgeCreaseInfoArray(KFbxLayerElementArrayTemplate<double>** pCreaseArray);

    double GetVertexCreaseInfo(int pVertexIndex);

    bool GetVertexCreaseInfoArray(KFbxLayerElementArrayTemplate<double>** pCreaseArray);

    bool SetEdgeCreaseInfo(int pEdgeIndex, double pWeight);

    bool SetEdgeCreaseInfoArray(KArrayTemplate<double>* pWeightArray);

    bool SetVertexCreaseInfo(int pVertexIndex, double pWeight);

    bool SetVertexCreaseInfoArray(KArrayTemplate<double>* pWeightArray);



    enum EMeshSmoothness
    {
        eHULL,          
        eROUGH,         
        eMEDIUM,        
        eFINE           
    };

    enum EBoundaryRule
    {
        eLEGACY,            
        eCREASE_ALL,        
        eCREASE_EDGES       
    };

    KFbxMesh::EMeshSmoothness GetMeshSmoothness() const;

    void SetMeshSmoothness(KFbxMesh::EMeshSmoothness pSmoothness);

    int GetMeshPreviewDivisionLevels() const;

    void SetMeshPreviewDivisionLevels(int pPreviewDivisionLevels);

    int GetMeshRenderDivisionLevels() const;

    void SetMeshRenderDivisionLevels(int pRenderDivisionLevels);

    bool GetDisplaySubdivisions() const;

    void SetDisplaySubdivisions(bool pDisplySubdivisions);

    EBoundaryRule GetBoundaryRule() const;

    void SetBoundaryRule(EBoundaryRule pBoundaryRule);

    bool GetPreserveBorders() const;

    void SetPreserveBorders(bool pPreserveBorders);

    bool GetPreserveHardEdges() const;

    void SetPreserveHardEdges(bool pPreserveHardEdges);

    bool GetPropagateEdgeHardness() const;

    void SetPropagateEdgeHardness(bool pPropagateEdgeHardness);



    bool GetPolyHoleInfo(int pFaceIndex);

    bool GetPolyHoleInfoArray(KFbxLayerElementArrayTemplate<bool>** pHoleArray);


    bool SetPolyHoleInfo(int pFaceIndex, bool pIsHole);

    bool SetPolyHoleInfoArray(KArrayTemplate<bool>* pHoleArray);


private:

    bool GenerateTangentsData(KFbxLayerElementUV* pUVSet, int pLayerIndex);

    bool ComputeTangents(KFbxVector4* pPolyVetices, KFbxVector2* pUvs, int pPolySize, KArrayTemplate<KFbxVector4> &pTan1, KArrayTemplate<KFbxVector4> &pTan2);

public:

    bool GenerateTangentsData(KString pUVSetName = "");

    bool GenerateTangentsData(int pUVSetLayerIndex);

    
    bool GenerateTangentsDataForAllUVSets();


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

    virtual KFbxObject& Copy(const KFbxObject& pObject);

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

    K_DEPRECATED bool IsBadPoly(int pPolygonIndex) const;
    
    bool GetBadPolyIndices(KArrayTemplate<int>& pArrayBadPolyIndices, bool pCheckOne) const;

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

    virtual void Destruct(bool pRecursive, bool pDependents);

    struct KFbxSplitEdgeData
    {
        int mOriginalEdge;
        bool mIsNew;
    };

    //smooth mesh preview
    EMeshSmoothness mSmoothness;
    int mPreviewDivisionLevels;
    int mRenderDivisionLevels;

    bool mDisplaySubdivisions;
    EBoundaryRule mBoundaryRule;
    bool mPreserveBorders;
    bool mPreserveHardEdges;
    bool mPropagateEdgeHardness;

public:
    //Please use GetPolygonVertexIndex and GetPolygonVertices to access these arrays.
    //DO NOT MODIFY them directly, otherwise unexpected behavior will occur.
    //These members are public only for application data copy performance reasons.
    struct KFbxPolygon{ int mIndex; int mSize; int mGroup; };
    KArrayTemplate<KFbxPolygon> mPolygons;
    KArrayTemplate<int> mPolygonVertices;

protected:
    struct KFbxPolyIndex
    {
        int mPolygonIndex;
        int mSubPolygonIndex;
    };

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

    KFbxV2PVMap mV2PVMap;

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

    KFbxEdgeLookup mPVEndFlags;

public:
    KArrayTemplate< int > mEdgeArray;

protected:
    // Finds the polygon index for the given edge
    int FindPolygonIndex( int pEdgeIndex );
    static int PolygonIndexCompare( const void *p1, const void *p2 );

    void PolySetTexture(KFbxLayer* pLayer, int pTextureIndex,
                        KFbxLayerElement::ELayerElementType pTextureType);
    template<class T> bool GetPolygonVertexLayerElementValue(const KFbxLayerElementTemplate<T>* pLayerElement,
            int pPolyIndex, int pVertexIndex, T& pValue) const;

    friend class KFbxGeometryConverter;
    friend class KFbxWriter3DS;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};


typedef KFbxMesh* HKFbxMesh;

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXMESH_H