FBX SDK Reference Guide: kfbxconstraint.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINT_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINT_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/kfbxtakenodecontainer.h>
00046 #include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
00047 
00048 #include <fbxfilesdk/components/kbaselib/klib/kerror.h>
00049 #include <fbxfilesdk/components/kbaselib/klib/kstringlist.h>
00050 
00051 #include <fbxfilesdk/components/kbaselib/kbaselib_forward.h>
00052 
00053 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00054 
00055 class KFbxSdkManager;
00056 class KFbxVector4;
00057 
00061 class KFBX_DLL KFbxConstraint : public KFbxTakeNodeContainer
00062 {
00063     KFBXOBJECT_DECLARE(KFbxConstraint,KFbxTakeNodeContainer);
00064 
00065 public:
00066 
00067 
00079         typedef enum
00080         {
00081             eUNIDENTIFIED,
00082             ePOSITION,
00083             eROTATION,
00084             eSCALE,
00085             ePARENT,
00086             eSINGLECHAIN_IK,
00087             eAIM,
00088             eCHARACTER_CONSTRAINT,
00089             eCONSTRAINT_COUNT
00090         } EConstraintType;
00091 
00095         virtual EConstraintType GetConstraintType() { return eUNIDENTIFIED; }
00096 
00101 
00105         KError& GetError();
00106 
00111         typedef enum
00112         {
00113             eERROR,
00114             eERROR_COUNT
00115         } EError;
00116 
00120         EError GetLastErrorID() const;
00121 
00125         const char* GetLastErrorString() const;
00126 
00128 
00129 
00133         virtual void SetOffset(KFbxVector4 pOffset);
00134 
00136 //
00137 //  WARNING!
00138 //
00139 //  Anything beyond these lines may not be documented accurately and is
00140 //  subject to change without notice.
00141 //
00143 
00144 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00145 
00146     protected:
00147         KFbxConstraint(KFbxSdkManager& pManager, char const* pName);
00148         virtual ~KFbxConstraint();
00149 
00150 public:
00151         virtual KString GetTypeName() const;
00152         virtual KStringList GetTypeFlags() const;
00153 
00154 private:
00155         KError mError;
00156 protected:
00157 
00158         friend class KFbxScene;
00159 
00160 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00161 };
00162 
00163 typedef KFbxConstraint* HKFbxConstraint;
00164 
00165 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00166 
00167 #endif // FBXFILESDK_KFBXPLUGINS_KFBXCONSTRAINT_H
00168