kfbxcharacter.h

Go to the documentation of this file.

#ifndef _FBXSDK_CHARACTER_H_
#define _FBXSDK_CHARACTER_H_

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

 Copyright © 2002 - 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 <kfbxmath/kfbxvector4.h>

#include <klib/kstring.h>
#include <klib/kerror.h>

#include <kfbxplugins/kfbxconstraint.h>
#include <kfbxplugins/kfbxnodelimits.h>
#include <kfbxplugins/kfbxgroupname.h>

#include <fbxfilesdk_nsbegin.h>

class KFbxNode;
class KFbxControlSet;
class KFbxFilterSet;
class KFbxSdkManager;
class KFbxCharacter_Internal;

typedef enum 
{ 
    eCharacterInputActor = 0, 
    eCharacterInputCharacter = 1, 
    eCharacterInputMarkerSet = 2, 
    eCharacterOutputMarkerSet = 3, 
    eCharacterInputStance = 4 
} ECharacterInputType;


typedef enum  
{   
    eCharacterHips = 0,             // Required
    eCharacterLeftHip,              // Required
    eCharacterLeftKnee,             // Required
    eCharacterLeftAnkle,            // Required
    eCharacterLeftFoot,
    eCharacterRightHip,             // Required
    eCharacterRightKnee,            // Required
    eCharacterRightAnkle,           // Required
    eCharacterRightFoot,
    eCharacterWaist,                // Spine0, Required
    eCharacterChest,                // Spine1
    eCharacterLeftCollar,
    eCharacterLeftShoulder,         // Required
    eCharacterLeftElbow,            // Required
    eCharacterLeftWrist,            // Required
    eCharacterRightCollar,
    eCharacterRightShoulder,        // Required
    eCharacterRightElbow,           // Required
    eCharacterRightWrist,           // Required
    eCharacterNeck,
    eCharacterHead,                 // Required
    eCharacterLeftHipRoll,
    eCharacterLeftKneeRoll,
    eCharacterRightHipRoll,
    eCharacterRightKneeRoll,
    eCharacterLeftShoulderRoll,
    eCharacterLeftElbowRoll,
    eCharacterRightShoulderRoll,
    eCharacterRightElbowRoll,
    eCharacterSpine2,
    eCharacterSpine3,
    eCharacterSpine4,
    eCharacterSpine5,
    eCharacterSpine6,
    eCharacterSpine7,
    eCharacterSpine8,
    eCharacterSpine9,
    eCharacterLeftThumbA,
    eCharacterLeftThumbB,
    eCharacterLeftThumbC,
    eCharacterLeftIndexA,
    eCharacterLeftIndexB,
    eCharacterLeftIndexC,
    eCharacterLeftMiddleA,
    eCharacterLeftMiddleB,
    eCharacterLeftMiddleC,
    eCharacterLeftRingA,
    eCharacterLeftRingB,
    eCharacterLeftRingC,
    eCharacterLeftPinkyA,
    eCharacterLeftPinkyB,
    eCharacterLeftPinkyC,
    eCharacterRightThumbA,
    eCharacterRightThumbB,
    eCharacterRightThumbC,
    eCharacterRightIndexA,
    eCharacterRightIndexB,
    eCharacterRightIndexC,
    eCharacterRightMiddleA,
    eCharacterRightMiddleB,
    eCharacterRightMiddleC,
    eCharacterRightRingA,
    eCharacterRightRingB,
    eCharacterRightRingC,
    eCharacterRightPinkyA,
    eCharacterRightPinkyB,
    eCharacterRightPinkyC,
    eCharacterReference,
    eCharacterLeftFloor,
    eCharacterRightFloor,
    eCharacterHipsTranslation,
    eCharacterProps0,
    eCharacterProps1,
    eCharacterProps2,
    eCharacterProps3,
    eCharacterProps4,

    // Added in 4.0x as patch.

    eCharacterGameModeParentLeftHipRoll,
    eCharacterGameModeParentLeftKnee,
    eCharacterGameModeParentLeftKneeRoll,
    eCharacterGameModeParentRightHipRoll,
    eCharacterGameModeParentRightKnee,
    eCharacterGameModeParentRightKneeRoll,
    eCharacterGameModeParentLeftShoulderRoll,   
    eCharacterGameModeParentLeftElbow,  
    eCharacterGameModeParentLeftElbowRoll,  
    eCharacterGameModeParentRightShoulderRoll,
    eCharacterGameModeParentRightElbow,     
    eCharacterGameModeParentRightElbowRoll, 


    // Elements added for Dominus.
    // From this point, the enum doesn't have to be synchronized with the HumanIK library.

    eCharacterLeftHandFloor,
    eCharacterRightHandFloor,

    eCharacterLeftHand,
    eCharacterRightHand,
    
    eCharacterNeck1,
    eCharacterNeck2,
    eCharacterNeck3,
    eCharacterNeck4,
    eCharacterNeck5,
    eCharacterNeck6,
    eCharacterNeck7,
    eCharacterNeck8,
    eCharacterNeck9,

    eCharacterLeftInHandThumb,
    eCharacterLeftThumbD,
    
    eCharacterLeftInHandIndex,
    eCharacterLeftIndexD,
    
    eCharacterLeftInHandMiddle,
    eCharacterLeftMiddleD,
    
    eCharacterLeftInHandRing,
    eCharacterLeftRingD,
    
    eCharacterLeftInHandPinky,
    eCharacterLeftPinkyD,

    eCharacterLeftInHandExtraFinger,
    eCharacterLeftExtraFingerA,
    eCharacterLeftExtraFingerB,
    eCharacterLeftExtraFingerC,
    eCharacterLeftExtraFingerD,

    eCharacterRightInHandThumb,
    eCharacterRightThumbD,
    
    eCharacterRightInHandIndex,
    eCharacterRightIndexD,
    
    eCharacterRightInHandMiddle,
    eCharacterRightMiddleD,
    
    eCharacterRightInHandRing,
    eCharacterRightRingD,
    
    eCharacterRightInHandPinky,
    eCharacterRightPinkyD,

    eCharacterRightInHandExtraFinger,
    eCharacterRightExtraFingerA,
    eCharacterRightExtraFingerB,
    eCharacterRightExtraFingerC,
    eCharacterRightExtraFingerD,

    eCharacterLeftInFootThumb,
    eCharacterLeftFootThumbA,
    eCharacterLeftFootThumbB,
    eCharacterLeftFootThumbC,
    eCharacterLeftFootThumbD,
    eCharacterLeftInFootIndex,
    eCharacterLeftFootIndexA,
    eCharacterLeftFootIndexB,
    eCharacterLeftFootIndexC,
    eCharacterLeftFootIndexD,
    eCharacterLeftInFootMiddle,
    eCharacterLeftFootMiddleA,
    eCharacterLeftFootMiddleB,
    eCharacterLeftFootMiddleC,
    eCharacterLeftFootMiddleD,
    eCharacterLeftInFootRing,
    eCharacterLeftFootRingA,
    eCharacterLeftFootRingB,
    eCharacterLeftFootRingC,
    eCharacterLeftFootRingD,
    eCharacterLeftInFootPinky,
    eCharacterLeftFootPinkyA,
    eCharacterLeftFootPinkyB,
    eCharacterLeftFootPinkyC,
    eCharacterLeftFootPinkyD,
    eCharacterLeftInFootExtraFinger,
    eCharacterLeftFootExtraFingerA,
    eCharacterLeftFootExtraFingerB,
    eCharacterLeftFootExtraFingerC,
    eCharacterLeftFootExtraFingerD,

    eCharacterRightInFootThumb,
    eCharacterRightFootThumbA,
    eCharacterRightFootThumbB,
    eCharacterRightFootThumbC,
    eCharacterRightFootThumbD,
    eCharacterRightInFootIndex,
    eCharacterRightFootIndexA,
    eCharacterRightFootIndexB,
    eCharacterRightFootIndexC,
    eCharacterRightFootIndexD,
    eCharacterRightInFootMiddle,
    eCharacterRightFootMiddleA,
    eCharacterRightFootMiddleB,
    eCharacterRightFootMiddleC,
    eCharacterRightFootMiddleD,
    eCharacterRightInFootRing,
    eCharacterRightFootRingA,
    eCharacterRightFootRingB,
    eCharacterRightFootRingC,
    eCharacterRightFootRingD,
    eCharacterRightInFootPinky,
    eCharacterRightFootPinkyA,
    eCharacterRightFootPinkyB,
    eCharacterRightFootPinkyC,
    eCharacterRightFootPinkyD,
    eCharacterRightInFootExtraFinger,
    eCharacterRightFootExtraFingerA,
    eCharacterRightFootExtraFingerB,
    eCharacterRightFootExtraFingerC,
    eCharacterRightFootExtraFingerD,

    eCharacterLastNodeId
} ECharacterNodeId;


