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: 
nuclear@0: /** @file   MD5Loader.h
nuclear@0:  *  @brief Definition of the .MD5 importer class.
nuclear@0:  *  http://www.modwiki.net/wiki/MD5_(file_format)
nuclear@0: */
nuclear@0: #ifndef AI_MD5LOADER_H_INCLUDED
nuclear@0: #define AI_MD5LOADER_H_INCLUDED
nuclear@0: 
nuclear@0: #include "BaseImporter.h"
nuclear@0: #include "MD5Parser.h"
nuclear@0: 
nuclear@0: #include "assimp/types.h"
nuclear@0: 
nuclear@0: namespace Assimp	{
nuclear@0: 
nuclear@0: class IOStream;
nuclear@0: using namespace Assimp::MD5;
nuclear@0: 
nuclear@0: // ---------------------------------------------------------------------------
nuclear@0: /** Importer class for the MD5 file format
nuclear@0: */
nuclear@0: class MD5Importer : public BaseImporter
nuclear@0: {
nuclear@0: public:
nuclear@0: 	MD5Importer();
nuclear@0: 	~MD5Importer();
nuclear@0: 
nuclear@0: 
nuclear@0: public:
nuclear@0: 
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:  	 */
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: 	/** Called prior to ReadFile().
nuclear@0: 	 * The function is a request to the importer to update its configuration
nuclear@0: 	 * basing on the Importer's configuration property list.
nuclear@0: 	 */
nuclear@0: 	void SetupProperties(const Importer* pImp);
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: protected:
nuclear@0: 
nuclear@0: 
nuclear@0: 	// -------------------------------------------------------------------
nuclear@0: 	/** Load a *.MD5MESH file.
nuclear@0: 	 */
nuclear@0: 	void LoadMD5MeshFile ();
nuclear@0: 
nuclear@0: 	// -------------------------------------------------------------------
nuclear@0: 	/** Load a *.MD5ANIM file.
nuclear@0: 	 */
nuclear@0: 	void LoadMD5AnimFile ();
nuclear@0: 
nuclear@0: 	// -------------------------------------------------------------------
nuclear@0: 	/** Load a *.MD5CAMERA file.
nuclear@0: 	 */
nuclear@0: 	void LoadMD5CameraFile ();
nuclear@0: 
nuclear@0: 	// -------------------------------------------------------------------
nuclear@0: 	/** Construct node hierarchy from a given MD5ANIM 
nuclear@0: 	 *  @param iParentID Current parent ID
nuclear@0: 	 *  @param piParent Parent node to attach to
nuclear@0: 	 *  @param bones Input bones
nuclear@0: 	 *  @param node_anims Generated node animations
nuclear@0: 	*/
nuclear@0: 	void AttachChilds_Anim(int iParentID,aiNode* piParent, 
nuclear@0: 		AnimBoneList& bones,const aiNodeAnim** node_anims);
nuclear@0: 
nuclear@0: 	// -------------------------------------------------------------------
nuclear@0: 	/** Construct node hierarchy from a given MD5MESH 
nuclear@0: 	 *  @param iParentID Current parent ID
nuclear@0: 	 *  @param piParent Parent node to attach to
nuclear@0: 	 *  @param bones Input bones
nuclear@0: 	*/
nuclear@0: 	void AttachChilds_Mesh(int iParentID,aiNode* piParent,BoneList& bones);
nuclear@0: 
nuclear@0: 	// -------------------------------------------------------------------
nuclear@0: 	/** Build unique vertex buffers from a given MD5ANIM
nuclear@0: 	 *  @param meshSrc Input data
nuclear@0: 	 */
nuclear@0: 	void MakeDataUnique (MD5::MeshDesc& meshSrc);
nuclear@0: 
nuclear@0: 	// -------------------------------------------------------------------
nuclear@0: 	/** Load the contents of a specific file into memory and
nuclear@0: 	 *  alocates a buffer to keep it.
nuclear@0: 	 *
nuclear@0: 	 *  mBuffer is modified to point to this buffer.
nuclear@0: 	 *  @param pFile File stream to be read
nuclear@0: 	*/
nuclear@0: 	void LoadFileIntoMemory (IOStream* pFile);
nuclear@0: 	void UnloadFileFromMemory ();
nuclear@0: 
nuclear@0: 
nuclear@0: 	/** IOSystem to be used to access files */
nuclear@0: 	IOSystem* mIOHandler;
nuclear@0: 
nuclear@0: 	/** Path to the file, excluding the file extension but
nuclear@0: 	    with the dot */
nuclear@0: 	std::string mFile;
nuclear@0: 
nuclear@0: 	/** Buffer to hold the loaded file */
nuclear@0: 	char* mBuffer;
nuclear@0: 
nuclear@0: 	/** Size of the file */
nuclear@0: 	unsigned int fileSize;
nuclear@0: 
nuclear@0: 	/** Current line number. For debugging purposes */
nuclear@0: 	unsigned int iLineNumber;
nuclear@0: 
nuclear@0: 	/** Scene to be filled */
nuclear@0: 	aiScene* pScene;
nuclear@0: 
nuclear@0: 	/** (Custom) I/O handler implementation */
nuclear@0: 	IOSystem* pIOHandler;
nuclear@0: 
nuclear@0: 	/** true if a MD5MESH file has already been parsed */
nuclear@0: 	bool bHadMD5Mesh;
nuclear@0: 
nuclear@0: 	/** true if a MD5ANIM file has already been parsed */
nuclear@0: 	bool bHadMD5Anim;
nuclear@0: 
nuclear@0: 	/** true if a MD5CAMERA file has already been parsed */
nuclear@0: 	bool bHadMD5Camera;
nuclear@0: 
nuclear@0: 	/** configuration option: prevent anim autoload */
nuclear@0: 	bool configNoAutoLoad;
nuclear@0: };
nuclear@0: 
nuclear@0: } // end of namespace Assimp
nuclear@0: 
nuclear@0: #endif // AI_3DSIMPORTER_H_INC