Show in Contents

Add to Favorites

Home: FBX SDK Programmers Guide

 

 

 

FBX SDK Reference Guide: kfbxconstraintaim.h Source File

Go to the documentation of this file.

#ifndef _FBXSDK_CONSTRAINT_AIM_H_
#define _FBXSDK_CONSTRAINT_AIM_H_

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

 Copyright © 2001 - 2008 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 <kfbxmath/kfbxvector4.h>

#include <klib/kerror.h>

#include <fbxfilesdk_nsbegin.h>

    class KFbxSdkManager;

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

            KFbxTypedProperty<fbxBool1>     Lock;
            KFbxTypedProperty<fbxBool1>     Active;

            KFbxTypedProperty<fbxDouble1>   Weight;
            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
        } EAimConstraintWoldUpType;

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

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

        inline void SetActive(bool pActive) { Active.Set(pActive); }

        inline bool GetActive() { return Active.Get(); }

        void SetWeight(double pWeight);

        virtual void SetOffset(KFbxVector4 pRotation);

        KFbxVector4 GetOffset();

        double GetSourceWeight(KFbxObject* pObject);

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

        int GetConstraintSourceCount();

        KFbxObject* GetConstraintSource(int pIndex);

        void SetConstrainedObject(KFbxObject* pObject);

        KFbxObject* GetConstrainedObject();

        void SetWorldUpType(EAimConstraintWoldUpType pType);

        EAimConstraintWoldUpType GetWorldUpType();

        void SetWorldUpObject(KFbxObject* pObject);

        KFbxObject* GetWorldUpObject();

        void SetWorldUpVector(KFbxVector4 pVector);

        KFbxVector4 GetWorldUpVector();

        void SetUpVector(KFbxVector4 pVector);

        KFbxVector4 GetUpVector();

        void SetAimVector(KFbxVector4 pVector);

        KFbxVector4 GetAimVector();

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

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

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

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

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

        inline bool GetAffectZ() { 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);
        ~KFbxConstraintAim();

        virtual bool ConstructProperties(bool pForceSet);
        virtual void Destruct(bool pRecursive, bool pDependents);

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

        friend class KFbxWriterFbx6;
        friend class KFbxReaderFbx;

    #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
    };

inline EFbxType FbxTypeOf( KFbxConstraintAim::EAimConstraintWoldUpType const &pItem )               { return eENUM; }

#include <fbxfilesdk_nsend.h>

#endif // _FBXSDK_CONSTRAINT_AIM_H_