fbxconstraint.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_SCENE_CONSTRAINT_H_
#define _FBXSDK_SCENE_CONSTRAINT_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/fbxobject.h>
#include <fbxsdk/core/base/fbxerror.h>
#include <fbxsdk/core/base/fbxstringlist.h>
#include <fbxsdk/scene/fbxgroupname.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxManager;
class FbxVector4;

class FBXSDK_DLL FbxConstraint : public FbxObject
{
    FBXSDK_OBJECT_DECLARE(FbxConstraint, FbxObject);

public:
        FbxPropertyT<FbxDouble> Weight;

        FbxPropertyT<FbxBool> Active;

        FbxPropertyT<FbxBool> Lock;

    enum EType
    {
        eUnknown,           
        ePosition,          
        eRotation,          
        eScale,             
        eParent,            
        eSingleChainIK,     
        eAim,               
        eCharacter,         
        eCustom             
    };

    virtual EType GetConstraintType() const { return eUnknown; }

    virtual FbxObject* GetConstrainedObject() const { return NULL; }

    virtual int GetConstraintSourceCount() const { return 0; }

    virtual FbxObject* GetConstraintSource(int /*pIndex*/) const { return NULL; }

    double GetSourceWeight(const FbxObject* pObject) const;

        FbxError& GetError();

        enum EErrorCode
        {
            eError,     
            eErrorCount 
        };

        EErrorCode GetLastErrorID() const;

        const char* GetLastErrorString() const;

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    FbxConstraint(FbxManager& pManager, char const* pName);
    virtual bool ConstructProperties(bool pForceSet);

private:
    FbxError mError;
    friend class FbxScene;
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};


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

const FbxString GetWeightPropertyName(const FbxObject * pObject);
void CreateWeightPropertyForSourceObject(FbxObject * pConstraint, const FbxObject * pSourceObject, double pWeightValue);

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_CONSTRAINT_H_ */