FBX SDK Reference Guide: kfbxconstraintrotation.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_CONSTRAINT_ROTATION_H_
00005 #define _FBXSDK_CONSTRAINT_ROTATION_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 KFbxConstraintRotation : public KFbxConstraint
00064 {
00065     KFBXOBJECT_DECLARE(KFbxConstraintRotation,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<fbxDouble1>   Weight;
00079             KFbxTypedProperty<fbxDouble3>   Rotation;
00080             KFbxTypedProperty<fbxReference> SourceWeights;
00081 
00082             KFbxTypedProperty<fbxReference> ConstraintSources;
00083             KFbxTypedProperty<fbxReference> ConstrainedObject;
00084             
00085             
00087 
00088 public:
00092     void SetLock(bool pLock);
00093 
00097     bool GetLock();
00098 
00102     void SetActive(bool pActive);
00103 
00107     bool GetActive();
00108 
00112     void SetAffectX(bool pAffect);
00113 
00117     bool GetAffectX();
00118 
00122     void SetAffectY(bool pAffect);
00123 
00127     bool GetAffectY();
00128 
00132     void SetAffectZ(bool pAffect);
00133 
00137     bool GetAffectZ();
00138 
00142     void SetWeight(double pWeight);
00143 
00147     virtual void SetOffset(KFbxVector4 pRotation);
00148 
00152     KFbxVector4 GetOffset();
00153 
00157     double GetSourceWeight(KFbxObject* pObject);
00158 
00163     void AddConstraintSource(KFbxObject* pObject, double pWeight = 100);
00164 
00168     int GetConstraintSourceCount();
00169 
00174     KFbxObject* GetConstraintSource(int pIndex);
00175 
00179     void SetConstrainedObject(KFbxObject* pObject);
00180 
00184     KFbxObject* GetConstrainedObject();
00185 
00186 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00187 
00188     // Clone
00189     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00190 
00191 protected:
00192     
00193     KFbxConstraintRotation(KFbxSdkManager& pManager, char const* pName);
00194     ~KFbxConstraintRotation();
00195 
00196     virtual bool ConstructProperties(bool pForceSet);
00197     virtual void Destruct(bool pRecursive, bool pDependents);
00198 
00199     virtual EConstraintType GetConstraintType();
00200     virtual KString GetTypeName() const;
00201 
00202     friend class KFbxWriterFbx6;
00203     friend class KFbxReaderFbx;
00204 
00205 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00206 };
00207 
00208 #include <fbxfilesdk_nsend.h>
00209 
00210 #endif // _FBXSDK_CONSTRAINT_ROTATION_H_
00211 
00212