kfbxconstraintaim.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTAIM_H
#define FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTAIM_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/kfbxmath/kfbxvector4.h>

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

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxSdkManager;

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

public:
        KFbxTypedProperty<fbxDouble3> RotationOffset;

        KFbxTypedProperty<fbxReference> AimAtObjects;

        KFbxTypedProperty<fbxReference> ConstrainedObject;

        KFbxTypedProperty<fbxEnum> WorldUpType;

        KFbxTypedProperty<fbxReference> WorldUpObject;

        KFbxTypedProperty<fbxDouble3> WorldUpVector;

        KFbxTypedProperty<fbxDouble3> UpVector;

        KFbxTypedProperty<fbxDouble3> AimVector;
        
        KFbxTypedProperty<fbxBool1> AffectX;

        KFbxTypedProperty<fbxBool1> AffectY;

        KFbxTypedProperty<fbxBool1> AffectZ;
    

public:
    typedef enum 
    {
        eAimAtSceneUp,
        eAimAtObjectUp,
        eAimAtObjectRotationUp,
        eAimAtVector,
        eAimAtNone,
        eAimAtCount
    } EAimConstraintWorldUpType;

    inline void SetLock(bool pLock) { Lock.Set(pLock); }

    inline bool GetLock()            { return Lock.Get(); }

    void SetWeight(double pWeight);

    virtual void SetOffset(KFbxVector4 pRotation);

    KFbxVector4 GetOffset() const;

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

    int GetConstraintSourceCount() const;

    KFbxObject* GetConstraintSource(int pIndex) const;

    void SetConstrainedObject(KFbxObject* pObject);

    KFbxObject* GetConstrainedObject() const;

    void SetWorldUpType(EAimConstraintWorldUpType pType);

    EAimConstraintWorldUpType GetWorldUpType() const;

    void SetWorldUpObject(KFbxObject* pObject);

    KFbxObject* GetWorldUpObject() const;

    K_DEPRECATED void SetWorldUpVector(KFbxVector4 pVector);

    K_DEPRECATED KFbxVector4 GetWorldUpVector() const;

    K_DEPRECATED void SetUpVector(KFbxVector4 pVector);

    K_DEPRECATED KFbxVector4 GetUpVector() const;

    K_DEPRECATED void SetAimVector(KFbxVector4 pVector);

    K_DEPRECATED KFbxVector4 GetAimVector() const;

    K_DEPRECATED inline void SetAffectX(bool pAffect) { AffectX.Set(pAffect); }

    K_DEPRECATED inline bool GetAffectX() { return AffectX.Get(); }

    K_DEPRECATED inline void SetAffectY(bool pAffect){ AffectY.Set(pAffect); }

    K_DEPRECATED inline bool GetAffectY() const { return AffectY.Get(); }

    K_DEPRECATED inline void SetAffectZ(bool pAffect) { AffectZ.Set(pAffect); }

    K_DEPRECATED inline bool GetAffectZ() const { return AffectZ.Get(); }

#ifndef DOXYGEN_SHOULD_SKIP_THIS

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

protected:

    KFbxConstraintAim(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( KFbxConstraintAim::EAimConstraintWorldUpType const &pItem ) { return eENUM; }

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTAIM_H