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