vrshoot

annotate libs/assimp/HMPLoader.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 /** @file HMPLoader.h
nuclear@0 41 * @brief Declaration of the HMP importer class
nuclear@0 42 */
nuclear@0 43
nuclear@0 44 #ifndef AI_HMPLOADER_H_INCLUDED
nuclear@0 45 #define AI_HMPLOADER_H_INCLUDED
nuclear@0 46
nuclear@0 47 // public ASSIMP headers
nuclear@0 48 #include "assimp/types.h"
nuclear@0 49 #include "assimp/texture.h"
nuclear@0 50 #include "assimp/material.h"
nuclear@0 51
nuclear@0 52 // internal headers
nuclear@0 53 #include "BaseImporter.h"
nuclear@0 54 #include "MDLLoader.h"
nuclear@0 55 #include "HMPFileData.h"
nuclear@0 56
nuclear@0 57 namespace Assimp {
nuclear@0 58 using namespace HMP;
nuclear@0 59
nuclear@0 60 // ---------------------------------------------------------------------------
nuclear@0 61 /** Used to load 3D GameStudio HMP files (terrains)
nuclear@0 62 */
nuclear@0 63 class HMPImporter : public MDLImporter
nuclear@0 64 {
nuclear@0 65 public:
nuclear@0 66 HMPImporter();
nuclear@0 67 ~HMPImporter();
nuclear@0 68
nuclear@0 69
nuclear@0 70 public:
nuclear@0 71
nuclear@0 72 // -------------------------------------------------------------------
nuclear@0 73 /** Returns whether the class can handle the format of the given file.
nuclear@0 74 * See BaseImporter::CanRead() for details.
nuclear@0 75 */
nuclear@0 76 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
nuclear@0 77 bool checkSig) const;
nuclear@0 78
nuclear@0 79 protected:
nuclear@0 80
nuclear@0 81
nuclear@0 82 // -------------------------------------------------------------------
nuclear@0 83 /** Return importer meta information.
nuclear@0 84 * See #BaseImporter::GetInfo for the details
nuclear@0 85 */
nuclear@0 86 const aiImporterDesc* GetInfo () const;
nuclear@0 87
nuclear@0 88 // -------------------------------------------------------------------
nuclear@0 89 /** Imports the given file into the given scene structure.
nuclear@0 90 * See BaseImporter::InternReadFile() for details
nuclear@0 91 */
nuclear@0 92 void InternReadFile( const std::string& pFile, aiScene* pScene,
nuclear@0 93 IOSystem* pIOHandler);
nuclear@0 94
nuclear@0 95 protected:
nuclear@0 96
nuclear@0 97 // -------------------------------------------------------------------
nuclear@0 98 /** Import a HMP4 file
nuclear@0 99 */
nuclear@0 100 void InternReadFile_HMP4( );
nuclear@0 101
nuclear@0 102 // -------------------------------------------------------------------
nuclear@0 103 /** Import a HMP5 file
nuclear@0 104 */
nuclear@0 105 void InternReadFile_HMP5( );
nuclear@0 106
nuclear@0 107 // -------------------------------------------------------------------
nuclear@0 108 /** Import a HMP7 file
nuclear@0 109 */
nuclear@0 110 void InternReadFile_HMP7( );
nuclear@0 111
nuclear@0 112 // -------------------------------------------------------------------
nuclear@0 113 /** Validate a HMP 5,4,7 file header
nuclear@0 114 */
nuclear@0 115 void ValidateHeader_HMP457( );
nuclear@0 116
nuclear@0 117 // -------------------------------------------------------------------
nuclear@0 118 /** Try to load one material from the file, if this fails create
nuclear@0 119 * a default material
nuclear@0 120 */
nuclear@0 121 void CreateMaterial(const unsigned char* szCurrent,
nuclear@0 122 const unsigned char** szCurrentOut);
nuclear@0 123
nuclear@0 124 // -------------------------------------------------------------------
nuclear@0 125 /** Build a list of output faces and vertices. The function
nuclear@0 126 * triangulates the height map read from the file
nuclear@0 127 * \param width Width of the height field
nuclear@0 128 * \param width Height of the height field
nuclear@0 129 */
nuclear@0 130 void CreateOutputFaceList(unsigned int width,unsigned int height);
nuclear@0 131
nuclear@0 132 // -------------------------------------------------------------------
nuclear@0 133 /** Generate planar texture coordinates for a terrain
nuclear@0 134 * \param width Width of the terrain, in vertices
nuclear@0 135 * \param height Height of the terrain, in vertices
nuclear@0 136 */
nuclear@0 137 void GenerateTextureCoords(const unsigned int width,
nuclear@0 138 const unsigned int height);
nuclear@0 139
nuclear@0 140 // -------------------------------------------------------------------
nuclear@0 141 /** Read the first skin from the file and skip all others ...
nuclear@0 142 * \param iNumSkins Number of skins in the file
nuclear@0 143 * \param szCursor Position of the first skin (offset 84)
nuclear@0 144 */
nuclear@0 145 void ReadFirstSkin(unsigned int iNumSkins, const unsigned char* szCursor,
nuclear@0 146 const unsigned char** szCursorOut);
nuclear@0 147
nuclear@0 148 private:
nuclear@0 149
nuclear@0 150 };
nuclear@0 151
nuclear@0 152 } // end of namespace Assimp
nuclear@0 153
nuclear@0 154 #endif // AI_HMPIMPORTER_H_INC
nuclear@0 155