| rev |
line source |
|
nuclear@0
|
1 /*
|
|
nuclear@0
|
2 ---------------------------------------------------------------------------
|
|
nuclear@0
|
3 Open Asset Import Library (assimp)
|
|
nuclear@0
|
4 ---------------------------------------------------------------------------
|
|
nuclear@0
|
5
|
|
nuclear@0
|
6 Copyright (c) 2006-2012, assimp team
|
|
nuclear@0
|
7
|
|
nuclear@0
|
8 All rights reserved.
|
|
nuclear@0
|
9
|
|
nuclear@0
|
10 Redistribution and use of this software in source and binary forms,
|
|
nuclear@0
|
11 with or without modification, are permitted provided that the following
|
|
nuclear@0
|
12 conditions are met:
|
|
nuclear@0
|
13
|
|
nuclear@0
|
14 * Redistributions of source code must retain the above
|
|
nuclear@0
|
15 copyright notice, this list of conditions and the
|
|
nuclear@0
|
16 following disclaimer.
|
|
nuclear@0
|
17
|
|
nuclear@0
|
18 * Redistributions in binary form must reproduce the above
|
|
nuclear@0
|
19 copyright notice, this list of conditions and the
|
|
nuclear@0
|
20 following disclaimer in the documentation and/or other
|
|
nuclear@0
|
21 materials provided with the distribution.
|
|
nuclear@0
|
22
|
|
nuclear@0
|
23 * Neither the name of the assimp team, nor the names of its
|
|
nuclear@0
|
24 contributors may be used to endorse or promote products
|
|
nuclear@0
|
25 derived from this software without specific prior
|
|
nuclear@0
|
26 written permission of the assimp team.
|
|
nuclear@0
|
27
|
|
nuclear@0
|
28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
nuclear@0
|
29 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
nuclear@0
|
30 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
nuclear@0
|
31 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
nuclear@0
|
32 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
nuclear@0
|
33 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
nuclear@0
|
34 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
nuclear@0
|
35 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
nuclear@0
|
36 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
nuclear@0
|
37 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
nuclear@0
|
38 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
nuclear@0
|
39 ---------------------------------------------------------------------------
|
|
nuclear@0
|
40 */
|
|
nuclear@0
|
41
|
|
nuclear@0
|
42 /** @file importerdesc.h
|
|
nuclear@0
|
43 * @brief #aiImporterFlags, aiImporterDesc implementation.
|
|
nuclear@0
|
44 */
|
|
nuclear@0
|
45 #ifndef INCLUDED_AI_IMPORTER_DESC_H
|
|
nuclear@0
|
46 #define INCLUDED_AI_IMPORTER_DESC_H
|
|
nuclear@0
|
47
|
|
nuclear@0
|
48
|
|
nuclear@0
|
49 /** Mixed set of flags for #aiImporterDesc, indicating some features
|
|
nuclear@0
|
50 * common to many importers*/
|
|
nuclear@0
|
51 enum aiImporterFlags
|
|
nuclear@0
|
52 {
|
|
nuclear@0
|
53 /** Indicates that there is a textual encoding of the
|
|
nuclear@0
|
54 * file format; and that it is supported.*/
|
|
nuclear@0
|
55 aiImporterFlags_SupportTextFlavour = 0x1,
|
|
nuclear@0
|
56
|
|
nuclear@0
|
57 /** Indicates that there is a binary encoding of the
|
|
nuclear@0
|
58 * file format; and that it is supported.*/
|
|
nuclear@0
|
59 aiImporterFlags_SupportBinaryFlavour = 0x2,
|
|
nuclear@0
|
60
|
|
nuclear@0
|
61 /** Indicates that there is a compressed encoding of the
|
|
nuclear@0
|
62 * file format; and that it is supported.*/
|
|
nuclear@0
|
63 aiImporterFlags_SupportCompressedFlavour = 0x4,
|
|
nuclear@0
|
64
|
|
nuclear@0
|
65 /** Indicates that the importer reads only a very particular
|
|
nuclear@0
|
66 * subset of the file format. This happens commonly for
|
|
nuclear@0
|
67 * declarative or procedural formats which cannot easily
|
|
nuclear@0
|
68 * be mapped to #aiScene */
|
|
nuclear@0
|
69 aiImporterFlags_LimitedSupport = 0x8,
|
|
nuclear@0
|
70
|
|
nuclear@0
|
71 /** Indicates that the importer is highly experimental and
|
|
nuclear@0
|
72 * should be used with care. This only happens for trunk
|
|
nuclear@0
|
73 * (i.e. SVN) versions, experimental code is not included
|
|
nuclear@0
|
74 * in releases. */
|
|
nuclear@0
|
75 aiImporterFlags_Experimental = 0x10,
|
|
nuclear@0
|
76 };
|
|
nuclear@0
|
77
|
|
nuclear@0
|
78
|
|
nuclear@0
|
79 /** Meta information about a particular importer. Importers need to fill
|
|
nuclear@0
|
80 * this structure, but they can freely decide how talkative they are.
|
|
nuclear@0
|
81 * A common use case for loader meta info is a user interface
|
|
nuclear@0
|
82 * in which the user can choose between various import/export file
|
|
nuclear@0
|
83 * formats. Building such an UI by hand means a lot of maintenance
|
|
nuclear@0
|
84 * as importers/exporters are added to Assimp, so it might be useful
|
|
nuclear@0
|
85 * to have a common mechanism to query some rough importer
|
|
nuclear@0
|
86 * characteristics. */
|
|
nuclear@0
|
87 struct aiImporterDesc
|
|
nuclear@0
|
88 {
|
|
nuclear@0
|
89 /** Full name of the importer (i.e. Blender3D importer)*/
|
|
nuclear@0
|
90 const char* mName;
|
|
nuclear@0
|
91
|
|
nuclear@0
|
92 /** Original author (left blank if unknown or whole assimp team) */
|
|
nuclear@0
|
93 const char* mAuthor;
|
|
nuclear@0
|
94
|
|
nuclear@0
|
95 /** Current maintainer, left blank if the author maintains */
|
|
nuclear@0
|
96 const char* mMaintainer;
|
|
nuclear@0
|
97
|
|
nuclear@0
|
98 /** Implementation comments, i.e. unimplemented features*/
|
|
nuclear@0
|
99 const char* mComments;
|
|
nuclear@0
|
100
|
|
nuclear@0
|
101 /** Any combination of the #aiLoaderFlags enumerated values.
|
|
nuclear@0
|
102 These flags indicate some characteristics common to many
|
|
nuclear@0
|
103 importers. */
|
|
nuclear@0
|
104 unsigned int mFlags;
|
|
nuclear@0
|
105
|
|
nuclear@0
|
106 /** Minimum format version that can be loaded im major.minor format,
|
|
nuclear@0
|
107 both are set to 0 if there is either no version scheme
|
|
nuclear@0
|
108 or if the loader doesn't care. */
|
|
nuclear@0
|
109 unsigned int mMinMajor;
|
|
nuclear@0
|
110 unsigned int mMinMinor;
|
|
nuclear@0
|
111
|
|
nuclear@0
|
112 /** Maximum format version that can be loaded im major.minor format,
|
|
nuclear@0
|
113 both are set to 0 if there is either no version scheme
|
|
nuclear@0
|
114 or if the loader doesn't care. Loaders that expect to be
|
|
nuclear@0
|
115 forward-compatible to potential future format versions should
|
|
nuclear@0
|
116 indicate zero, otherwise they should specify the current
|
|
nuclear@0
|
117 maximum version.*/
|
|
nuclear@0
|
118 unsigned int mMaxMajor;
|
|
nuclear@0
|
119 unsigned int mMaxMinor;
|
|
nuclear@0
|
120
|
|
nuclear@0
|
121 /** List of file extensions this importer can handle.
|
|
nuclear@0
|
122 List entries are separated by space characters.
|
|
nuclear@0
|
123 All entries are lower case without a leading dot (i.e.
|
|
nuclear@0
|
124 "xml dae" would be a valid value. Note that multiple
|
|
nuclear@0
|
125 importers may respond to the same file extension -
|
|
nuclear@0
|
126 assimp calls all importers in the order in which they
|
|
nuclear@0
|
127 are registered and each importer gets the opportunity
|
|
nuclear@0
|
128 to load the file until one importer "claims" the file. Apart
|
|
nuclear@0
|
129 from file extension checks, importers typically use
|
|
nuclear@0
|
130 other methods to quickly reject files (i.e. magic
|
|
nuclear@0
|
131 words) so this does not mean that common or generic
|
|
nuclear@0
|
132 file extensions such as XML would be tediously slow. */
|
|
nuclear@0
|
133 const char* mFileExtensions;
|
|
nuclear@0
|
134 };
|
|
nuclear@0
|
135
|
|
nuclear@0
|
136 #endif
|
