FBX SDK Reference Guide: kfbxpluginbase.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_PLUGIN_BASE_H_
00005 #define _FBXSDK_PLUGIN_BASE_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 <klib/kstring.h>
00048 #include <klib/karrayul.h>
00049 
00050 #ifndef MB_FBXSDK
00051 #include <kbaselib_nsuse.h>
00052 #endif
00053 #include <kbaselib_forward.h>
00054 
00055 
00056 // Not part of the public FBX SDK
00057 #ifndef K_FBXSDK
00058 
00059 #include <fbxfilesdk_nsbegin.h>
00060 
00061 class KFbxNode;
00062 
00063 
00067 class KFBX_DLL KFbxPluginBase
00068 {
00069 public:
00074 
00076     KFbxPluginBase();
00077 
00079     virtual ~KFbxPluginBase();
00081 
00082 
00086     inline KString FbxRootPrefix() { return KString(mRootPrefix); }
00087 
00091     void MarkAlternativeFbxRoots( KFbxScene* pScene );
00092 
00093 protected:
00101     virtual bool IsAlternativeFbxRootNode(KFbxNode* pNode);
00102 
00103 private:
00104     char* mRootPrefix;
00105 };
00106 
00107 
00111 class KFBX_DLL KFbxPluginImportBase : public KFbxPluginBase
00112 {
00113 public:
00118 
00120     KFbxPluginImportBase();
00121     
00123     virtual ~KFbxPluginImportBase();
00125 
00126 
00131     bool IsExcludedFbxRoot(KFbxNode* pNode);
00132 
00137     void Preprocess(KFbxNode* pRoot);
00138 
00142     bool NeedPreProcess(KFbxNode* pRoot);
00143 
00144 protected:
00145 
00149     virtual bool NeedFbxRoot(KFbxNode* pNode);
00150 
00156     virtual void ComputeWorldTransform(KgeAMatrix& pResMat);
00157 
00165     virtual void CustomApplyWorldTransform(KFbxNode* pRoot, KgeAMatrix& pResMat, bool isIdentity);
00166 
00167 private:
00168 
00169     // keep the list of nodes that would be children
00170     // of the scene in the destination package (this 
00171     // includes Fbx_Root nodes even if their GM is
00172     // an identity and therefore are not processed
00173     // (these nodes will also be found in the mExcludedFbxRoot)
00174     KArrayTemplate<KFbxNode*> mFbxRootChildren;
00175 
00176     // keep a list of FbxRoot nodes that have an identity GM
00177     // and thus that should not be created in the destination
00178     // package. However they need to exist with their Fbx
00179     // transform to allow the correct processing of the rest
00180     // of the hierarchy objects
00181     KArrayTemplate<KFbxNode*> mExcludedFbxRoot;
00182 };
00183 
00184 #include <fbxfilesdk_nsend.h>
00185 
00186 #endif // #ifndef K_FBXSDK
00187 #endif // _FBXSDK_PLUGIN_BASE_H_
00188