kfbxpose.h

Go to the documentation of this file.

#ifndef _FBXSDK_POSE_H_
#define _FBXSDK_POSE_H_

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

 Copyright © 2003 - 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/kfbxobject.h>
#include <kfbxplugins/kfbxgroupname.h>

#include <klib/kstring.h>
#include <klib/karrayul.h>
#include <klib/kname.h>
#include <kfbxmath/kfbxmatrix.h>

#include <fbxfilesdk_nsbegin.h>

typedef struct
{
    KFbxMatrix  mMatrix;        
    bool        mMatrixIsLocal; 
    KFbxNode*   mNode;          

} KFbxPoseInfo;

class KFbxScene;
class KFbxPose_internal;
class KFbxUserNotification;

class KFBX_DLL KFbxPose : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxPose);
public:
        void SetIsBindPose(bool pIsBindPose);

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

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

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

          int Add(KFbxNode* pNode, KFbxMatrix& pMatrix, bool pLocalMatrix = false);

          void Remove(int pIndex);

          KName GetNodeName(int pIndex) const;

          KFbxNode* GetNode(int pIndex) const;

          const KFbxMatrix& GetMatrix(int pIndex)       const;

          bool IsLocalMatrix(int pIndex);


          enum KNameComponent {
              INITIALNAME_COMPONENT = 1,
              CURRENTNAME_COMPONENT = 2,
              ALL_NAME_COMPONENTS   = 3
          };

          int Find(KName& pNodeName, char pCompareWhat = ALL_NAME_COMPONENTS);

          int Find(KFbxNode* pNode);




        static bool GetPosesContaining(KFbxSdkManager& pManager, KFbxNode* pNode, 
                                       KArrayTemplate<KFbxPose*>& pPoseList,
                                       KArrayTemplate<int>& pIndex);

        static bool GetPosesContaining(KFbxScene* pScene, KFbxNode* pNode, 
                                       KArrayTemplate<KFbxPose*>& pPoseList,
                                       KArrayTemplate<int>& pIndex);

        static bool GetBindPoseContaining(KFbxSdkManager& pManager, KFbxNode* pNode, 
                                          KArrayTemplate<KFbxPose*>& pPoseList,
                                          KArrayTemplate<int>& pIndex);

        static bool GetBindPoseContaining(KFbxScene* pScene, KFbxNode* pNode, 
                                          KArrayTemplate<KFbxPose*>& pPoseList,
                                          KArrayTemplate<int>& pIndex);

        static bool GetRestPoseContaining(KFbxSdkManager& pManager, KFbxNode* pNode, 
                                          KArrayTemplate<KFbxPose*>& pPoseList,
                                          KArrayTemplate<int>& pIndex);

        static bool GetRestPoseContaining(KFbxScene* pScene, KFbxNode* pNode, 
                                          KArrayTemplate<KFbxPose*>& pPoseList,
                                          KArrayTemplate<int>& pIndex);

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

        bool IsValidBindPoseVerbose(KFbxNode* pRoot, 
                                    KArrayTemplate<KFbxNode*>& pMissingAncestors,
                                    KArrayTemplate<KFbxNode*>& pMissingDeformers,
                                    KArrayTemplate<KFbxNode*>& pMissingDeformersAncestors,
                                    KArrayTemplate<KFbxNode*>& pWrongMatrices,
                                    double pMatrixCmpTolerance=0.0001);

        bool IsValidBindPoseVerbose(KFbxNode* pRoot, 
                                    KFbxUserNotification* pUserNotification,
                                    double pMatrixCmpTolerance=0.0001);


        KError& GetError();

        typedef enum 
        {
            eERROR,
            eERROR_VALIDBINDPOSE_FAILURE_INVALIDOBJECT,
            eERROR_VALIDBINDPOSE_FAILURE_INVALIDROOT,
            eERROR_VALIDBINDPOSE_FAILURE_NOTALLANCESTORS_NODES,
            eERROR_VALIDBINDPOSE_FAILURE_NOTALLDEFORMING_NODES,
            eERROR_VALIDBINDPOSE_FAILURE_NOTALLANCESTORS_DEFNODES,
            eERROR_VALIDBINDPOSE_FAILURE_RELATIVEMATRIX,
            eERROR_COUNT
        } EError;   

        EError GetLastErrorID();

        char* GetLastErrorString();


        virtual KFbxObject::ENameSpace GetNameSpace() const;


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

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

protected:
    static char const* GetNamePrefix() { return POSE_PREFIX; }
    
    KFbxPose(KFbxSdkManager& pManager, char const* pName);
    
    ~KFbxPose();
    
    virtual void Destruct(bool pRecursive, bool pDependents);

    // From KFbxObject
    virtual KString     GetTypeName() const;
    virtual KStringList GetTypeFlags() const;

    // Properties Handler
    KFbxPose_internal* mPH;

    KError mError;

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

    KFbxPose& operator=(KFbxPose const& pPose);

    // 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).
    // pos will contains the index of the KFbxPoseInfo if the parameters are already
    // stored in this object.
    //
    bool ValidateParams(KFbxNode* pNode, KFbxMatrix& pMatrix, int& pPos);

    // Check only on this object's list.
    bool LocalValidateParams(KFbxNode* pNode, KFbxMatrix& pMatrix, int& pPos);

    static bool GetSpecificPoseContaining(
        int poseType,
        KFbxScene* pScene, KFbxNode* pNode, 
        KArrayTemplate<KFbxPose*>& pPoseList,
        KArrayTemplate<int>& pIndex);

    friend class KFbxReaderFbx;
    friend class KFbxWriterFbx6;

private:
    // don't give public access to the info otherwise we will loose the ability
    // to maintain data integrity.
    KFbxPoseInfo* GetItem(int pIndex);

private:
    char        mType;

    KArrayTemplate<KFbxPoseInfo*> mPoseInfo;

    bool IsValidBindPoseCommon(KFbxNode* pRoot, 
                                KArrayTemplate<KFbxNode*>* pMissingAncestors,
                                KArrayTemplate<KFbxNode*>* pMissingDeformers,
                                KArrayTemplate<KFbxNode*>* pMissingDeformersAncestors,
                                KArrayTemplate<KFbxNode*>* pWrongMatrices,
                                double pMatrixCmpTolerance=0.0001);

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS 

};

typedef KFbxPose* HKFbxPose;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_POSE_H_