typedef enum 
{
    eCharacterGroup_Base,
    eCharacterGroup_Auxiliary,
    eCharacterGroup_Spine,
    eCharacterGroup_Roll,
    eCharacterGroup_Special,
    eCharacterGroup_LeftHand,
    eCharacterGroup_RightHand,
    eCharacterGroup_Props,
    eCharacterGroup_GameModeParent,

    // Added for 4.5 

    eCharacterGroup_Neck,
    eCharacterGroup_LeftFoot,
    eCharacterGroup_RightFoot,

    eLastCharacterGroupId
} ECharacterGroupId;


typedef enum 
{
    eCharacterLink,
    eControlSetLink,
    eControlSetEffector,
    eControlSetEffectorAux
} ECharacterLinkType;

class KFBX_DLL KFbxCharacterLink
{
public:

    KFbxCharacterLink();
    KFbxCharacterLink(const KFbxCharacterLink& pCharacterLink);
    KFbxCharacterLink& operator=(const KFbxCharacterLink& pCharacterLink);
    void Reset();

    KFbxNode* mNode;

    KString mTemplateName;

    KFbxVector4 mOffsetT;
    KFbxVector4 mOffsetR;
    KFbxVector4 mOffsetS;
    KFbxVector4 mParentROffset;

    bool        mHasRotSpace;
    KFbxLimits  mRLimits;
    KFbxVector4 mPreRotation;
    KFbxVector4 mPostRotation;
    int         mRotOrder;
    double      mAxisLen;


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS    

