summaryrefslogtreecommitdiffstats
path: root/3rdparty/assimp/code/BlenderLoader.h
blob: ee95de836c45b0e29562941eaa471fe800a8a76e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
/*
Open Asset Import Library (ASSIMP)
----------------------------------------------------------------------

Copyright (c) 2006-2010, ASSIMP Development Team
All rights reserved.

Redistribution and use of this software in source and binary forms,
with or without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.

* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.

* Neither the name of the ASSIMP team, nor the names of its
  contributors may be used to endorse or promote products
  derived from this software without specific prior
  written permission of the ASSIMP Development Team.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

----------------------------------------------------------------------
*/

/** @file  BlenderLoader.h
 *  @brief Declaration of the Blender 3D (*.blend) importer class.
 */
#ifndef INCLUDED_AI_BLEND_LOADER_H
#define INCLUDED_AI_BLEND_LOADER_H

#include "BaseImporter.h"
namespace Assimp    {

    // TinyFormatter.h
    namespace Formatter {
        template <typename T,typename TR, typename A> class basic_formatter;
        typedef class basic_formatter< char, std::char_traits<char>, std::allocator<char> > format;
    }

    // BlenderDNA.h
    namespace Blender {
        class  FileDatabase;
        struct ElemBase;
    }

    // BlenderScene.h
    namespace Blender {
        struct Scene;
        struct Object;
        struct Mesh;
        struct Camera;
        struct Lamp;
        struct MTex;
        struct Image;
        struct Material;
    }

    // BlenderIntermediate.h
    namespace Blender {
        struct ConversionData;
        template <template <typename,typename> class TCLASS, typename T> struct TempArray;
    }

    // BlenderModifier.h
    namespace Blender {
        class BlenderModifierShowcase;
        class BlenderModifier;
    }

enum aiLoaderFlags
{
    aiLoaderFlags_SupportAsciiFlavour = 0x1,
    aiLoaderFlags_SupportBinaryFlavour = 0x2,
    aiLoaderFlags_SupportCompressedFlavour = 0x4,

    aiLoaderFlags_LimitedSupport = 0x8,

    aiLoaderFlags_Experimental = 0x10,
    aiLoaderFlags_Testing = 0x20,
    aiLoaderFlags_Production = 0x40,
};

struct aiLoaderDesc
{
    const char* mName;
    const char* mAuthor;
    const char* mMaintainer;
    const char* mComments;
    unsigned int mFlags;

    unsigned int mMinMajor;
    unsigned int mMinMinor;
    unsigned int mMaxMajor;
    unsigned int mMaxMinor;
};


// -------------------------------------------------------------------------------------------
/** Load blenders official binary format. The actual file structure (the `DNA` how they
 *  call it is outsourced to BlenderDNA.cpp/BlenderDNA.h. This class only performs the
 *  conversion from intermediate format to aiScene. */
// -------------------------------------------------------------------------------------------
class BlenderImporter : public BaseImporter
{
    friend class Importer;

protected:

    /** Constructor to be privately used by Importer */
    BlenderImporter();

    /** Destructor, private as well */
    ~BlenderImporter();

public:

    // --------------------
    bool CanRead( const std::string& pFile,
        IOSystem* pIOHandler,
        bool checkSig
    ) const;

protected:

    // --------------------
    const aiLoaderDesc& GetInfo () const;

    // --------------------
    void GetExtensionList(std::set<std::string>& app);

    // --------------------
    void SetupProperties(const Importer* pImp);

    // --------------------
    void InternReadFile( const std::string& pFile,
        aiScene* pScene,
        IOSystem* pIOHandler
    );

    // --------------------
    void ParseBlendFile(Blender::FileDatabase& out,
        boost::shared_ptr<IOStream> stream
    );

    // --------------------
    void ExtractScene(Blender::Scene& out,
        const Blender::FileDatabase& file
    );

    // --------------------
    void ConvertBlendFile(aiScene* out,
        const Blender::Scene& in,
        const Blender::FileDatabase& file
    );

private:

    // --------------------
    aiNode* ConvertNode(const Blender::Scene& in,
        const Blender::Object* obj,
        Blender::ConversionData& conv_info
    );

    // --------------------
    void ConvertMesh(const Blender::Scene& in,
        const Blender::Object* obj,
        const Blender::Mesh* mesh,
        Blender::ConversionData& conv_data,
        Blender::TempArray<std::vector,aiMesh>& temp
    );

    // --------------------
    aiLight* ConvertLight(const Blender::Scene& in,
        const Blender::Object* obj,
        const Blender::Lamp* mesh,
        Blender::ConversionData& conv_data
    );

    // --------------------
    aiCamera* ConvertCamera(const Blender::Scene& in,
        const Blender::Object* obj,
        const Blender::Camera* mesh,
        Blender::ConversionData& conv_data
    );

    // --------------------
    void BuildMaterials(
        Blender::ConversionData& conv_data
    ) ;

    // --------------------
    void ResolveTexture(
        MaterialHelper* out,
        const Blender::Material* mat,
        const Blender::MTex* tex,
        Blender::ConversionData& conv_data
    );

    // --------------------
    void ResolveImage(
        MaterialHelper* out,
        const Blender::Material* mat,
        const Blender::MTex* tex,
        const Blender::Image* img,
        Blender::ConversionData& conv_data
    );

    void AddSentinelTexture(
        MaterialHelper* out,
        const Blender::Material* mat,
        const Blender::MTex* tex,
        Blender::ConversionData& conv_data
    );

private: // static stuff, mostly logging and error reporting.

    // --------------------
    static void CheckActualType(const Blender::ElemBase* dt,
        const char* check
    );

    // --------------------
    static void NotSupportedObjectType(const Blender::Object* obj,
        const char* type
    );

    // -------------------------------------------------------------------
    /** Prepend 'BLEND: ' and throw msg.*/
    static void ThrowException(const std::string& msg);

    // -------------------------------------------------------------------
    /** @defgroup blog Prepend 'BLEND: ' and write @c message to log.*/
    static void LogWarn  (const Formatter::format& message); //! @ingroup blog
    static void LogError (const Formatter::format& message); //! @ingroup blog
    static void LogInfo  (const Formatter::format& message); //! @ingroup blog
    static void LogDebug (const Formatter::format& message); //! @ingroup blog

private:

    Blender::BlenderModifierShowcase* modifier_cache;

}; // !class BlenderImporter

} // end of namespace Assimp
#endif // AI_UNREALIMPORTER_H_INC