summaryrefslogtreecommitdiffstats
path: root/src/threed/surfaces/qglsubsurface.cpp
blob: 367dd621838c85771a2c0a666c021ac63e2b3b57 (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
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtQuick3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qglsubsurface.h"

QT_BEGIN_NAMESPACE

/*!
    \class QGLSubsurface
    \brief The QGLSubsurface class represents a sub-surface of another OpenGL drawing surface.
    \since 4.8
    \ingroup qt3d
    \ingroup qt3d::painting
*/

class QGLSubsurfacePrivate
{
public:
    QGLSubsurfacePrivate() : surface(0) {}
    QGLSubsurfacePrivate(QGLAbstractSurface *surf, const QRect &rgn)
        : surface(surf), region(rgn) {}

    QGLAbstractSurface *surface;
    QRect region;
};

/*!
    Constructs a new subsurface.  This constructor should be followed
    by calls to setSurface() and setRegion().
*/
QGLSubsurface::QGLSubsurface()
    : QGLAbstractSurface(QGLAbstractSurface::Subsurface)
    , d_ptr(new QGLSubsurfacePrivate)
{
}

/*!
    Constructs a new subsurface that occupies \a region within
    \a surface.  The \a region has its origin at the top-left
    of \a surface.
*/
QGLSubsurface::QGLSubsurface
        (QGLAbstractSurface *surface, const QRect &region)
    : QGLAbstractSurface(QGLAbstractSurface::Subsurface)
    , d_ptr(new QGLSubsurfacePrivate(surface, region))
{
}

/*!
    Destroys this subsurface.
*/
QGLSubsurface::~QGLSubsurface()
{
}

/*!
    Returns the surface behind this subsurface, or null if the
    surface has not been set.

    \sa setSurface(), region()
*/
QGLAbstractSurface *QGLSubsurface::surface() const
{
    Q_D(const QGLSubsurface);
    return d->surface;
}

/*!
    Sets the \a surface behind this subsurface.

    \sa surface(), setRegion()
*/
void QGLSubsurface::setSurface(QGLAbstractSurface *surface)
{
    Q_D(QGLSubsurface);
    d->surface = surface;
}

/*!
    Returns the region within surface() that is occupied by this
    subsurface, relative to the viewportRect() of surface().
    The origin is at the top-left of surface().

    \sa setRegion(), surface()
*/
QRect QGLSubsurface::region() const
{
    Q_D(const QGLSubsurface);
    return d->region;
}

/*!
    Sets the \a region within surface() that is occupied by this
    subsurface, relative to the viewportRect() of surface().
    The origin is at the top-left of surface().

    \sa region(), setSurface()
*/
void QGLSubsurface::setRegion(const QRect &region)
{
    Q_D(QGLSubsurface);
    d->region = region;
}

/*!
    \reimp
*/
QPaintDevice *QGLSubsurface::device() const
{
    Q_D(const QGLSubsurface);
    if (d->surface)
        return d->surface->device();
    else
        return 0;
}

/*!
    \reimp
*/
bool QGLSubsurface::activate(QGLAbstractSurface *prevSurface)
{
    Q_D(QGLSubsurface);
    if (d->surface)
        return d->surface->activate(prevSurface);
    else
        return false;
}

/*!
    \reimp
*/
void QGLSubsurface::deactivate(QGLAbstractSurface *nextSurface)
{
    Q_D(QGLSubsurface);
    if (d->surface)
        d->surface->deactivate(nextSurface);
}

/*!
    \reimp
*/
QRect QGLSubsurface::viewportGL() const
{
    Q_D(const QGLSubsurface);
    if (d->surface) {
        // The underlying surface's viewportGL() has its origin
        // at the bottom-left, whereas d->region has its origin
        // at the top-left.  Flip the sub-region and adjust.
        QRect rect = d->surface->viewportGL();
        return QRect(rect.x() + d->region.x(),
                     rect.y() + rect.height() -
                        (d->region.y() + d->region.height()),
                     d->region.width(), d->region.height());
    } else {
        // Don't know the actual height of the surrounding surface,
        // so the best we can do is assume the region is bottom-aligned.
        return QRect(d->region.x(), 0, d->region.width(), d->region.height());
    }
}

QT_END_NAMESPACE