fbxgeometry.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_SCENE_GEOMETRY_H_
#define _FBXSDK_SCENE_GEOMETRY_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/scene/geometry/fbxgeometrybase.h>
#include <fbxsdk/scene/geometry/fbxdeformer.h>
#include <fbxsdk/scene/geometry/fbxshape.h>
#include <fbxsdk/scene/geometry/fbxblendshape.h>
#include <fbxsdk/scene/geometry/fbxblendshapechannel.h>

#include <fbxsdk/core/base/fbxarray.h>
#include <fbxsdk/core/base/fbxerror.h>

#include <fbxsdk/core/math/fbxaffinematrix.h>
#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxGeometryWeightedMap;
class FbxNode;
class FbxShape;
class FbxTexture;
class FbxManager;
class FbxVector4;
class FbxAnimCurve;
class FbxAnimLayer;
class FbxScene;
class FbxCluster;

class FBXSDK_DLL FbxGeometry : public FbxGeometryBase
{
    FBXSDK_OBJECT_DECLARE(FbxGeometry,FbxGeometryBase);

public:
    virtual FbxNodeAttribute::EType GetAttributeType() const;


    int AddDeformer(FbxDeformer* pDeformer);

    FbxDeformer* RemoveDeformer(int pIndex);

    int GetDeformerCount() const;

    FbxDeformer* GetDeformer(int pIndex) const;

    int GetDeformerCount(FbxDeformer::EDeformerType pType) const;

    FbxDeformer* GetDeformer(int pIndex, FbxDeformer::EDeformerType pType) const;



    FbxGeometryWeightedMap* GetSourceGeometryWeightedMap();

    int GetDestinationGeometryWeightedMapCount() const;

    FbxGeometryWeightedMap* GetDestinationGeometryWeightedMap(int pIndex);



    bool AddShape(int pBlendShapeIndex, int pBlendShapeChannelIndex, FbxShape* pShape, double pPercent = 100);

    void ClearShape();

    int GetShapeCount() const;

    int GetShapeCount(int pBlendShapeIndex, int pBlendShapeChannelIndex) const;

    FbxShape* GetShape(int pBlendShapeIndex, int pBlendShapeChannelIndex, int pShapeIndex);

    FbxShape const* GetShape(int pBlendShapeIndex, int pBlendShapeChannelIndex, int pShapeIndex) const;

    FbxAnimCurve* GetShapeChannel(int pBlendShapeIndex, int pBlendShapeChannelIndex, FbxAnimLayer* pLayer, bool pCreateAsNeeded = false);

    enum ESurfaceMode
    {
        eRaw,           
        eLowNoNormals,  
        eLow,           
        eHighNoNormals, 
        eHigh           
    };


    FbxAMatrix& GetPivot(FbxAMatrix& pXMatrix) const;

    void SetPivot(FbxAMatrix& pXMatrix);

    void ApplyPivot();



    void SetDefaultShape(int pBlendShapeIndex, int pBlendShapeChannelIndex, double pPercent);

    void SetDefaultShape(FbxBlendShapeChannel* pBlendShapeChannel,  double pPercent);

    double GetDefaultShape(int pBlendShapeIndex, int pBlendShapeChannelIndex) const;

    double GetDefaultShape(FbxBlendShapeChannel* pBlendShapeChannel) const;



    FbxError& GetError ();

    enum EErrorCode
    {
        eIndexOutOfRange,           
        eNullParameter,             
        eShapeAlreadyAdded,         
        eShapeInvalidName,          
        eShapeNameClash,                
        eShapeNoCurveFound,         
        eUnknownError,                  
        eErrorCount
    };

    EErrorCode GetLastErrorID() const;

    const char* GetLastErrorString() const;


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

    virtual FbxObject& Copy(const FbxObject& pObject);

protected:
    FbxGeometry(FbxManager& pManager, char const* pName);
    virtual void Destruct(bool pRecursive, bool pDependents);

    virtual void SetDocument(FbxDocument* pDocument);

public:
    void CleanShapeChannels(FbxAnimLayer* pAnimLayer);
    void CleanShapeChannel(FbxAnimLayer* pAnimLayer, int pShapeIndex);

    void CreateShapeChannelProperties(FbxString& pShapeName);

protected:
    // Shape channel name creation for nurb and patch.
    FbxString CreateShapeChannelName(int pShapeIndex);

    // Shape channel name creation for mesh.
    FbxString CreateShapeChannelName(FbxString pShapeName);

public:
    void ConvertShapeNamesToV5Format(FbxString pTakeNodeName);
    void ConvertShapeNamesToV5Format(FbxString pTakeNodeName, int pShapeIndex);
    void RevertShapeNamesToV6Format(FbxString pTakeNodeName);
    void RevertShapeNamesToV6Format(FbxString pTakeNodeName, int pShapeIndex);
    void ClearTemporaryShapeNames();

protected:
    void CopyDeformers(FbxGeometry const* pGeometry);
    void CopyPivot(FbxGeometry const* pSource);

    // Used during FBX v5 file store
    FbxArray<FbxString*> mShapeNameArrayV6;
    FbxArray<FbxString*> mShapeNameArrayV5;
    FbxArray<FbxString*> mShapeChannelNameArrayV5;

    FbxAMatrix* mPivot;


    mutable FbxError mError;

    friend class FbxScene;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_GEOMETRY_H_ */