kfbxcontrolset.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXCHARACTER_KFBXCONTROLSET_H
#define FBXFILESDK_KFBXCHARACTER_KFBXCONTROLSET_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/kfbxcharacter/kfbxcharacter.h>
#include <fbxfilesdk/kfbxmath/kfbxxmatrix.h>
#include <fbxfilesdk/components/kbaselib/klib/kstring.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxNode;
class KFbxSdkManager;
class KFbxControlSetPlug;
class KFbxControlSetPlug_internal;

typedef enum
{
    eEffectorHips = 0,
    eEffectorLeftAnkle,
    eEffectorRightAnkle,
    eEffectorLeftWrist,
    eEffectorRightWrist,
    eEffectorLeftKnee,
    eEffectorRightKnee,
    eEffectorLeftElbow,
    eEffectorRightElbow,
    eEffectorChestOrigin,
    eEffectorChestEnd,
    eEffectorLeftFoot,
    eEffectorRightFoot,
    eEffectorLeftShoulder,
    eEffectorRightShoulder,
    eEffectorHead,
    eEffectorLeftHip,
    eEffectorRightHip,

    // Added for 4.5

    eEffectorLeftHand,
    eEffectorRightHand,

    eEffectorLeftHandThumb,
    eEffectorLeftHandIndex,
    eEffectorLeftHandMiddle,
    eEffectorLeftHandRing,
    eEffectorLeftHandPinky,
    eEffectorLeftHandExtraFinger,

    eEffectorRightHandThumb,
    eEffectorRightHandIndex,
    eEffectorRightHandMiddle,
    eEffectorRightHandRing,
    eEffectorRightHandPinky,
    eEffectorRightHandExtraFinger,

    eEffectorLeftFootThumb,
    eEffectorLeftFootIndex,
    eEffectorLeftFootMiddle,
    eEffectorLeftFootRing,
    eEffectorLeftFootPinky,
    eEffectorLeftFootExtraFinger,

    eEffectorRightFootThumb,
    eEffectorRightFootIndex,
    eEffectorRightFootMiddle,
    eEffectorRightFootRing,
    eEffectorRightFootPinky,
    eEffectorRightFootExtraFinger,

    eEffectorLastNodeId
} EEffectorNodeId;

typedef enum
{
    eEffectorSetDefault = 0,
    eEffectorSetAux1,
    eEffectorSetAux2,
    eEffectorSetAux3,
    eEffectorSetAux4,
    eEffectorSetAux5,
    eEffectorSetAux6,
    eEffectorSetAux7,
    eEffectorSetAux8,
    eEffectorSetAux9,
    eEffectorSetAux10,
    eEffectorSetAux11,
    eEffectorSetAux12,
    eEffectorSetAux13,
    eEffectorSetAux14,
    eLastEffectorSetId
} EEffectorSetId;


class KFBX_DLL KFbxControlSetLink
{

public:

    KFbxControlSetLink();

    KFbxControlSetLink(const KFbxControlSetLink& pControlSetLink);
    KFbxControlSetLink& operator=(const KFbxControlSetLink& pControlSetLink);

    void Reset();

    KFbxNode* mNode;

    KString mTemplateName;
};

class KFBX_DLL KFbxEffector
{

public:

    KFbxEffector();
    KFbxEffector& operator=(const KFbxEffector& pEffector);

    void Reset();

    KFbxNode* mNode;

    bool mShow;

    // These members are for backward compatibility and should not be used. These properties are now published through class KFbxControlSetPlug.
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    bool mTActive;
    bool mRActive;
    bool mCandidateTActive;
    bool mCandidateRActive;
#endif
};

class KFBX_DLL KFbxControlSet
{

public:
    KFBXNEW_DECLARE_FRIEND
    void Reset();

    enum EType
    {
        eNone,
        eFkIk,
        eIkOnly
    };

    void SetType(EType pType);

    EType GetType() const;

    void SetUseAxis(bool pUseAxis);

    bool GetUseAxis() const;

    void SetLockTransform(bool pLockTransform);

    bool GetLockTransform()const;

    void SetLock3DPick(bool pLock3DPick);

    bool GetLock3DPick() const;

    bool SetControlSetLink(ECharacterNodeId pCharacterNodeId, const KFbxControlSetLink& pControlSetLink);

    bool GetControlSetLink(ECharacterNodeId pCharacterNodeId, KFbxControlSetLink* pControlSetLink = NULL) const;

    bool SetEffector(EEffectorNodeId pEffectorNodeId, KFbxEffector pEffector);

    bool GetEffector(EEffectorNodeId pEffectorNodeId, KFbxEffector* pEffector = NULL);

    bool SetEffectorAux(EEffectorNodeId pEffectorNodeId, KFbxNode* pNode,EEffectorSetId pEffectorSetId = eEffectorSetAux1);

    bool GetEffectorAux(EEffectorNodeId pEffectorNodeId, KFbxNode** pNode = NULL,EEffectorSetId pEffectorSetId = eEffectorSetAux1) const;

    static char* GetEffectorNodeName(EEffectorNodeId pEffectorNodeId);

    static EEffectorNodeId GetEffectorNodeId(char* pEffectorNodeName);


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:

    KFbxControlSet();
    ~KFbxControlSet();

    KFbxCharacter* mCharacter;
    EType mType;
    bool mUseAxis;
    bool mLockTransform;
    bool mLock3DPick;
    KFbxControlSetLink mControlSetLink[eCharacterLastNodeId]; // Except floor node IDs!
    KFbxEffector mEffector[eEffectorLastNodeId];
    KFbxNode* mEffectorAux[eEffectorLastNodeId][eLastEffectorSetId-1];

    friend class KFbxCharacter;
    friend class KFbxNode;

public:

    void FromPlug(KFbxControlSetPlug *pPlug);
    void ToPlug(KFbxControlSetPlug *pPlug);

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

class KFBX_DLL KFbxControlSetPlug : public KFbxObject
{
    KFBXOBJECT_DECLARE(KFbxControlSetPlug,KFbxObject);
public:

        KFbxTypedProperty<KFbxControlSet::EType>    ControlSetType;
        KFbxTypedProperty<bool>                     UseAxis;
        KFbxTypedProperty<fbxReference*>            Character;


        KError& GetError();

        typedef enum
        {
            eERROR,
            eERROR_COUNT
        } EError;

        EError GetLastErrorID() const;

        const char* GetLastErrorString() const;


    protected:
        KFbxControlSetPlug(KFbxSdkManager& pManager, char const* pName);

        virtual void Construct(const KFbxControlSetPlug* pFrom);

    public:
        virtual KStringList GetTypeFlags() const;

    protected:
        KArrayTemplate<KFbxProperty>    mFKBuf;
        KArrayTemplate<KFbxProperty>    mIKBuf;

        KError mError;

        friend class KFbxScene;
        friend class KFbxControlSet;
};

typedef KFbxControlSetPlug* HKFbxControlSetPlug;
inline EFbxType FbxTypeOf( KFbxControlSet::EType const &pItem ) { return eENUM; }

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXCHARACTER_KFBXCONTROLSET_H