vrshoot

annotate libs/assimp/MDCLoader.h @ 1:e7ca128b8713

find changesets by author, revision, files, or words in the commit message
looks nice :)
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 02 Feb 2014 00:35:22 +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 /** @file MDCLoader.h
nuclear@0 42 * @brief Definition of the MDC importer class.
nuclear@0 43 */
nuclear@0 44 #ifndef AI_MDCLOADER_H_INCLUDED
nuclear@0 45 #define AI_MDCLOADER_H_INCLUDED
nuclear@0 46
nuclear@0 47 #include "assimp/types.h"
nuclear@0 48
nuclear@0 49 #include "BaseImporter.h"
nuclear@0 50 #include "MDCFileData.h"
nuclear@0 51 #include "ByteSwap.h"
nuclear@0 52
nuclear@0 53 namespace Assimp {
nuclear@0 54 using namespace MDC;
nuclear@0 55
nuclear@0 56 // ---------------------------------------------------------------------------
nuclear@0 57 /** Importer class to load the RtCW MDC file format
nuclear@0 58 */
nuclear@0 59 class MDCImporter : public BaseImporter
nuclear@0 60 {
nuclear@0 61 public:
nuclear@0 62 MDCImporter();
nuclear@0 63 ~MDCImporter();
nuclear@0 64
nuclear@0 65
nuclear@0 66 public:
nuclear@0 67
nuclear@0 68 // -------------------------------------------------------------------
nuclear@0 69 /** Returns whether the class can handle the format of the given file.
nuclear@0 70 * See BaseImporter::CanRead() for details. */
nuclear@0 71 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
nuclear@0 72 bool checkSig) const;
nuclear@0 73
nuclear@0 74 // -------------------------------------------------------------------
nuclear@0 75 /** Called prior to ReadFile().
nuclear@0 76 * The function is a request to the importer to update its configuration
nuclear@0 77 * basing on the Importer's configuration property list.
nuclear@0 78 */
nuclear@0 79 void SetupProperties(const Importer* pImp);
nuclear@0 80
nuclear@0 81 protected:
nuclear@0 82
nuclear@0 83 // -------------------------------------------------------------------
nuclear@0 84 /** Return importer meta information.
nuclear@0 85 * See #BaseImporter::GetInfo for the details
nuclear@0 86 */
nuclear@0 87 const aiImporterDesc* GetInfo () const;
nuclear@0 88
nuclear@0 89 // -------------------------------------------------------------------
nuclear@0 90 /** Imports the given file into the given scene structure.
nuclear@0 91 * See BaseImporter::InternReadFile() for details
nuclear@0 92 */
nuclear@0 93 void InternReadFile( const std::string& pFile, aiScene* pScene,
nuclear@0 94 IOSystem* pIOHandler);
nuclear@0 95
nuclear@0 96 protected:
nuclear@0 97
nuclear@0 98
nuclear@0 99 // -------------------------------------------------------------------
nuclear@0 100 /** Validate the header of the file
nuclear@0 101 */
nuclear@0 102 void ValidateHeader();
nuclear@0 103
nuclear@0 104 // -------------------------------------------------------------------
nuclear@0 105 /** Validate the header of a MDC surface
nuclear@0 106 */
nuclear@0 107 void ValidateSurfaceHeader(BE_NCONST MDC::Surface* pcSurf);
nuclear@0 108
nuclear@0 109 protected:
nuclear@0 110
nuclear@0 111
nuclear@0 112 /** Configuration option: frame to be loaded */
nuclear@0 113 unsigned int configFrameID;
nuclear@0 114
nuclear@0 115 /** Header of the MDC file */
nuclear@0 116 BE_NCONST MDC::Header* pcHeader;
nuclear@0 117
nuclear@0 118 /** Buffer to hold the loaded file */
nuclear@0 119 unsigned char* mBuffer;
nuclear@0 120
nuclear@0 121 /** size of the file, in bytes */
nuclear@0 122 unsigned int fileSize;
nuclear@0 123 };
nuclear@0 124
nuclear@0 125 } // end of namespace Assimp
nuclear@0 126
nuclear@0 127 #endif // AI_3DSIMPORTER_H_INC
nuclear@0 128