FBX SDK Reference Guide: kfbxconstraint.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_CONSTRAINT_H_
00005 #define _FBXSDK_CONSTRAINT_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/kfbxtakenodecontainer.h>
00050 #include <kfbxplugins/kfbxgroupname.h>
00051 
00052 #include <klib/kerror.h>
00053 #include <klib/kstringlist.h>
00054 
00055 #ifndef MB_FBXSDK
00056 #include <kbaselib_nsuse.h>
00057 #endif
00058 #include <kbaselib_forward.h>
00059 
00060 #include <fbxfilesdk_nsbegin.h>
00061 
00062 class KFbxSdkManager;
00063 class KFbxVector4;
00064 
00068 class KFBX_DLL KFbxConstraint : public KFbxTakeNodeContainer
00069 {
00070     KFBXOBJECT_DECLARE(KFbxConstraint,KFbxTakeNodeContainer);
00071 
00072 public:
00073 
00074 
00086         typedef enum
00087         {
00088             eUNIDENTIFIED,
00089             ePOSITION,
00090             eROTATION,
00091             eSCALE,
00092             ePARENT,
00093             eSINGLECHAIN_IK,
00094             eAIM,
00095             eCHARACTER_CONSTRAINT,
00096             eCONSTRAINT_COUNT
00097         } EConstraintType;
00098 
00102         virtual EConstraintType GetConstraintType() { return eUNIDENTIFIED; }
00103 
00108 
00112         KError& GetError();
00113 
00118         typedef enum
00119         {
00120             eERROR,
00121             eERROR_COUNT
00122         } EError;
00123 
00127         EError GetLastErrorID() const;
00128 
00132         const char* GetLastErrorString() const;
00133 
00135 
00136 
00140         virtual void SetOffset(KFbxVector4 pOffset);
00141 
00143 //
00144 //  WARNING!
00145 //
00146 //  Anything beyond these lines may not be documented accurately and is
00147 //  subject to change without notice.
00148 //
00150 
00151 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00152 
00153     protected:
00154         KFbxConstraint(KFbxSdkManager& pManager, char const* pName);
00155         virtual ~KFbxConstraint();
00156 
00157         virtual KString GetTypeName() const;
00158         virtual KStringList GetTypeFlags() const;
00159 
00160 private:
00161         KError mError;
00162 protected:
00163 
00164         friend class KFbxReaderFbx;
00165         friend class KFbxReaderFbx6;
00166         friend class KFbxWriterFbx;
00167         friend class KFbxWriterFbx6;
00168         friend struct KFbxWriterFbx7Impl;
00169         friend class KFbxScene;
00170 
00171 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00172 };
00173 
00174 typedef KFbxConstraint* HKFbxConstraint;
00175 
00176 #include <fbxfilesdk_nsend.h>
00177 
00178 #endif // _FBXSDK_CONSTRAINT_H_
00179