summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/Qt3DSRuntimeRender/Include/Qt3DSRenderUIPLoader.h
blob: 2b70c687b027877e691d8b6dab1b0a622ac571d6 (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
/****************************************************************************
**
** Copyright (C) 2008-2012 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#pragma once
#ifndef QT3DS_RENDER_UIP_LOADER_H
#define QT3DS_RENDER_UIP_LOADER_H

#ifdef QT3DS_RENDER_ENABLE_LOAD_UIP

#include "Qt3DSRender.h"
#include "foundation/StringTable.h"
#include <EASTL/utility.h>
#include "foundation/Qt3DSContainers.h"
#include "Qt3DSRenderGraphObject.h"
#include <QtCore/qstring.h>

namespace Q3DStudio {
class IRuntimeMetaData;
}

namespace qt3dsdm {
class IDOMReader;
struct SMetaDataEffect;
struct SMetaDataCustomMaterial;
}

namespace qt3ds {
class Q3DSVariantConfig;

namespace render {

    class IBufferManager;

    typedef nvhash_map<CRegisteredString, SGraphObject *> TIdObjectMap;

    struct IUIPReferenceResolver
    {
    protected:
        virtual ~IUIPReferenceResolver() {}
    public:
        virtual CRegisteredString ResolveReference(CRegisteredString inStart,
                                                   const char *inReference) = 0;
    };

    struct SPresentation;

    class QT3DS_AUTOTEST_EXPORT IUIPLoader
    {
    public:
        // The reader needs to point to the top of the file, we will search
        // several objects that exist at the top level of the uip file.
        // Returns NULL if we were incapable of loading the presentation.
        static SPresentation *
        LoadUIPFile(qt3dsdm::IDOMReader &inReader
                    // the full path, including the filename
                    // to the presentation file
                    ,
                    const char8_t *inFullPathToPresentationFile,
                    Q3DStudio::IRuntimeMetaData &inMetaData, IStringTable &inStrTable,
                    NVFoundationBase &inFoundation
                    // Allocator used for the presentation objects themselves
                    // this allows clients to pre-allocate a block of memory just for
                    // the scene graph
                    ,
                    NVAllocatorCallback &inPresentationAllocator
                    // Map of string ids to objects
                    ,
                    TIdObjectMap &ioObjectMap
                    // Buffer manager to load details about the images
                    ,
                    IBufferManager &inBufferManager
                    // To load effects we need the effect system
                    // and the presentation directory
                    ,
                    IEffectSystem &inEffectSystem, const char8_t *inPresentationDir,
                    IRenderPluginManager &inPluginManager, ICustomMaterialSystem &inMaterialSystem,
                    IDynamicObjectSystem &inDynamicSystem, qt3ds::render::IPathManager &inPathManager
                    // Resolve references to objects; this is done by the main uip loader during
                    // its normal mode of operation so we try to reuse that code.
                    ,
                    IUIPReferenceResolver *inResolver
                    // Variant config defines variant groups and tags to be used to filter out
                    // unneeded parts of the presentation
                    ,
                    const Q3DSVariantConfig &variantConfig
                    // Set some initial values by going to the master slide then slide 1
                    // Useful for quick testing, sort of equivalent to showing the first frame
                    // of a given presentation
                    ,
                    bool setValuesFromSlides = false);

        static void CreateEffectClassFromMetaEffect(CRegisteredString inEffectName,
                                                    NVFoundationBase &inFoundation,
                                                    IEffectSystem &inEffectSystem,
                                                    const qt3dsdm::SMetaDataEffect &inMetaDataEffect,
                                                    IStringTable &inStrTable);

        static void CreateMaterialClassFromMetaMaterial(
            CRegisteredString inEffectName, NVFoundationBase &inFoundation,
            ICustomMaterialSystem &inEffectSystem,
            const qt3dsdm::SMetaDataCustomMaterial &inMetaDataMaterial, IStringTable &inStrTable);
    };
}
}

#endif
#endif