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