nuclear@0: /* nuclear@0: Open Asset Import Library (assimp) nuclear@0: ---------------------------------------------------------------------- nuclear@0: nuclear@0: Copyright (c) 2006-2012, assimp team nuclear@0: All rights reserved. nuclear@0: nuclear@0: Redistribution and use of this software in source and binary forms, nuclear@0: with or without modification, are permitted provided that the nuclear@0: following conditions are met: nuclear@0: nuclear@0: * Redistributions of source code must retain the above nuclear@0: copyright notice, this list of conditions and the nuclear@0: following disclaimer. nuclear@0: nuclear@0: * Redistributions in binary form must reproduce the above nuclear@0: copyright notice, this list of conditions and the nuclear@0: following disclaimer in the documentation and/or other nuclear@0: materials provided with the distribution. nuclear@0: nuclear@0: * Neither the name of the assimp team, nor the names of its nuclear@0: contributors may be used to endorse or promote products nuclear@0: derived from this software without specific prior nuclear@0: written permission of the assimp team. nuclear@0: nuclear@0: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS nuclear@0: "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT nuclear@0: LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR nuclear@0: A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT nuclear@0: OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, nuclear@0: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT nuclear@0: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, nuclear@0: DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY nuclear@0: THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT nuclear@0: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE nuclear@0: OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. nuclear@0: nuclear@0: ---------------------------------------------------------------------- nuclear@0: */ nuclear@0: nuclear@0: /** @file XFileImporter.h nuclear@0: * @brief Definition of the XFile importer class. nuclear@0: */ nuclear@0: #ifndef AI_XFILEIMPORTER_H_INC nuclear@0: #define AI_XFILEIMPORTER_H_INC nuclear@0: nuclear@0: #include nuclear@0: nuclear@0: #include "XFileHelper.h" nuclear@0: #include "BaseImporter.h" nuclear@0: nuclear@0: #include "assimp/types.h" nuclear@0: nuclear@0: struct aiNode; nuclear@0: nuclear@0: namespace Assimp { nuclear@0: nuclear@0: namespace XFile { nuclear@0: struct Scene; nuclear@0: struct Node; nuclear@0: } nuclear@0: nuclear@0: // --------------------------------------------------------------------------- nuclear@0: /** The XFileImporter is a worker class capable of importing a scene from a nuclear@0: * DirectX file .x nuclear@0: */ nuclear@0: class XFileImporter : public BaseImporter nuclear@0: { nuclear@0: public: nuclear@0: XFileImporter(); nuclear@0: ~XFileImporter(); nuclear@0: nuclear@0: nuclear@0: public: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Returns whether the class can handle the format of the given file. nuclear@0: * See BaseImporter::CanRead() for details. */ nuclear@0: bool CanRead( const std::string& pFile, IOSystem* pIOHandler, nuclear@0: bool CheckSig) const; nuclear@0: nuclear@0: protected: nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Return importer meta information. nuclear@0: * See #BaseImporter::GetInfo for the details nuclear@0: */ nuclear@0: const aiImporterDesc* GetInfo () const; nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Imports the given file into the given scene structure. nuclear@0: * See BaseImporter::InternReadFile() for details nuclear@0: */ nuclear@0: void InternReadFile( const std::string& pFile, aiScene* pScene, nuclear@0: IOSystem* pIOHandler); nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Constructs the return data structure out of the imported data. nuclear@0: * @param pScene The scene to construct the return data in. nuclear@0: * @param pData The imported data in the internal temporary nuclear@0: * representation. nuclear@0: */ nuclear@0: void CreateDataRepresentationFromImport( aiScene* pScene, XFile::Scene* pData); nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Recursively creates scene nodes from the imported hierarchy. nuclear@0: * The meshes and materials of the nodes will be extracted on the way. nuclear@0: * @param pScene The scene to construct the return data in. nuclear@0: * @param pParent The parent node where to create new child nodes nuclear@0: * @param pNode The temporary node to copy. nuclear@0: * @return The created node nuclear@0: */ nuclear@0: aiNode* CreateNodes( aiScene* pScene, aiNode* pParent, nuclear@0: const XFile::Node* pNode); nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Converts all meshes in the given mesh array. Each mesh is split nuclear@0: * up per material, the indices of the generated meshes are stored in nuclear@0: * the node structure. nuclear@0: * @param pScene The scene to construct the return data in. nuclear@0: * @param pNode The target node structure that references the nuclear@0: * constructed meshes. nuclear@0: * @param pMeshes The array of meshes to convert nuclear@0: */ nuclear@0: void CreateMeshes( aiScene* pScene, aiNode* pNode, nuclear@0: const std::vector& pMeshes); nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Converts the animations from the given imported data and creates nuclear@0: * them in the scene. nuclear@0: * @param pScene The scene to hold to converted animations nuclear@0: * @param pData The data to read the animations from nuclear@0: */ nuclear@0: void CreateAnimations( aiScene* pScene, const XFile::Scene* pData); nuclear@0: nuclear@0: // ------------------------------------------------------------------- nuclear@0: /** Converts all materials in the given array and stores them in the nuclear@0: * scene's material list. nuclear@0: * @param pScene The scene to hold the converted materials. nuclear@0: * @param pMaterials The material array to convert. nuclear@0: */ nuclear@0: void ConvertMaterials( aiScene* pScene, std::vector& pMaterials); nuclear@0: nuclear@0: protected: nuclear@0: /** Buffer to hold the loaded file */ nuclear@0: std::vector mBuffer; nuclear@0: }; nuclear@0: nuclear@0: } // end of namespace Assimp nuclear@0: nuclear@0: #endif // AI_BASEIMPORTER_H_INC