vrshoot

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

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/libs/assimp/XFileImporter.h	Sat Feb 01 19:58:19 2014 +0200
     1.3 @@ -0,0 +1,150 @@
     1.4 +/*
     1.5 +Open Asset Import Library (assimp)
     1.6 +----------------------------------------------------------------------
     1.7 +
     1.8 +Copyright (c) 2006-2012, assimp team
     1.9 +All rights reserved.
    1.10 +
    1.11 +Redistribution and use of this software in source and binary forms, 
    1.12 +with or without modification, are permitted provided that the 
    1.13 +following conditions are met:
    1.14 +
    1.15 +* Redistributions of source code must retain the above
    1.16 +  copyright notice, this list of conditions and the
    1.17 +  following disclaimer.
    1.18 +
    1.19 +* Redistributions in binary form must reproduce the above
    1.20 +  copyright notice, this list of conditions and the
    1.21 +  following disclaimer in the documentation and/or other
    1.22 +  materials provided with the distribution.
    1.23 +
    1.24 +* Neither the name of the assimp team, nor the names of its
    1.25 +  contributors may be used to endorse or promote products
    1.26 +  derived from this software without specific prior
    1.27 +  written permission of the assimp team.
    1.28 +
    1.29 +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
    1.30 +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
    1.31 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    1.32 +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
    1.33 +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    1.34 +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
    1.35 +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    1.36 +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
    1.37 +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
    1.38 +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
    1.39 +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    1.40 +
    1.41 +----------------------------------------------------------------------
    1.42 +*/
    1.43 +
    1.44 +/** @file  XFileImporter.h 
    1.45 + *  @brief Definition of the XFile importer class. 
    1.46 + */
    1.47 +#ifndef AI_XFILEIMPORTER_H_INC
    1.48 +#define AI_XFILEIMPORTER_H_INC
    1.49 +
    1.50 +#include <map>
    1.51 +
    1.52 +#include "XFileHelper.h"
    1.53 +#include "BaseImporter.h"
    1.54 +
    1.55 +#include "assimp/types.h"
    1.56 +
    1.57 +struct aiNode;
    1.58 +
    1.59 +namespace Assimp	{
    1.60 +
    1.61 +namespace XFile {
    1.62 +struct Scene;
    1.63 +struct Node;
    1.64 +}
    1.65 +
    1.66 +// ---------------------------------------------------------------------------
    1.67 +/** The XFileImporter is a worker class capable of importing a scene from a
    1.68 + * DirectX file .x
    1.69 + */
    1.70 +class XFileImporter : public BaseImporter
    1.71 +{
    1.72 +public:
    1.73 +	XFileImporter();
    1.74 +	~XFileImporter();
    1.75 +
    1.76 +
    1.77 +public:
    1.78 +	// -------------------------------------------------------------------
    1.79 +	/** Returns whether the class can handle the format of the given file. 
    1.80 +	 * See BaseImporter::CanRead() for details.	*/
    1.81 +	bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
    1.82 +		bool CheckSig) const;
    1.83 +
    1.84 +protected:
    1.85 +
    1.86 +	// -------------------------------------------------------------------
    1.87 +	/** Return importer meta information.
    1.88 +	 * See #BaseImporter::GetInfo for the details
    1.89 +	 */
    1.90 +	const aiImporterDesc* GetInfo () const;
    1.91 +
    1.92 +	// -------------------------------------------------------------------
    1.93 +	/** Imports the given file into the given scene structure. 
    1.94 +	 * See BaseImporter::InternReadFile() for details
    1.95 +	 */
    1.96 +	void InternReadFile( const std::string& pFile, aiScene* pScene, 
    1.97 +		IOSystem* pIOHandler);
    1.98 +
    1.99 +	// -------------------------------------------------------------------
   1.100 +	/** Constructs the return data structure out of the imported data.
   1.101 +	 * @param pScene The scene to construct the return data in.
   1.102 +	 * @param pData The imported data in the internal temporary 
   1.103 +	 *   representation.
   1.104 +	 */
   1.105 +	void CreateDataRepresentationFromImport( aiScene* pScene, XFile::Scene* pData);
   1.106 +
   1.107 +	// -------------------------------------------------------------------
   1.108 +	/** Recursively creates scene nodes from the imported hierarchy.
   1.109 +	 * The meshes and materials of the nodes will be extracted on the way.
   1.110 +	 * @param pScene The scene to construct the return data in.
   1.111 +	 * @param pParent The parent node where to create new child nodes
   1.112 +	 * @param pNode The temporary node to copy.
   1.113 +	 * @return The created node 
   1.114 +	 */
   1.115 +	aiNode* CreateNodes( aiScene* pScene, aiNode* pParent, 
   1.116 +		const XFile::Node* pNode);
   1.117 +
   1.118 +	// -------------------------------------------------------------------
   1.119 +	/** Converts all meshes in the given mesh array. Each mesh is split 
   1.120 +	 * up per material, the indices of the generated meshes are stored in 
   1.121 +	 * the node structure.
   1.122 +	 * @param pScene The scene to construct the return data in.
   1.123 +	 * @param pNode The target node structure that references the
   1.124 +	 *   constructed meshes.
   1.125 +	 * @param pMeshes The array of meshes to convert
   1.126 +	 */
   1.127 +	void CreateMeshes( aiScene* pScene, aiNode* pNode, 
   1.128 +		const std::vector<XFile::Mesh*>& pMeshes);
   1.129 +
   1.130 +	// -------------------------------------------------------------------
   1.131 +	/** Converts the animations from the given imported data and creates 
   1.132 +	*  them in the scene.
   1.133 +	 * @param pScene The scene to hold to converted animations
   1.134 +	 * @param pData The data to read the animations from
   1.135 +	 */
   1.136 +	void CreateAnimations( aiScene* pScene, const XFile::Scene* pData);
   1.137 +
   1.138 +	// -------------------------------------------------------------------
   1.139 +	/** Converts all materials in the given array and stores them in the
   1.140 +	 *  scene's material list.
   1.141 +	 * @param pScene The scene to hold the converted materials.
   1.142 +	 * @param pMaterials The material array to convert.
   1.143 +	 */
   1.144 +	void ConvertMaterials( aiScene* pScene, std::vector<XFile::Material>& pMaterials);
   1.145 +
   1.146 +protected:
   1.147 +	/** Buffer to hold the loaded file */
   1.148 +	std::vector<char> mBuffer;
   1.149 +};
   1.150 +
   1.151 +} // end of namespace Assimp
   1.152 +
   1.153 +#endif // AI_BASEIMPORTER_H_INC