vrshoot

annotate libs/assimp/XFileImporter.h @ 0:b2f14e535253

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 Open Asset Import Library (assimp)
nuclear@0 3 ----------------------------------------------------------------------
nuclear@0 4
nuclear@0 5 Copyright (c) 2006-2012, assimp team
nuclear@0 6 All rights reserved.
nuclear@0 7
nuclear@0 8 Redistribution and use of this software in source and binary forms,
nuclear@0 9 with or without modification, are permitted provided that the
nuclear@0 10 following conditions are met:
nuclear@0 11
nuclear@0 12 * Redistributions of source code must retain the above
nuclear@0 13 copyright notice, this list of conditions and the
nuclear@0 14 following disclaimer.
nuclear@0 15
nuclear@0 16 * Redistributions in binary form must reproduce the above
nuclear@0 17 copyright notice, this list of conditions and the
nuclear@0 18 following disclaimer in the documentation and/or other
nuclear@0 19 materials provided with the distribution.
nuclear@0 20
nuclear@0 21 * Neither the name of the assimp team, nor the names of its
nuclear@0 22 contributors may be used to endorse or promote products
nuclear@0 23 derived from this software without specific prior
nuclear@0 24 written permission of the assimp team.
nuclear@0 25
nuclear@0 26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 37
nuclear@0 38 ----------------------------------------------------------------------
nuclear@0 39 */
nuclear@0 40
nuclear@0 41 /** @file XFileImporter.h
nuclear@0 42 * @brief Definition of the XFile importer class.
nuclear@0 43 */
nuclear@0 44 #ifndef AI_XFILEIMPORTER_H_INC
nuclear@0 45 #define AI_XFILEIMPORTER_H_INC
nuclear@0 46
nuclear@0 47 #include <map>
nuclear@0 48
nuclear@0 49 #include "XFileHelper.h"
nuclear@0 50 #include "BaseImporter.h"
nuclear@0 51
nuclear@0 52 #include "assimp/types.h"
nuclear@0 53
nuclear@0 54 struct aiNode;
nuclear@0 55
nuclear@0 56 namespace Assimp {
nuclear@0 57
nuclear@0 58 namespace XFile {
nuclear@0 59 struct Scene;
nuclear@0 60 struct Node;
nuclear@0 61 }
nuclear@0 62
nuclear@0 63 // ---------------------------------------------------------------------------
nuclear@0 64 /** The XFileImporter is a worker class capable of importing a scene from a
nuclear@0 65 * DirectX file .x
nuclear@0 66 */
nuclear@0 67 class XFileImporter : public BaseImporter
nuclear@0 68 {
nuclear@0 69 public:
nuclear@0 70 XFileImporter();
nuclear@0 71 ~XFileImporter();
nuclear@0 72
nuclear@0 73
nuclear@0 74 public:
nuclear@0 75 // -------------------------------------------------------------------
nuclear@0 76 /** Returns whether the class can handle the format of the given file.
nuclear@0 77 * See BaseImporter::CanRead() for details. */
nuclear@0 78 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
nuclear@0 79 bool CheckSig) const;
nuclear@0 80
nuclear@0 81 protected:
nuclear@0 82
nuclear@0 83 // -------------------------------------------------------------------
nuclear@0 84 /** Return importer meta information.
nuclear@0 85 * See #BaseImporter::GetInfo for the details
nuclear@0 86 */
nuclear@0 87 const aiImporterDesc* GetInfo () const;
nuclear@0 88
nuclear@0 89 // -------------------------------------------------------------------
nuclear@0 90 /** Imports the given file into the given scene structure.
nuclear@0 91 * See BaseImporter::InternReadFile() for details
nuclear@0 92 */
nuclear@0 93 void InternReadFile( const std::string& pFile, aiScene* pScene,
nuclear@0 94 IOSystem* pIOHandler);
nuclear@0 95
nuclear@0 96 // -------------------------------------------------------------------
nuclear@0 97 /** Constructs the return data structure out of the imported data.
nuclear@0 98 * @param pScene The scene to construct the return data in.
nuclear@0 99 * @param pData The imported data in the internal temporary
nuclear@0 100 * representation.
nuclear@0 101 */
nuclear@0 102 void CreateDataRepresentationFromImport( aiScene* pScene, XFile::Scene* pData);
nuclear@0 103
nuclear@0 104 // -------------------------------------------------------------------
nuclear@0 105 /** Recursively creates scene nodes from the imported hierarchy.
nuclear@0 106 * The meshes and materials of the nodes will be extracted on the way.
nuclear@0 107 * @param pScene The scene to construct the return data in.
nuclear@0 108 * @param pParent The parent node where to create new child nodes
nuclear@0 109 * @param pNode The temporary node to copy.
nuclear@0 110 * @return The created node
nuclear@0 111 */
nuclear@0 112 aiNode* CreateNodes( aiScene* pScene, aiNode* pParent,
nuclear@0 113 const XFile::Node* pNode);
nuclear@0 114
nuclear@0 115 // -------------------------------------------------------------------
nuclear@0 116 /** Converts all meshes in the given mesh array. Each mesh is split
nuclear@0 117 * up per material, the indices of the generated meshes are stored in
nuclear@0 118 * the node structure.
nuclear@0 119 * @param pScene The scene to construct the return data in.
nuclear@0 120 * @param pNode The target node structure that references the
nuclear@0 121 * constructed meshes.
nuclear@0 122 * @param pMeshes The array of meshes to convert
nuclear@0 123 */
nuclear@0 124 void CreateMeshes( aiScene* pScene, aiNode* pNode,
nuclear@0 125 const std::vector<XFile::Mesh*>& pMeshes);
nuclear@0 126
nuclear@0 127 // -------------------------------------------------------------------
nuclear@0 128 /** Converts the animations from the given imported data and creates
nuclear@0 129 * them in the scene.
nuclear@0 130 * @param pScene The scene to hold to converted animations
nuclear@0 131 * @param pData The data to read the animations from
nuclear@0 132 */
nuclear@0 133 void CreateAnimations( aiScene* pScene, const XFile::Scene* pData);
nuclear@0 134
nuclear@0 135 // -------------------------------------------------------------------
nuclear@0 136 /** Converts all materials in the given array and stores them in the
nuclear@0 137 * scene's material list.
nuclear@0 138 * @param pScene The scene to hold the converted materials.
nuclear@0 139 * @param pMaterials The material array to convert.
nuclear@0 140 */
nuclear@0 141 void ConvertMaterials( aiScene* pScene, std::vector<XFile::Material>& pMaterials);
nuclear@0 142
nuclear@0 143 protected:
nuclear@0 144 /** Buffer to hold the loaded file */
nuclear@0 145 std::vector<char> mBuffer;
nuclear@0 146 };
nuclear@0 147
nuclear@0 148 } // end of namespace Assimp
nuclear@0 149
nuclear@0 150 #endif // AI_BASEIMPORTER_H_INC