FBX SDK Reference Guide: kfbxsubdeformer.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXSUBDEFORMER_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXSUBDEFORMER_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 #include <fbxfilesdk/kfbxmath/kfbxmatrix.h>
00048 
00049 #include <fbxfilesdk/components/kbaselib/klib/kerror.h>
00050 
00051 #include <fbxfilesdk/components/kbaselib/kbaselib_forward.h>
00052 
00053 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00054 
00055 class KFbxGeometry;
00056 class KFbxSdkManager;
00057 
00062 class KFBX_DLL KFbxSubDeformer : public KFbxTakeNodeContainer
00063 {
00064     KFBXOBJECT_DECLARE(KFbxSubDeformer,KFbxTakeNodeContainer);
00065     public:
00066 
00070         void SetMultiLayer(bool pMultiLayer);
00071 
00075         bool GetMultiLayer();
00076 
00080         typedef enum
00081         {
00082             eUNIDENTIFIED,
00083             eCLUSTER,
00084             eSUBDEFORMER_COUNT
00085         } ESubDeformerType;
00086 
00090         virtual ESubDeformerType GetSubDeformerType() { return eUNIDENTIFIED; }
00091 
00096 
00100         KError& GetError();
00101 
00105         typedef enum
00106         {
00107             eERROR,
00108             eERROR_COUNT
00109         } EError;
00110 
00114         EError GetLastErrorID() const;
00115 
00119         const char* GetLastErrorString() const;
00120 
00122 
00124 //
00125 //  WARNING!
00126 //
00127 //  Anything beyond these lines may not be documented accurately and is
00128 //  subject to change without notice.
00129 //
00131 
00132     protected:
00133         KFbxSubDeformer(KFbxSdkManager& pManager, char const* pName);
00134         virtual ~KFbxSubDeformer();
00135         virtual KString     GetTypeName() const { return KString(""); }
00136         virtual KStringList GetTypeFlags() const { return KStringList(); }
00137 
00138         // Local
00139         KError mError;
00140         bool   mMultiLayer;
00141 
00142         friend class KFbxGeometry;
00143         friend class KFbxScene;
00144 };
00145 
00146 typedef KFbxSubDeformer* HKFbxSubDeformer;
00147 
00148 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00149 
00150 #endif // FBXFILESDK_KFBXPLUGINS_KFBXSUBDEFORMER_H
00151