    KFbxProperty mPropertyLink;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

class KFBX_DLL KFbxCharacter : public KFbxConstraint
{
    KFBXOBJECT_DECLARE(KFbxCharacter);

public:
    void Reset();

    void SetInput(ECharacterInputType pInputType, KFbxObject* pInputObject = NULL);

    ECharacterInputType GetInputType() const;

    KFbxObject* GetInputObject() const;

    bool SetCharacterLink(ECharacterNodeId pCharacterNodeId, const KFbxCharacterLink& pCharacterLink, bool pUpdateObjectList = true);

    bool GetCharacterLink(ECharacterNodeId pCharacterNodeId, KFbxCharacterLink* pCharacterLink = NULL) const;

    KFbxControlSet& GetControlSet() const;

    KFbxFilterSet& GetFilterSet() const;

    static int GetCharacterGroupCount(ECharacterGroupId pCharacterGroupId);

    static ECharacterNodeId GetCharacterGroupElementByIndex(ECharacterGroupId pCharacterGroupId, int pIndex);

    
    static char* GetCharacterGroupNameByIndex(ECharacterGroupId pCharacterGroupId, int pIndex);

    static int GetCharacterGroupVersionByIndex(ECharacterGroupId pCharacterGroupId, int pIndex);

    static bool FindCharacterGroupIndexByName(char* pName, bool pForceGroupId, ECharacterGroupId& pCharacterGroupId, int& pIndex);

    static bool GetCharacterGroupIndexByElement(ECharacterNodeId pCharacterNodeId, ECharacterGroupId& pCharacterGroupId, int& pIndex);

    static bool GetCharacterGroupVersionByElement(ECharacterNodeId pCharacterNodeId, int& pVersion);

    static bool GetCharacterNodeNameFromNodeId(ECharacterNodeId pCharacterNodeId, char*& pName);

    static bool GetCharacterNodeIdFromNodeName(char* pName, ECharacterNodeId& pCharacterNodeId);

    typedef enum 
    {
        eINTERNAL_ERROR,
        eERROR_COUNT
    } EError; 


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS    

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

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

protected:
    KFbxCharacter& operator=(KFbxCharacter const& pCharacter); 

public:
    virtual KFbxObject::ENameSpace GetNameSpace() const; 

    static char const* GetNamePrefix() { return CONSTRAINT_PREFIX; }
    
    KFbxCharacter(KFbxSdkManager& pManager, char const* pName);
    ~KFbxCharacter();

    virtual void Destruct(bool pRecursive, bool pDependents);

    virtual EConstraintType GetConstraintType();
    virtual KString         GetTypeName() const;

    virtual KStringList GetTypeFlags() const;

    // KFbxTakeNodeContainer virtual functions
    virtual void AddChannels(KFbxTakeNode *pTakeNode);

    bool FbxPlugNotify(KFbxPlugEvent const &pEvent);

    KFbxCharacter_Internal* mPH;
    
    bool GetFilterSetNameFromPropertyNameOrModeAndIndex( char const*  &pFilterSetName, char const* pPropertyName, int pIndex )const ;
    bool GetPropertyNameAndModeNameAndIndexFromFilterSetName(char const* &pPropertyName,char const* &pPropertyModeName,int &pIndex, char const* pFilterSetName) const;  
    
    KError mError;

    KString mName;  
    KFbxCharacterLink mCharacterLink[eCharacterLastNodeId];
    KFbxControlSet* mControlSet;
    KFbxFilterSet* mFilterSet;

    friend class KFbxScene;
    friend class KFbxNode;
    friend class KFbxReaderFbx;
    friend class KFbxCharacter_Internal;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

protected:
    
};

typedef KFbxCharacter* HKFbxCharacter;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_CHARACTER_H_