kfbxconstraintaim.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTAIM_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTAIM_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2001 - 2010 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 #include <fbxfilesdk/kfbxplugins/kfbxconstraint.h>
00044 #include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
00045 #include <fbxfilesdk/kfbxmath/kfbxvector4.h>
00046 
00047 #include <fbxfilesdk/components/kbaselib/klib/kerror.h>
00048 
00049 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00050 
00051 class KFbxSdkManager;
00052 
00057 class KFBX_DLL KFbxConstraintAim : public KFbxConstraint
00058 {
00059     KFBXOBJECT_DECLARE(KFbxConstraintAim,KFbxConstraint);
00060 
00061 public:
00070         KFbxTypedProperty<fbxDouble3> RotationOffset;
00071 
00074         KFbxTypedProperty<fbxReference> AimAtObjects;
00075 
00078         KFbxTypedProperty<fbxReference> ConstrainedObject;
00079 
00082         KFbxTypedProperty<fbxEnum> WorldUpType;
00083 
00086         KFbxTypedProperty<fbxReference> WorldUpObject;
00087 
00092         KFbxTypedProperty<fbxDouble3> WorldUpVector;
00093 
00098         KFbxTypedProperty<fbxDouble3> UpVector;
00099 
00104         KFbxTypedProperty<fbxDouble3> AimVector;
00105         
00110         KFbxTypedProperty<fbxBool1> AffectX;
00111 
00116         KFbxTypedProperty<fbxBool1> AffectY;
00117 
00122         KFbxTypedProperty<fbxBool1> AffectZ;
00124     
00125 
00126 public:
00135     typedef enum 
00136     {
00137         eAimAtSceneUp,
00138         eAimAtObjectUp,
00139         eAimAtObjectRotationUp,
00140         eAimAtVector,
00141         eAimAtNone,
00142         eAimAtCount
00143     } EAimConstraintWorldUpType;
00144 
00148     inline void SetLock(bool pLock) { Lock.Set(pLock); }
00149 
00153     inline bool GetLock()            { return Lock.Get(); }
00154 
00158     void SetWeight(double pWeight);
00159 
00163     virtual void SetOffset(KFbxVector4 pRotation);
00164 
00168     KFbxVector4 GetOffset() const;
00169 
00174     void AddConstraintSource(KFbxObject* pObject, double pWeight = 100);
00175 
00179     int GetConstraintSourceCount() const;
00180 
00185     KFbxObject* GetConstraintSource(int pIndex) const;
00186 
00190     void SetConstrainedObject(KFbxObject* pObject);
00191 
00195     KFbxObject* GetConstrainedObject() const;
00196 
00200     void SetWorldUpType(EAimConstraintWorldUpType pType);
00201 
00205     EAimConstraintWorldUpType GetWorldUpType() const;
00206 
00210     void SetWorldUpObject(KFbxObject* pObject);
00211 
00215     KFbxObject* GetWorldUpObject() const;
00216 
00219     K_DEPRECATED void SetWorldUpVector(KFbxVector4 pVector);
00220 
00223     K_DEPRECATED KFbxVector4 GetWorldUpVector() const;
00224 
00227     K_DEPRECATED void SetUpVector(KFbxVector4 pVector);
00228 
00231     K_DEPRECATED KFbxVector4 GetUpVector() const;
00232 
00235     K_DEPRECATED void SetAimVector(KFbxVector4 pVector);
00236 
00239     K_DEPRECATED KFbxVector4 GetAimVector() const;
00240 
00243     K_DEPRECATED inline void SetAffectX(bool pAffect) { AffectX.Set(pAffect); }
00244 
00247     K_DEPRECATED inline bool GetAffectX() { return AffectX.Get(); }
00248 
00251     K_DEPRECATED inline void SetAffectY(bool pAffect){ AffectY.Set(pAffect); }
00252 
00255     K_DEPRECATED inline bool GetAffectY() const { return AffectY.Get(); }
00256 
00259     K_DEPRECATED inline void SetAffectZ(bool pAffect) { AffectZ.Set(pAffect); }
00260 
00263     K_DEPRECATED inline bool GetAffectZ() const { return AffectZ.Get(); }
00264 
00265 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00266 
00267     // Clone
00268 virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00269 
00270 protected:
00271 
00272     KFbxConstraintAim(KFbxSdkManager& pManager, char const* pName);
00273 
00274     virtual bool ConstructProperties(bool pForceSet);
00275 
00276     virtual EConstraintType GetConstraintType() const;
00277     virtual    KString    GetTypeName() const;
00278 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00279 };
00280 
00281 inline EFbxType FbxTypeOf( KFbxConstraintAim::EAimConstraintWorldUpType const &pItem ) { return eENUM; }
00282 
00283 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00284 
00285 #endif // FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTAIM_H
00286