summaryrefslogtreecommitdiffstats
path: root/src/runtime/api/q3dsviewersettings.cpp
blob: c6c65fdfd24a6ab3b3fee50e8c6889452ec6f1ec (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
/****************************************************************************
**
** 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 "q3dsviewersettings_p.h"
#include <QDebug>

QT_BEGIN_NAMESPACE

/*!
    \class Q3DSViewerSettings
    \inmodule 3dstudioruntime2
    \since Qt 3D Studio 2.0

    \brief Qt 3D Studio presentation viewer settings.

    Q3DSViewerSettings provides properties to define presentation independent
    viewer settings.

    \note As of Qt 3D Studio 2.0 this class is provided mainly for
    compatibility reasons. Most functions are not applicable or are not
    currently supported and will be silently ignored.

    \note This class should not be instantiated directly when working with the
    C++ APIs. Q3DSSurfaceViewer and Q3DSWidget create a Q3DSViewerSettings
    instance implicitly. This can be queried via Q3DSSurfaceViewer::settings()
    or Q3DSWidget::settings().
 */

Q3DSViewerSettings::Q3DSViewerSettings(QObject *parent)
    : QObject(*new Q3DSViewerSettingsPrivate, parent)
{
}

Q3DSViewerSettings::Q3DSViewerSettings(Q3DSViewerSettingsPrivate &dd, QObject *parent)
    : QObject(dd, parent)
{
}

Q3DSViewerSettings::~Q3DSViewerSettings()
{
}

/*!
    \enum Q3DSViewerSettings::ShadeMode

    This enumeration specifies the possible shading modes.

    \value ShadeModeShaded The objects in the presentation are shaded normally.
    \value ShadeModeShadedWireframe The objects in the presentation are shaded
    with a super-imposed wireframe on top of the normal shading. Only objects that specify
    a tesselation mode will display this wireframe.
*/

/*!
    \enum Q3DSViewerSettings::ScaleMode

    This enumeration specifies the possible scaling modes.

    \value ScaleModeFit Scales the presentation to fit the viewer.
    \value ScaleModeFill Scales the presentation to fill the viewer.
    \value ScaleModeCenter Centers the presentation into the viewer without scaling it.
*/

/*!
    \property Q3DSViewerSettings::matteColor

    \note This property is currently ignored.
 */
QColor Q3DSViewerSettings::matteColor() const
{
    Q_D(const Q3DSViewerSettings);
    return d->matteColor;
}

/*!
    \property Q3DSViewerSettings::showRenderStats

    When this property is \c{true}, the interactive statistics and profile
    view is displayed in-scene, on top of the 3D content.

    \note This feature can be disabled at build time, in which case this
    property has no effect.

    Default value is \c{false}.
*/
bool Q3DSViewerSettings::isShowingRenderStats() const
{
    Q_D(const Q3DSViewerSettings);
    return d->showRenderStats;
}

/*!
    \property Q3DSViewerSettings::shadeMode

    \note This property is currently ignored.
 */
Q3DSViewerSettings::ShadeMode Q3DSViewerSettings::shadeMode() const
{
    Q_D(const Q3DSViewerSettings);
    return d->shadeMode;
}

/*!
    \property Q3DSViewerSettings::scaleMode

    \note This property is currently ignored.
 */
Q3DSViewerSettings::ScaleMode Q3DSViewerSettings::scaleMode() const
{
    Q_D(const Q3DSViewerSettings);
    return d->scaleMode;
}

void Q3DSViewerSettings::setMatteColor(const QColor &color)
{
    Q_D(Q3DSViewerSettings);
    if (d->matteColor != color) {
        qWarning() << Q_FUNC_INFO << "not implemented";
        d->matteColor = color;
        emit matteColorChanged();
    }
}

void Q3DSViewerSettings::setShowRenderStats(bool show)
{
    Q_D(Q3DSViewerSettings);
    if (d->showRenderStats != show) {
        d->showRenderStats = show;
        emit showRenderStatsChanged();
    }
}

void Q3DSViewerSettings::setShadeMode(Q3DSViewerSettings::ShadeMode mode)
{
    Q_D(Q3DSViewerSettings);
    if (d->shadeMode != mode) {
        qWarning() << Q_FUNC_INFO << "not implemented";
        d->shadeMode = mode;
        emit shadeModeChanged();
    }
}

void Q3DSViewerSettings::setScaleMode(Q3DSViewerSettings::ScaleMode mode)
{
    Q_D(Q3DSViewerSettings);
    if (d->scaleMode != mode) {
        qWarning() << Q_FUNC_INFO << "not implemented";
        d->scaleMode = mode;
        emit scaleModeChanged();
    }
}

/*!
    Persistently saves the viewer \l{QSettings}{settings} using \a group, \a organization and
    \a application.

    \note This function is not currently implemented.
 */
void Q3DSViewerSettings::save(const QString &group,
                              const QString &organization,
                              const QString &application)
{
    Q_UNUSED(group);
    Q_UNUSED(organization);
    Q_UNUSED(application);
    qWarning() << Q_FUNC_INFO << "not implemented";
}

/*!
    Loads previously saved viewer \l{QSettings}{settings} using \a group, \a organization and
    \a application.

    \note This function is not currently implemented.
 */
void Q3DSViewerSettings::load(const QString &group,
                              const QString &organization,
                              const QString &application)
{
    Q_UNUSED(group);
    Q_UNUSED(organization);
    Q_UNUSED(application);
    qWarning() << Q_FUNC_INFO << "not implemented";
}

/*!
    \qmltype ViewerSettings
    \instantiates Q3DSViewerSettings
    \inqmlmodule QtStudio3D
    \ingroup 3dstudioruntime2
    \brief Qt 3D Studio presentation viewer settings.

    This type provides properties to define presentation independent viewer settings.

    \sa Studio3D
*/

/*!
    \qmlproperty bool ViewerSettings::showRenderStats

    If this property is set to \c true, the interactive statistics and profile
    view is displayed in-scene, on top of the 3D content.

    \note this feature can be disabled at build time, in which case this
    property has no effect.

    The default value is \c{false}.
*/

QT_END_NAMESPACE