1/*
2Open Asset Import Library (assimp)
3----------------------------------------------------------------------
4
5Copyright (c) 2006-2017, assimp team
6
7All rights reserved.
8
9Redistribution and use of this software in source and binary forms,
10with or without modification, are permitted provided that the
11following conditions are met:
12
13* Redistributions of source code must retain the above
14 copyright notice, this list of conditions and the
15 following disclaimer.
16
17* Redistributions in binary form must reproduce the above
18 copyright notice, this list of conditions and the
19 following disclaimer in the documentation and/or other
20 materials provided with the distribution.
21
22* Neither the name of the assimp team, nor the names of its
23 contributors may be used to endorse or promote products
24 derived from this software without specific prior
25 written permission of the assimp team.
26
27THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
39----------------------------------------------------------------------
40*/
41
42/** @file MD2Loader.h
43 * @brief Declaration of the .MD2 importer class.
44 */
45#ifndef AI_MD2LOADER_H_INCLUDED
46#define AI_MD2LOADER_H_INCLUDED
47
48#include "BaseImporter.h"
49#include <assimp/types.h>
50#include "ByteSwapper.h"
51#include "MD2FileData.h"
52
53struct aiNode;
54
55namespace Assimp {
56
57using namespace MD2;
58
59// ---------------------------------------------------------------------------
60/** Importer class for MD2
61*/
62class MD2Importer : public BaseImporter
63{
64public:
65 MD2Importer();
66 ~MD2Importer();
67
68
69public:
70
71 // -------------------------------------------------------------------
72 /** Returns whether the class can handle the format of the given file.
73 * See BaseImporter::CanRead() for details. */
74 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
75 bool checkSig) const;
76
77
78 // -------------------------------------------------------------------
79 /** Called prior to ReadFile().
80 * The function is a request to the importer to update its configuration
81 * basing on the Importer's configuration property list.
82 */
83 void SetupProperties(const Importer* pImp);
84
85protected:
86
87 // -------------------------------------------------------------------
88 /** Return importer meta information.
89 * See #BaseImporter::GetInfo for the details
90 */
91 const aiImporterDesc* GetInfo () const;
92
93 // -------------------------------------------------------------------
94 /** Imports the given file into the given scene structure.
95 * See BaseImporter::InternReadFile() for details
96 */
97 void InternReadFile( const std::string& pFile, aiScene* pScene,
98 IOSystem* pIOHandler);
99
100
101 // -------------------------------------------------------------------
102 /** Validate the header of the file
103 */
104 void ValidateHeader();
105
106protected:
107
108 /** Configuration option: frame to be loaded */
109 unsigned int configFrameID;
110
111 /** Header of the MD2 file */
112 BE_NCONST MD2::Header* m_pcHeader;
113
114 /** Buffer to hold the loaded file */
115 BE_NCONST uint8_t* mBuffer;
116
117 /** Size of the file, in bytes */
118 unsigned int fileSize;
119};
120
121} // end of namespace Assimp
122
123#endif // AI_3DSIMPORTER_H_INC
124