FBX SDK Reference Guide: kfbxconstraintparent.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_CONSTRAINT_PARENT_H_
00005 #define _FBXSDK_CONSTRAINT_PARENT_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 
00058 
00063 class KFBX_DLL KFbxConstraintParent : public KFbxConstraint
00064 {
00065     KFBXOBJECT_DECLARE(KFbxConstraintParent,KFbxConstraint);
00066 
00071             KFbxTypedProperty<fbxBool1>     Lock;
00072             KFbxTypedProperty<fbxBool1>     Active;
00073 
00074             KFbxTypedProperty<fbxBool1>     AffectTranslationX;
00075             KFbxTypedProperty<fbxBool1>     AffectTranslationY;
00076             KFbxTypedProperty<fbxBool1>     AffectTranslationZ;
00077 
00078             KFbxTypedProperty<fbxBool1>     AffectRotationX;
00079             KFbxTypedProperty<fbxBool1>     AffectRotationY;
00080             KFbxTypedProperty<fbxBool1>     AffectRotationZ;
00081 
00082             KFbxTypedProperty<fbxBool1>     AffectScalingX;
00083             KFbxTypedProperty<fbxBool1>     AffectScalingY;
00084             KFbxTypedProperty<fbxBool1>     AffectScalingZ;
00085 
00086             KFbxTypedProperty<fbxDouble1>   Weight;
00087 
00088             KFbxTypedProperty<fbxReference> ConstraintSources;
00089             KFbxTypedProperty<fbxReference> ConstrainedObject;
00091 public:
00095     void SetLock(bool pLock);
00096 
00100     bool GetLock();
00101 
00105     void SetActive(bool pActive);
00106 
00110     bool GetActive();
00111 
00115     void SetAffectTranslationX(bool pAffect);
00116 
00120     bool GetAffectTranslationX();
00121 
00125     void SetAffectTranslationY(bool pAffect);
00126 
00130     bool GetAffectTranslationY();
00131 
00135     void SetAffectTranslationZ(bool pAffect);
00136 
00140     bool GetAffectTranslationZ();
00141 
00145     void SetAffectRotationX(bool pAffect);
00146 
00150     bool GetAffectRotationX();
00151 
00155     void SetAffectRotationY(bool pAffect);
00156 
00160     bool GetAffectRotationY();
00161 
00165     void SetAffectRotationZ(bool pAffect);
00166 
00170     bool GetAffectRotationZ();
00171 
00176     void SetTranslationOffset(KFbxObject* pObject, KFbxVector4 pTranslation);
00177 
00182     KFbxVector4 GetTranslationOffset(KFbxObject* pObject);
00183 
00188     virtual void SetRotationOffset(KFbxObject* pObject, KFbxVector4 pRotation);
00189 
00194     KFbxVector4 GetRotationOffset(KFbxObject* pObject);
00195 
00199     void SetWeight(double pWeight);
00200 
00204     double GetSourceWeight(KFbxObject* pObject);
00205 
00210     void AddConstraintSource(KFbxObject* pObject, double pWeight = 100);
00211 
00215     int GetConstraintSourceCount();
00216 
00221     KFbxObject* GetConstraintSource(int pIndex);
00222 
00226     void SetConstrainedObject(KFbxObject* pObject);
00227 
00231     KFbxObject* GetConstrainedObject();
00232 
00233 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00234 
00235     // Clone
00236     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00237 
00238 protected:
00239 
00240     KFbxConstraintParent(KFbxSdkManager& pManager, char const* pName);
00241     ~KFbxConstraintParent();
00242 
00243     virtual bool ConstructProperties( bool pForceSet );
00244     virtual void Destruct(bool pRecursive, bool pDependents);
00245 
00246     virtual EConstraintType GetConstraintType();
00247     virtual KString GetTypeName() const;
00248 
00249     friend class KFbxWriterFbx6;
00250     friend class KFbxReaderFbx;
00251 
00252 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00253 };
00254 
00255 #include <fbxfilesdk_nsend.h>
00256 
00257 #endif // _FBXSDK_CONSTRAINT_PARENT_H_
00258 
00259