kfbxconstraintsinglechainik.h

Go to the documentation of this file.

#ifndef _FBXSDK_CONSTRAINT_SINGLE_CHAIN_IK_H_
#define _FBXSDK_CONSTRAINT_SINGLE_CHAIN_IK_H_

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

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

#include <klib/kerror.h>

#include <kfbxmath/kfbxvector4.h>

#include <fbxfilesdk_nsbegin.h>

class KFbxSdkManager;
class KFbxConstraintSingleChainIK_internal;

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

            KFbxTypedProperty<fbxBool1>     Lock;
            KFbxTypedProperty<fbxBool1>     Active;
            
            KFbxTypedProperty<fbxEnum>      PoleVectorType;
            KFbxTypedProperty<fbxEnum>      SolverType;
            KFbxTypedProperty<fbxEnum>      EvaluateTSAnim;

            KFbxTypedProperty<fbxDouble1>   Weight;
            //KFbxTypedProperty<fbxReference> PoleVectorObjectWeights;
            KFbxTypedProperty<fbxReference> PoleVectorObjects;
            KFbxTypedProperty<fbxDouble3>   PoleVector;
            KFbxTypedProperty<fbxDouble1>   Twist;

            KFbxTypedProperty<fbxReference> FirstJointObject;
            KFbxTypedProperty<fbxReference> EndJointObject;
            KFbxTypedProperty<fbxReference> EffectorObject;

public:
    typedef enum 
    {
        eRP_SOLVER,
        eSC_SOLVER
    } ESolverType;

    typedef enum 
    {
        ePOLE_VECTOR_TYPE_VECTOR,
        ePOLE_VECTOR_TYPE_OBJECT
    } EPoleVectorType;

    typedef enum
    {
        eEVAL_TS_NEVER,
        eEVAL_TS_AUTO_DETECT,
        eEVAL_TS_ALWAYS
    } EEvalTS;

    void SetLock(bool pLock);

    bool GetLock();

    void SetActive(bool pActive);

    bool GetActive();

    void SetPoleVectorType(EPoleVectorType pType);

    EPoleVectorType GetPoleVectorType();

    void SetSolverType(ESolverType pType);

    ESolverType GetSolverType();

    void SetEvalTS(EEvalTS pEval);
    
    EEvalTS GetEvalTS();

    void SetWeight(double pWeight);

    double GetWeight();

//  void AddPoleVectorObjectWeight(double pWeight);

    double GetPoleVectorObjectWeight(KFbxObject* pObject);

    void AddPoleVectorObject(KFbxObject* pObject, double pWeight = 100);

    int GetConstraintPoleVectorCount();

    KFbxObject* GetPoleVectorObject(int pIndex);

    void SetPoleVector(KFbxVector4 pVector);

    KFbxVector4 GetPoleVector();

    void SetTwist(double pTwist);

    double GetTwist();

    void SetFirstJointObject(KFbxObject* pObject);

    KFbxObject* GetFirstJointObject();

    void SetEndJointObject(KFbxObject* pObject);

    KFbxObject* GetEndJointObject();

    void SetEffectorObject(KFbxObject* pObject);

    KFbxObject* GetEffectorObject();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

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

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

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

    virtual void Destruct(bool pRecursive, bool pDependents);

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

    // Entity manipulation
    virtual void AddChannels(KFbxTakeNode *pTakeNode);

    KFbxConstraintSingleChainIK_internal* mPH;

    friend class KFbxWriterFbx6;
    friend class KFbxReaderFbx;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

#include <fbxfilesdk_nsend.h>

#endif // _FBXSDK_CONSTRAINT_SINGLE_CHAIN_IK_H_