fbxpose.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_POSE_H_
#define _FBXSDK_SCENE_POSE_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxobject.h>
#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/core/base/fbxarray.h>
#include <fbxsdk/core/base/fbxerror.h>
#include <fbxsdk/core/math/fbxmatrix.h>
#include <fbxsdk/scene/fbxgroupname.h>
#include <fbxsdk/utils/fbxnamehandler.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

typedef struct
{
    FbxMatrix  mMatrix;
    bool        mMatrixIsLocal;
    FbxNode*   mNode;

} FbxPoseInfo;

class FbxAnimStack;
class FbxScene;
class FbxUserNotification;
class FbxPose;

typedef FbxArray<FbxNode*> NodeList;
typedef FbxArray<FbxPose*> PoseList;
typedef FbxArray<FbxPoseInfo*> PoseInfoList;

class FBXSDK_DLL FbxPose : public FbxObject
{
    FBXSDK_OBJECT_DECLARE(FbxPose,FbxObject);

public:
    void SetIsBindPose(bool pIsBindPose);

    bool IsBindPose() const { return mType == 'b'; }

    bool IsRestPose() const { return mType == 'r'; }

    int GetCount() const { return mPoseInfo.GetCount(); }

    int Add(FbxNode* pNode, const FbxMatrix& pMatrix, bool pLocalMatrix = false, bool pMultipleBindPose = true);

    void Remove(int pIndex);

    FbxNameHandler GetNodeName(int pIndex) const;

    FbxNode* GetNode(int pIndex) const;

    const FbxMatrix& GetMatrix(int pIndex)       const;

    bool IsLocalMatrix(int pIndex) const;

        enum ENameComponent
        {
            eInitialNameComponent = 1,  
            eCurrentNameComponent = 2,  
            eAllNameComponents = 3      
        };

        int Find(const FbxNameHandler& pNodeName, char pCompareWhat = eAllNameComponents) const;

        int Find(const FbxNode* pNode) const;

        static bool GetPosesContaining(FbxManager& pManager, FbxNode* pNode, PoseList& pPoseList, FbxArray<int>& pIndex);

        static bool GetPosesContaining(FbxScene* pScene, FbxNode* pNode, PoseList& pPoseList, FbxArray<int>& pIndex);

        static bool GetBindPoseContaining(FbxManager& pManager, FbxNode* pNode, PoseList& pPoseList, FbxArray<int>& pIndex);

        static bool GetBindPoseContaining(FbxScene* pScene, FbxNode* pNode, PoseList& pPoseList, FbxArray<int>& pIndex);

        static bool GetRestPoseContaining(FbxManager& pManager, FbxNode* pNode, PoseList& pPoseList, FbxArray<int>& pIndex);

        static bool GetRestPoseContaining(FbxScene* pScene, FbxNode* pNode, PoseList& pPoseList, FbxArray<int>& pIndex);

        bool IsValidBindPose(FbxNode* pRoot, double pMatrixCmpTolerance=0.0001);

        bool IsValidBindPoseVerbose(FbxNode* pRoot, NodeList& pMissingAncestors, NodeList& pMissingDeformers, NodeList& pMissingDeformersAncestors, NodeList& pWrongMatrices, double pMatrixCmpTolerance=0.0001);

        bool IsValidBindPoseVerbose(FbxNode* pRoot, FbxUserNotification* pUserNotification, double pMatrixCmpTolerance=0.0001);

        FbxError& GetError();

        enum EErrorCode
        {
            eError,
            eInvalidObject,
            eInvalidRoot,
            eNotAllAncestorsNodes,
            eNotAllDeformingNodes,
            eNotAllAncestorsDefinitionNodes,
            eRelativeMatrix,
            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
protected:
    FbxPose(FbxManager& pManager, char const* pName);

    virtual FbxObject&  Copy(const FbxObject& pObject);
    virtual void        Destruct(bool pRecursive, bool pDependents);
    virtual const char* GetTypeName() const;

    //Returns false if pNode is already inserted in the list and the current matrix is different from the stored one. Also, if this pose is a rest pose, check if
    //pNode belongs to other BindPoses (accessed through the scene pointer). pPos will contains the index of the FbxPoseInfo if the parameters are already stored in this object.
    bool                ValidateParams(const FbxNode* pNode, const FbxMatrix& pMatrix, int& pPos);

    bool                LocalValidateParams(const FbxNode* pNode, const FbxMatrix& pMatrix, int& pPos);
    static bool         GetSpecificPoseContaining(int poseType, FbxScene* pScene, FbxNode* pNode, PoseList& pPoseList, FbxArray<int>& pIndex);

    FbxError                mError;

private:
    FbxPoseInfo*        GetItem(int pIndex) const;
    bool                IsValidBindPoseCommon(FbxNode* pRoot, NodeList* pMissingAncestors, NodeList* pMissingDeformers, NodeList* pMissingDeformersAncestors, NodeList* pWrongMatrices, double pMatrixCmpTolerance=0.0001);

    char                mType;
    PoseInfoList        mPoseInfo;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_POSE_H_ */