summaryrefslogtreecommitdiffstats
path: root/src/imports/studio3d/q3dssubpresentationsettings.cpp
blob: e8ffcea5b18101829a244149e4150c9e087a556c (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
/****************************************************************************
**
** Copyright (C) 2018 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$
**
****************************************************************************/

#include "q3dssubpresentationsettings_p.h"
#include <private/q3dsinlineqmlsubpresentation_p.h>

QT_BEGIN_NAMESPACE

Q3DSSubPresentationSettings::Q3DSSubPresentationSettings(QObject *parent)
    : QObject(parent)
{
}

Q3DSSubPresentationSettings::~Q3DSSubPresentationSettings()
{
    qDeleteAll(m_list);
}

QQmlListProperty<Q3DSInlineQmlSubPresentation> Q3DSSubPresentationSettings::qmlStreams()
{
    return QQmlListProperty<Q3DSInlineQmlSubPresentation>(this, m_list);
}

/*!
    \qmltype SubPresentationSettings
    \inqmlmodule QtStudio3D
    \ingroup 3dstudioruntime2
    \brief Settings for sub-presentations.

    This type enables specifying a QML sub-presentation directly in the QML.

    A QML sub-presentation is a Qt Quick scene that is rendered to a texture
    and then used either as the contents of Qt 3D Studio layer or as a texture
    map. The contents of such a sub-presentation can be provided in two ways:
    by a separate \c{.qml} file, or directly under the Studio3D element.
    SubPresentationSettings is the enabler for the latter.

    \section2 Usage

    \qml
    Studio3D {
        id: studio3D
        Presentation {
            source: "file:///presentation.uia"
            SubPresentationSettings {
                qmlStreams: [
                    QmlStream {
                        presentationId: "sub-presentation-id"
                        Item {
                            width: 1024
                            height: 1024
                            // ... other Qt Quick items
                        }
                    }
                ]
            }
        }
    }
    \endqml
 */

/*!
    \qmlproperty list<QmlStream> SubPresentationSettings::qmlStreams

    Holds the list of QmlStream children.
 */

/*!
    \qmltype QmlStream
    \inqmlmodule QtStudio3D
    \ingroup 3dstudioruntime2
    \brief QML stream.

    This type allows attaching QML sub-presentation with a quick item. The item is rendered to a
    texture and used as a part of a Qt 3D Studio presentation.

    The sub-presentation element must be specified in the \e assets element of the presentation
    .uia file:

     \badcode
     <assets ...>
         <presentation-qml id="presentation-id" args="preview-presentation.qml" />
     </assets>
     \endcode

    The \c presentation-id attribute must contain a unique ID of the sub-presentation.
    The \c args attribute may contain an optional preview version of the item, which is only
    used in the Viewer application.
 */

/*!
    \qmlproperty string QmlStream::presentationId

    Holds the string ID of the sub-presentation the item is attached to. The id must be one of
    the \c presentation-qml IDs specified in the .uia file.
 */

/*!
    \qmlproperty Item QmlStream::item

    Holds the item attached to the sub-presentation. The item size is used as the the size of the
    texture the item is rendered to. Default values \c{(256, 256)} are used if the item doesn't
    specify a size.
 */

QT_END_NAMESPACE