FBX SDK Reference Guide: kfbxconstraintscale.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTSCALE_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTSCALE_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 KFbxConstraintScale : public KFbxConstraint
00060 {
00061     KFBXOBJECT_DECLARE(KFbxConstraintScale,KFbxConstraint);
00066             KFbxTypedProperty<fbxBool1>     Lock;
00067             KFbxTypedProperty<fbxBool1>     Active;
00068 
00069             KFbxTypedProperty<fbxBool1>     AffectX;
00070             KFbxTypedProperty<fbxBool1>     AffectY;
00071             KFbxTypedProperty<fbxBool1>     AffectZ;
00072 
00073             KFbxTypedProperty<fbxDouble3>   Scaling;
00074             KFbxTypedProperty<fbxDouble1>   Weight;
00075 
00076             KFbxTypedProperty<fbxReference> ConstraintSources;
00077             KFbxTypedProperty<fbxReference> ConstrainedObject;
00079 
00080 public:
00084     void SetLock(bool pLock);
00085 
00089     bool GetLock();
00090 
00094     void SetActive(bool pActive);
00095 
00099     bool GetActive();
00100 
00104     void SetAffectX(bool pAffect);
00105 
00109     bool GetAffectX();
00110 
00114     void SetAffectY(bool pAffect);
00115 
00119     bool GetAffectY();
00120 
00124     void SetAffectZ(bool pAffect);
00125 
00129     bool GetAffectZ();
00130 
00134     virtual void SetOffset(KFbxVector4 pScale);
00135 
00139     KFbxVector4 GetOffset();
00140 
00144     void SetWeight(double pWeight);
00145 
00149     double GetSourceWeight(KFbxObject* pObject);
00150 
00155     void AddConstraintSource(KFbxObject* pObject, double pWeight = 100);
00156 
00160     int GetConstraintSourceCount();
00161 
00166     KFbxObject* GetConstraintSource(int pIndex);
00167 
00171     void SetConstrainedObject(KFbxObject* pObject);
00172 
00176     KFbxObject* GetConstrainedObject();
00177 
00178 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00179 
00180     // Clone
00181     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00182 
00183 protected:
00184 
00185     KFbxConstraintScale(KFbxSdkManager& pManager, char const* pName);
00186     ~KFbxConstraintScale();
00187 
00188     virtual bool ConstructProperties(bool pForceSet);
00189     virtual void Destruct(bool pRecursive, bool pDependents);
00190 
00191     virtual EConstraintType GetConstraintType();
00192     virtual KString GetTypeName() const;
00193 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00194 };
00195 
00196 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00197 
00198 #endif // FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINTSCALE_H
00199