kfbxconstraintposition.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTPOSITION_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTPOSITION_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 
00046 #include <fbxfilesdk/components/kbaselib/klib/kerror.h>
00047 
00048 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00049 
00050 class KFbxSdkManager;
00051 class KFbxVector4;
00052 
00057 class KFBX_DLL KFbxConstraintPosition : public KFbxConstraint
00058 {
00059     KFBXOBJECT_DECLARE(KFbxConstraintPosition,KFbxConstraint);
00060 
00061 public:
00062 
00071             KFbxTypedProperty<fbxBool1>        AffectX;
00072 
00077             KFbxTypedProperty<fbxBool1>        AffectY;
00078 
00083             KFbxTypedProperty<fbxBool1>        AffectZ;
00084 
00089             KFbxTypedProperty<fbxDouble3>    Translation;
00090 
00093             KFbxTypedProperty<fbxReference> ConstraintSources;
00094 
00097             KFbxTypedProperty<fbxReference> ConstrainedObject;
00099 
00103     void SetLock(bool pLock);
00104 
00108     bool GetLock() const;
00109 
00113     void SetAffectX(bool pAffect);
00114 
00118     bool GetAffectX() const;
00119 
00123     void SetAffectY(bool pAffect);
00124 
00128     bool GetAffectY() const;
00129 
00133     void SetAffectZ(bool pAffect);
00134 
00138     bool GetAffectZ() const;
00139 
00143     virtual void SetOffset(KFbxVector4 pTranslation);
00144 
00148     KFbxVector4 GetOffset() const;
00149 
00153     void SetWeight(double pWeight);
00154 
00159     void AddConstraintSource(KFbxObject* pObject, double pWeight = 100);
00160 
00164     bool RemoveConstraintSource(KFbxObject* pObject);
00165 
00169     int GetConstraintSourceCount() const;
00170 
00175     KFbxObject* GetConstraintSource(int pIndex) const;
00176 
00180     void SetConstrainedObject(KFbxObject* pObject);
00181 
00185     KFbxObject* GetConstrainedObject() const;
00186 
00187 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00188 
00189     // Clone
00190     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00191 
00192 protected:
00193     KFbxConstraintPosition(KFbxSdkManager& pManager, char const* pName);
00194 
00195     virtual bool ConstructProperties(bool pForceSet);
00196 
00197     virtual EConstraintType GetConstraintType() const;
00198     virtual    KString    GetTypeName() const;
00199 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00200 };
00201 
00202 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00203 
00204 #endif // FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTPOSITION_H
00205