FBX SDK Reference Guide: kfbxconstraintposition.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_CONSTRAINT_POSITION_H_
00005 #define _FBXSDK_CONSTRAINT_POSITION_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright  2001 - 2008 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 
00042 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 
00049 #include <kfbxplugins/kfbxconstraint.h>
00050 #include <kfbxplugins/kfbxgroupname.h>
00051 
00052 #include <klib/kerror.h>
00053 
00054 #include <fbxfilesdk_nsbegin.h>
00055 
00056 class KFbxSdkManager;
00057 class KFbxVector4;
00058 
00063 class KFBX_DLL KFbxConstraintPosition : public KFbxConstraint
00064 {
00065     KFBXOBJECT_DECLARE(KFbxConstraintPosition,KFbxConstraint);
00066 
00071             KFbxTypedProperty<fbxBool1>     Lock;
00072             KFbxTypedProperty<fbxBool1>     Active;
00073 
00074             KFbxTypedProperty<fbxBool1>     AffectX;
00075             KFbxTypedProperty<fbxBool1>     AffectY;
00076             KFbxTypedProperty<fbxBool1>     AffectZ;
00077 
00078             KFbxTypedProperty<fbxDouble3>   Translation;
00079             KFbxTypedProperty<fbxDouble1>   Weight;
00080             KFbxTypedProperty<fbxReference> SourceWeights;
00081 
00082             KFbxTypedProperty<fbxReference> ConstraintSources;
00083             KFbxTypedProperty<fbxReference> ConstrainedObject;
00085 public:
00089     void SetLock(bool pLock);
00090 
00094     bool GetLock();
00095 
00099     void SetActive(bool pActive);
00100 
00104     bool GetActive();
00105 
00109     void SetAffectX(bool pAffect);
00110 
00114     bool GetAffectX();
00115 
00119     void SetAffectY(bool pAffect);
00120 
00124     bool GetAffectY();
00125 
00129     void SetAffectZ(bool pAffect);
00130 
00134     bool GetAffectZ();
00135 
00139     virtual void SetOffset(KFbxVector4 pTranslation);
00140 
00144     KFbxVector4 GetOffset();
00145 
00149     void SetWeight(double pWeight);
00150 
00154     double GetSourceWeight(KFbxObject* pObject);
00155 
00160     void AddConstraintSource(KFbxObject* pObject, double pWeight = 100);
00161 
00165     bool RemoveConstraintSource(KFbxObject* pObject);
00166 
00170     int GetConstraintSourceCount();
00171 
00176     KFbxObject* GetConstraintSource(int pIndex);
00177 
00181     void SetConstrainedObject(KFbxObject* pObject);
00182 
00186     KFbxObject* GetConstrainedObject();
00187 
00188 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00189 
00190     // Clone
00191     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00192 
00193 protected:
00194     
00195     KFbxConstraintPosition(KFbxSdkManager& pManager, char const* pName);
00196     ~KFbxConstraintPosition();
00197 
00198     virtual bool ConstructProperties(bool pForceSet);
00199     virtual void Destruct(bool pRecursive, bool pDependents);
00200 
00201     virtual EConstraintType GetConstraintType();
00202     virtual KString GetTypeName() const;
00203 
00204     friend class KFbxWriterFbx6;
00205     friend class KFbxReaderFbx;
00206 
00207 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00208 };
00209 
00210 #include <fbxfilesdk_nsend.h>
00211 
00212 #endif // _FBXSDK_CONSTRAINT_POSITION_H_
00213 
00214