vrshoot

annotate libs/assimp/MD5Loader.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
nuclear@0 42 /** @file MD5Loader.h
nuclear@0 43 * @brief Definition of the .MD5 importer class.
nuclear@0 44 * http://www.modwiki.net/wiki/MD5_(file_format)
nuclear@0 45 */
nuclear@0 46 #ifndef AI_MD5LOADER_H_INCLUDED
nuclear@0 47 #define AI_MD5LOADER_H_INCLUDED
nuclear@0 48
nuclear@0 49 #include "BaseImporter.h"
nuclear@0 50 #include "MD5Parser.h"
nuclear@0 51
nuclear@0 52 #include "assimp/types.h"
nuclear@0 53
nuclear@0 54 namespace Assimp {
nuclear@0 55
nuclear@0 56 class IOStream;
nuclear@0 57 using namespace Assimp::MD5;
nuclear@0 58
nuclear@0 59 // ---------------------------------------------------------------------------
nuclear@0 60 /** Importer class for the MD5 file format
nuclear@0 61 */
nuclear@0 62 class MD5Importer : public BaseImporter
nuclear@0 63 {
nuclear@0 64 public:
nuclear@0 65 MD5Importer();
nuclear@0 66 ~MD5Importer();
nuclear@0 67
nuclear@0 68
nuclear@0 69 public:
nuclear@0 70
nuclear@0 71 // -------------------------------------------------------------------
nuclear@0 72 /** Returns whether the class can handle the format of the given file.
nuclear@0 73 * See BaseImporter::CanRead() for details.
nuclear@0 74 */
nuclear@0 75 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
nuclear@0 76 bool checkSig) const;
nuclear@0 77
nuclear@0 78 protected:
nuclear@0 79
nuclear@0 80 // -------------------------------------------------------------------
nuclear@0 81 /** Return importer meta information.
nuclear@0 82 * See #BaseImporter::GetInfo for the details
nuclear@0 83 */
nuclear@0 84 const aiImporterDesc* GetInfo () const;
nuclear@0 85
nuclear@0 86 // -------------------------------------------------------------------
nuclear@0 87 /** Called prior to ReadFile().
nuclear@0 88 * The function is a request to the importer to update its configuration
nuclear@0 89 * basing on the Importer's configuration property list.
nuclear@0 90 */
nuclear@0 91 void SetupProperties(const Importer* pImp);
nuclear@0 92
nuclear@0 93 // -------------------------------------------------------------------
nuclear@0 94 /** Imports the given file into the given scene structure.
nuclear@0 95 * See BaseImporter::InternReadFile() for details
nuclear@0 96 */
nuclear@0 97 void InternReadFile( const std::string& pFile, aiScene* pScene,
nuclear@0 98 IOSystem* pIOHandler);
nuclear@0 99
nuclear@0 100 protected:
nuclear@0 101
nuclear@0 102
nuclear@0 103 // -------------------------------------------------------------------
nuclear@0 104 /** Load a *.MD5MESH file.
nuclear@0 105 */
nuclear@0 106 void LoadMD5MeshFile ();
nuclear@0 107
nuclear@0 108 // -------------------------------------------------------------------
nuclear@0 109 /** Load a *.MD5ANIM file.
nuclear@0 110 */
nuclear@0 111 void LoadMD5AnimFile ();
nuclear@0 112
nuclear@0 113 // -------------------------------------------------------------------
nuclear@0 114 /** Load a *.MD5CAMERA file.
nuclear@0 115 */
nuclear@0 116 void LoadMD5CameraFile ();
nuclear@0 117
nuclear@0 118 // -------------------------------------------------------------------
nuclear@0 119 /** Construct node hierarchy from a given MD5ANIM
nuclear@0 120 * @param iParentID Current parent ID
nuclear@0 121 * @param piParent Parent node to attach to
nuclear@0 122 * @param bones Input bones
nuclear@0 123 * @param node_anims Generated node animations
nuclear@0 124 */
nuclear@0 125 void AttachChilds_Anim(int iParentID,aiNode* piParent,
nuclear@0 126 AnimBoneList& bones,const aiNodeAnim** node_anims);
nuclear@0 127
nuclear@0 128 // -------------------------------------------------------------------
nuclear@0 129 /** Construct node hierarchy from a given MD5MESH
nuclear@0 130 * @param iParentID Current parent ID
nuclear@0 131 * @param piParent Parent node to attach to
nuclear@0 132 * @param bones Input bones
nuclear@0 133 */
nuclear@0 134 void AttachChilds_Mesh(int iParentID,aiNode* piParent,BoneList& bones);
nuclear@0 135
nuclear@0 136 // -------------------------------------------------------------------
nuclear@0 137 /** Build unique vertex buffers from a given MD5ANIM
nuclear@0 138 * @param meshSrc Input data
nuclear@0 139 */
nuclear@0 140 void MakeDataUnique (MD5::MeshDesc& meshSrc);
nuclear@0 141
nuclear@0 142 // -------------------------------------------------------------------
nuclear@0 143 /** Load the contents of a specific file into memory and
nuclear@0 144 * alocates a buffer to keep it.
nuclear@0 145 *
nuclear@0 146 * mBuffer is modified to point to this buffer.
nuclear@0 147 * @param pFile File stream to be read
nuclear@0 148 */
nuclear@0 149 void LoadFileIntoMemory (IOStream* pFile);
nuclear@0 150 void UnloadFileFromMemory ();
nuclear@0 151
nuclear@0 152
nuclear@0 153 /** IOSystem to be used to access files */
nuclear@0 154 IOSystem* mIOHandler;
nuclear@0 155
nuclear@0 156 /** Path to the file, excluding the file extension but
nuclear@0 157 with the dot */
nuclear@0 158 std::string mFile;
nuclear@0 159
nuclear@0 160 /** Buffer to hold the loaded file */
nuclear@0 161 char* mBuffer;
nuclear@0 162
nuclear@0 163 /** Size of the file */
nuclear@0 164 unsigned int fileSize;
nuclear@0 165
nuclear@0 166 /** Current line number. For debugging purposes */
nuclear@0 167 unsigned int iLineNumber;
nuclear@0 168
nuclear@0 169 /** Scene to be filled */
nuclear@0 170 aiScene* pScene;
nuclear@0 171
nuclear@0 172 /** (Custom) I/O handler implementation */
nuclear@0 173 IOSystem* pIOHandler;
nuclear@0 174
nuclear@0 175 /** true if a MD5MESH file has already been parsed */
nuclear@0 176 bool bHadMD5Mesh;
nuclear@0 177
nuclear@0 178 /** true if a MD5ANIM file has already been parsed */
nuclear@0 179 bool bHadMD5Anim;
nuclear@0 180
nuclear@0 181 /** true if a MD5CAMERA file has already been parsed */
nuclear@0 182 bool bHadMD5Camera;
nuclear@0 183
nuclear@0 184 /** configuration option: prevent anim autoload */
nuclear@0 185 bool configNoAutoLoad;
nuclear@0 186 };
nuclear@0 187
nuclear@0 188 } // end of namespace Assimp
nuclear@0 189
nuclear@0 190 #endif // AI_3DSIMPORTER_H_INC