kfbxconstraintsinglechainik.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTSINGLECHAINIK_H
#define FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTSINGLECHAINIK_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/kfbxplugins/kfbxconstraint.h>
#include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>

#include <fbxfilesdk/components/kbaselib/klib/kerror.h>

#include <fbxfilesdk/kfbxmath/kfbxvector4.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxSdkManager;

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

public:
            KFbxTypedProperty<fbxEnum>        PoleVectorType;

            KFbxTypedProperty<fbxEnum>        SolverType;

            KFbxTypedProperty<fbxEnum>        EvaluateTSAnim;

            //KFbxTypedProperty<fbxReference> PoleVectorObjectWeights;

            KFbxTypedProperty<fbxReference>    PoleVectorObjects;

            KFbxTypedProperty<fbxDouble3>    PoleVector;

            KFbxTypedProperty<fbxDouble1>    Twist;

            KFbxTypedProperty<fbxReference> FirstJointObject;

            KFbxTypedProperty<fbxReference> EndJointObject;

            KFbxTypedProperty<fbxReference> EffectorObject;

    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() const;

    void SetPoleVectorType(EPoleVectorType pType);

    EPoleVectorType GetPoleVectorType() const;

    void SetSolverType(ESolverType pType);

    ESolverType GetSolverType() const;

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

    void SetWeight(double pWeight);

    double GetWeight() const;

    
//    void AddPoleVectorObjectWeight(double pWeight);

    double GetPoleVectorObjectWeight(const KFbxObject* pObject) const;

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

    int GetConstraintPoleVectorCount() const;

    KFbxObject* GetPoleVectorObject(int pIndex) const;

    void SetPoleVector(KFbxVector4 pVector);

    KFbxVector4 GetPoleVector() const;

    void SetTwist(double pTwist);

    double GetTwist() const;

    void SetFirstJointObject(KFbxObject* pObject);

    KFbxObject* GetFirstJointObject() const;

    void SetEndJointObject(KFbxObject* pObject);

    KFbxObject* GetEndJointObject() const;

    void SetEffectorObject(KFbxObject* pObject);

    KFbxObject* GetEffectorObject() const;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

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

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

    virtual bool ConstructProperties( bool pForceSet );

    virtual EConstraintType GetConstraintType() const;
    virtual    KString    GetTypeName() const;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

inline EFbxType FbxTypeOf( KFbxConstraintSingleChainIK::EPoleVectorType const &pItem )                { return eENUM; }
inline EFbxType FbxTypeOf( KFbxConstraintSingleChainIK::ESolverType const &pItem )                { return eENUM; }
inline EFbxType FbxTypeOf( KFbxConstraintSingleChainIK::EEvalTS const &pItem )                { return eENUM; }


#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTSINGLECHAINIK_H