FBX SDK Reference Guide: kfbxconstraintrotation.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTROTATION_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTROTATION_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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
00043 #include <fbxfilesdk/components/kbaselib/kaydara.h>
00044 
00045 #include <fbxfilesdk/kfbxplugins/kfbxconstraint.h>
00046 #include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
00047 
00048 #include <fbxfilesdk/components/kbaselib/klib/kerror.h>
00049 
00050 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00051 
00052 class KFbxSdkManager;
00053 class KFbxVector4;
00054 
00059 class KFBX_DLL KFbxConstraintRotation : public KFbxConstraint
00060 {
00061     KFBXOBJECT_DECLARE(KFbxConstraintRotation,KFbxConstraint);
00062 
00067             KFbxTypedProperty<fbxBool1>     Lock;
00068             KFbxTypedProperty<fbxBool1>     Active;
00069 
00070             KFbxTypedProperty<fbxBool1>     AffectX;
00071             KFbxTypedProperty<fbxBool1>     AffectY;
00072             KFbxTypedProperty<fbxBool1>     AffectZ;
00073 
00074             KFbxTypedProperty<fbxDouble1>   Weight;
00075             KFbxTypedProperty<fbxDouble3>   Rotation;
00076             KFbxTypedProperty<fbxReference> SourceWeights;
00077 
00078             KFbxTypedProperty<fbxReference> ConstraintSources;
00079             KFbxTypedProperty<fbxReference> ConstrainedObject;
00080             
00081             
00083 
00084 public:
00088     void SetLock(bool pLock);
00089 
00093     bool GetLock();
00094 
00098     void SetActive(bool pActive);
00099 
00103     bool GetActive();
00104 
00108     void SetAffectX(bool pAffect);
00109 
00113     bool GetAffectX();
00114 
00118     void SetAffectY(bool pAffect);
00119 
00123     bool GetAffectY();
00124 
00128     void SetAffectZ(bool pAffect);
00129 
00133     bool GetAffectZ();
00134 
00138     void SetWeight(double pWeight);
00139 
00143     virtual void SetOffset(KFbxVector4 pRotation);
00144 
00148     KFbxVector4 GetOffset();
00149 
00153     double GetSourceWeight(KFbxObject* pObject);
00154 
00159     void AddConstraintSource(KFbxObject* pObject, double pWeight = 100);
00160 
00164     int GetConstraintSourceCount();
00165 
00170     KFbxObject* GetConstraintSource(int pIndex);
00171 
00175     void SetConstrainedObject(KFbxObject* pObject);
00176 
00180     KFbxObject* GetConstrainedObject();
00181 
00182 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00183 
00184     // Clone
00185     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00186 
00187 protected:
00188     
00189     KFbxConstraintRotation(KFbxSdkManager& pManager, char const* pName);
00190     ~KFbxConstraintRotation();
00191 
00192     virtual bool ConstructProperties(bool pForceSet);
00193     virtual void Destruct(bool pRecursive, bool pDependents);
00194 
00195     virtual EConstraintType GetConstraintType();
00196     virtual KString GetTypeName() const;
00197 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00198 };
00199 
00200 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00201 
00202 #endif // FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTROTATION_H
00203