FBX SDK Reference Guide: kfbxsubdeformer.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_SUB_DEFORMER_H_
00005 #define _FBXSDK_SUB_DEFORMER_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 #include <kfbxmath/kfbxmatrix.h>
00052 
00053 #include <klib/kerror.h>
00054 
00055 #include <kbaselib_forward.h>
00056 
00057 #include <fbxfilesdk_nsbegin.h>
00058 
00059 class KFbxGeometry;
00060 class KFbxSdkManager;
00061 
00066 class KFBX_DLL KFbxSubDeformer : public KFbxTakeNodeContainer
00067 {
00068     KFBXOBJECT_DECLARE(KFbxSubDeformer,KFbxTakeNodeContainer);
00069     public:
00070 
00074         void SetMultiLayer(bool pMultiLayer);
00075 
00079         bool GetMultiLayer();
00080 
00084         typedef enum
00085         {
00086             eUNIDENTIFIED,
00087             eCLUSTER,
00088             eSUBDEFORMER_COUNT
00089         } ESubDeformerType;
00090 
00094         virtual ESubDeformerType GetSubDeformerType() { return eUNIDENTIFIED; }
00095 
00100 
00104         KError& GetError();
00105 
00109         typedef enum
00110         {
00111             eERROR,
00112             eERROR_COUNT
00113         } EError;
00114 
00118         EError GetLastErrorID() const;
00119 
00123         const char* GetLastErrorString() const;
00124 
00126 
00128 //
00129 //  WARNING!
00130 //
00131 //  Anything beyond these lines may not be documented accurately and is
00132 //  subject to change without notice.
00133 //
00135 
00136     protected:
00137         KFbxSubDeformer(KFbxSdkManager& pManager, char const* pName);
00138         virtual ~KFbxSubDeformer();
00139         virtual KString     GetTypeName() const { return KString(""); }
00140         virtual KStringList GetTypeFlags() const { return KStringList(); }
00141 
00142         // Local
00143         KError mError;
00144         bool   mMultiLayer;
00145 
00146         friend class KFbxGeometry;
00147         friend class KFbxReaderFbx;
00148         friend class KFbxReaderFbx6;
00149         friend class KFbxWriterFbx;
00150         friend class KFbxWriterFbx6;
00151         friend class KFbxScene;
00152 };
00153 
00154 typedef KFbxSubDeformer* HKFbxSubDeformer;
00155 
00156 #include <fbxfilesdk_nsend.h>
00157 
00158 #endif // _FBXSDK_SUB_DEFORMER_H_
00159 
00160