vrshoot
diff libs/assimp/assimp/importerdesc.h @ 0:b2f14e535253
initial commit
author | John Tsiombikas <nuclear@member.fsf.org> |
---|---|
date | Sat, 01 Feb 2014 19:58:19 +0200 |
parents | |
children |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/libs/assimp/assimp/importerdesc.h Sat Feb 01 19:58:19 2014 +0200 1.3 @@ -0,0 +1,136 @@ 1.4 +/* 1.5 +--------------------------------------------------------------------------- 1.6 +Open Asset Import Library (assimp) 1.7 +--------------------------------------------------------------------------- 1.8 + 1.9 +Copyright (c) 2006-2012, assimp team 1.10 + 1.11 +All rights reserved. 1.12 + 1.13 +Redistribution and use of this software in source and binary forms, 1.14 +with or without modification, are permitted provided that the following 1.15 +conditions are met: 1.16 + 1.17 +* Redistributions of source code must retain the above 1.18 + copyright notice, this list of conditions and the 1.19 + following disclaimer. 1.20 + 1.21 +* Redistributions in binary form must reproduce the above 1.22 + copyright notice, this list of conditions and the 1.23 + following disclaimer in the documentation and/or other 1.24 + materials provided with the distribution. 1.25 + 1.26 +* Neither the name of the assimp team, nor the names of its 1.27 + contributors may be used to endorse or promote products 1.28 + derived from this software without specific prior 1.29 + written permission of the assimp team. 1.30 + 1.31 +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1.32 +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1.33 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1.34 +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1.35 +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 1.36 +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 1.37 +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 1.38 +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 1.39 +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 1.40 +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 1.41 +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 1.42 +--------------------------------------------------------------------------- 1.43 +*/ 1.44 + 1.45 +/** @file importerdesc.h 1.46 + * @brief #aiImporterFlags, aiImporterDesc implementation. 1.47 + */ 1.48 +#ifndef INCLUDED_AI_IMPORTER_DESC_H 1.49 +#define INCLUDED_AI_IMPORTER_DESC_H 1.50 + 1.51 + 1.52 +/** Mixed set of flags for #aiImporterDesc, indicating some features 1.53 + * common to many importers*/ 1.54 +enum aiImporterFlags 1.55 +{ 1.56 + /** Indicates that there is a textual encoding of the 1.57 + * file format; and that it is supported.*/ 1.58 + aiImporterFlags_SupportTextFlavour = 0x1, 1.59 + 1.60 + /** Indicates that there is a binary encoding of the 1.61 + * file format; and that it is supported.*/ 1.62 + aiImporterFlags_SupportBinaryFlavour = 0x2, 1.63 + 1.64 + /** Indicates that there is a compressed encoding of the 1.65 + * file format; and that it is supported.*/ 1.66 + aiImporterFlags_SupportCompressedFlavour = 0x4, 1.67 + 1.68 + /** Indicates that the importer reads only a very particular 1.69 + * subset of the file format. This happens commonly for 1.70 + * declarative or procedural formats which cannot easily 1.71 + * be mapped to #aiScene */ 1.72 + aiImporterFlags_LimitedSupport = 0x8, 1.73 + 1.74 + /** Indicates that the importer is highly experimental and 1.75 + * should be used with care. This only happens for trunk 1.76 + * (i.e. SVN) versions, experimental code is not included 1.77 + * in releases. */ 1.78 + aiImporterFlags_Experimental = 0x10, 1.79 +}; 1.80 + 1.81 + 1.82 +/** Meta information about a particular importer. Importers need to fill 1.83 + * this structure, but they can freely decide how talkative they are. 1.84 + * A common use case for loader meta info is a user interface 1.85 + * in which the user can choose between various import/export file 1.86 + * formats. Building such an UI by hand means a lot of maintenance 1.87 + * as importers/exporters are added to Assimp, so it might be useful 1.88 + * to have a common mechanism to query some rough importer 1.89 + * characteristics. */ 1.90 +struct aiImporterDesc 1.91 +{ 1.92 + /** Full name of the importer (i.e. Blender3D importer)*/ 1.93 + const char* mName; 1.94 + 1.95 + /** Original author (left blank if unknown or whole assimp team) */ 1.96 + const char* mAuthor; 1.97 + 1.98 + /** Current maintainer, left blank if the author maintains */ 1.99 + const char* mMaintainer; 1.100 + 1.101 + /** Implementation comments, i.e. unimplemented features*/ 1.102 + const char* mComments; 1.103 + 1.104 + /** Any combination of the #aiLoaderFlags enumerated values. 1.105 + These flags indicate some characteristics common to many 1.106 + importers. */ 1.107 + unsigned int mFlags; 1.108 + 1.109 + /** Minimum format version that can be loaded im major.minor format, 1.110 + both are set to 0 if there is either no version scheme 1.111 + or if the loader doesn't care. */ 1.112 + unsigned int mMinMajor; 1.113 + unsigned int mMinMinor; 1.114 + 1.115 + /** Maximum format version that can be loaded im major.minor format, 1.116 + both are set to 0 if there is either no version scheme 1.117 + or if the loader doesn't care. Loaders that expect to be 1.118 + forward-compatible to potential future format versions should 1.119 + indicate zero, otherwise they should specify the current 1.120 + maximum version.*/ 1.121 + unsigned int mMaxMajor; 1.122 + unsigned int mMaxMinor; 1.123 + 1.124 + /** List of file extensions this importer can handle. 1.125 + List entries are separated by space characters. 1.126 + All entries are lower case without a leading dot (i.e. 1.127 + "xml dae" would be a valid value. Note that multiple 1.128 + importers may respond to the same file extension - 1.129 + assimp calls all importers in the order in which they 1.130 + are registered and each importer gets the opportunity 1.131 + to load the file until one importer "claims" the file. Apart 1.132 + from file extension checks, importers typically use 1.133 + other methods to quickly reject files (i.e. magic 1.134 + words) so this does not mean that common or generic 1.135 + file extensions such as XML would be tediously slow. */ 1.136 + const char* mFileExtensions; 1.137 +}; 1.138 + 1.139 +#endif