summaryrefslogtreecommitdiffstats
path: root/src/api/studio3dqml/q3dspresentationitem.cpp
blob: 6372f2fa2e80db901c0569697a5b8283fdac02cf (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
/****************************************************************************
**
** 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$
**
****************************************************************************/

#include "q3dspresentationitem_p.h"

#include <QtStudio3D/q3dssceneelement.h>
#include <QtStudio3D/q3dsdatainput.h>
#include <QtStudio3D/private/q3dspresentation_p.h>
#include <QtStudio3D/private/viewerqmlstreamproxy_p.h>
#include <QtCore/qdebug.h>

QT_BEGIN_NAMESPACE

/*!
    \qmltype Presentation
    \instantiates Q3DSPresentationItem
    \inqmlmodule QtStudio3D
    \ingroup OpenGLRuntime
    \inherits Q3DSPresentation
    \keyword Studio3D

    \brief Represents a Qt 3D Studio presentation.

    This item provides properties and methods for controlling a
    presentation.

    Qt 3D Studio supports multiple presentations in one project. There
    is always a main presentation and zero or more
    sub-presentations. The sub-presentations are composed into the
    main presentations either as contents of Qt 3D Studio layers or as
    texture maps.

    In the filesystem each presentation corresponds to one \c{.uip}
    presentation file. When present, the \c{.uia} project file ties
    these together by specifying a name for each of the
    (sub-)presentations and specifies which one is the main one.

    The \c{.uia} project also defines \l{DataInput}s and
    \l{DataOutput}s that are exported by the presentations.
    \l{DataInput}s provide a way to provide input to the presentation
    to e.g. control a timeline of a subpresentation from code.
    \l{DataOutput}s provide a way to get notified when an attribute
    is changed in the presentation by animation timeline,
    by behavior scripts or by a \l{DataInput}.

    The Presentation type handles child objects of the types \l Element, \l
    SceneElement, \l DataInput, and \l SubPresentationSettings specially. These
    will get automatically associated with the presentation and can control
    certain aspects of it from that point on.

    From the API point of view Presentation corresponds to the
    main presentation. The source property can refer either to a
    \c{.uia} or \c{.uip} file. When specifying a file with \c{.uip}
    extension and a \c{.uia} is present with the same name, the
    \c{.uia} is loaded automatically and thus sub-presentation
    information is available regardless.
 */
Q3DSPresentationItem::Q3DSPresentationItem(QObject *parent)
    : Q3DSPresentation(parent)
    , m_subPresentationSettings(nullptr)
{
}

Q3DSPresentationItem::~Q3DSPresentationItem()
{
}

/*!
    Returns the \l SubPresentationSettings associated with this presentation.
*/
Q3DSSubPresentationSettings *Q3DSPresentationItem::subPresentationSettings() const
{
    return m_subPresentationSettings;
}

QQmlListProperty<QObject> Q3DSPresentationItem::qmlChildren()
{
    return QQmlListProperty<QObject>(this, nullptr, &appendQmlChildren, nullptr, nullptr, nullptr);
}

void Q3DSPresentationItem::appendQmlChildren(QQmlListProperty<QObject> *list, QObject *obj)
{
    auto item = qobject_cast<Q3DSPresentationItem *>(list->object);
    if (item) {
        auto scene = qobject_cast<Q3DSSceneElement *>(obj);
        if (scene) {
            if (item->registeredElement(scene->elementPath()))
                qWarning() << __FUNCTION__ << "A duplicate SceneElement defined for Presentation.";
            else
                item->registerElement(scene);
        } else {
            auto studioElement = qobject_cast<Q3DSElement *>(obj);
            if (studioElement) {
                if (item->registeredElement(studioElement->elementPath()))
                    qWarning() << __FUNCTION__ << "A duplicate Element defined for Presentation.";
                else
                    item->registerElement(studioElement);
            } else {
                auto subPresSettings = qobject_cast<Q3DSSubPresentationSettings *>(obj);
                if (subPresSettings) {
                    if (item->m_subPresentationSettings) {
                        qWarning() << __FUNCTION__
                                   << "Duplicate SubPresentationSettings defined for Presentation.";
                    } else {
                        item->m_subPresentationSettings = subPresSettings;
                        item->d_ptr->streamProxy()->setSettings(subPresSettings);
                    }
                } else {
                    auto dataInput = qobject_cast<Q3DSDataInput *>(obj);
                    if (dataInput) {
                        if (item->registeredDataInput(dataInput->name())) {
                            qWarning() << __FUNCTION__
                                       << "Duplicate DataInput defined for Presentation.";
                        } else {
                            item->registerDataInput(dataInput);
                        }
                    } else {
                        auto dataOutput = qobject_cast<Q3DSDataOutput *>(obj);
                        if (dataOutput) {
                            if (item->registeredDataOutput(dataOutput->name())) {
                                qWarning() << __FUNCTION__
                                           << "Duplicate DataOutput defined for Presentation.";
                            } else {
                                item->registerDataOutput(dataOutput);
                            }
                        }
                    }
                }
            }
        }
    }
}

QT_END_NAMESPACE