summaryrefslogtreecommitdiffstats
path: root/src/location/maps/qgeomapobjectinfo.cpp
blob: 190082037227f31cc5cf2437240c80a9885007d1 (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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qgeomapobjectinfo.h"
#include "qgeomapobjectinfo_p.h"

#include "qgeomapdata.h"
#include "qgeomapdata_p.h"
#include "qgeomapobject.h"
#include "qgeomapobject_p.h"
#include "qgeoboundingbox.h"

QTM_BEGIN_NAMESPACE

/*!
    \class QGeoMapObjectInfo
    \brief The QGeoMapObjectInfo class is the base class used to define the
    parts of QGeoMapObject and its subclasses that are specific to a
    particular QGeoMapData subclass.

    \inmodule QtLocation

    \ingroup maps-impl

    Most of the mapping functionality is provided by a QGeoMapData subclass,
    including the rendering of the map itself.

    This means that QGeoMapData subclasses need to be able to render each of
    the QGeoMapObject instances and instances of the QGeoMapObject subclasses.

    Furthermore, the need to be able to create and manipulate map objects
    independently from the QGeoMapData instance precludes the use of a set of
    factory methods for creating QGeoMapData specific map objects.

    The QGeoMapObjectInfo class is used to provide the QGeoMapData subclass
    specific behaviours for the map objects in a way which fulfils this need,
    as the QGeoMapObjectInfo instances are only created at the point when a
    map object becomes associated with a QGeoMapData subclass - which is most
    commonly when the object is added to a QGraphicsGeoMap.
*/

/*!
    Constructs a new object info instance which will provide the behaviours of
    \a mapObject which are specific to \a mapData.
*/
QGeoMapObjectInfo::QGeoMapObjectInfo(QGeoMapData *mapData, QGeoMapObject *mapObject)
    : QObject(mapObject),
      d_ptr(new QGeoMapObjectInfoPrivate(mapData, mapObject)) {}

/*!
    Destroys this info object.
*/
QGeoMapObjectInfo::~QGeoMapObjectInfo()
{
    delete d_ptr;
}

/*!
    This function is run after the constructor.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::init() {}

/*!
    This function is called when the window size of the map changes to 
    \a windowSize.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::windowSizeChanged(const QSizeF &windowSize)
{
    Q_UNUSED(windowSize)
}

/*!
    This function is called when the zoom level of the map changes to 
    \a zoomLevel.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::zoomLevelChanged(qreal zoomLevel)
{
    Q_UNUSED(zoomLevel)
}

/*!
    This function is called when the center of the map changes to 
    \a coordinate.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::centerChanged(const QGeoCoordinate &coordinate)
{
    Q_UNUSED(coordinate)
}

/*!
    This function is run when the z value of the object changes to \a zValue.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::zValueChanged(int zValue)
{
    Q_UNUSED(zValue)
}

/*!
    This function is run when the visible state of the object changes to 
    \a visible.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::visibleChanged(bool visible)
{
    Q_UNUSED(visible)
}

/*!
    This function is run when the selected state of the object changes to 
    \a selected.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::selectedChanged(bool selected)
{
    Q_UNUSED(selected)
}

/*!
    This function is run when the origin of the object changes to
    \a origin.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::originChanged(const QGeoCoordinate &origin)
{
    Q_UNUSED(origin);
}

/*!
    This function is run when the coordinate units of the object changes to
    \a units.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::unitsChanged(QGeoMapObject::CoordinateUnit units)
{
    Q_UNUSED(units);
}

/*!
    This function is run when the transform type of the object changes to
    \a transformType.

    The default implementation does nothing.
*/
void QGeoMapObjectInfo::transformTypeChanged(QGeoMapObject::TransformType transformType)
{
    Q_UNUSED(transformType);
}

/*!
    Returns a bounding box which contains this map object.

    The default implementation returns an invalid bounding box.
*/
QGeoBoundingBox QGeoMapObjectInfo::boundingBox() const
{
    return QGeoBoundingBox();
}

/*!
    Returns whether \a coordinate is contained with the boundary of this
    map object.

    The default implementation returns false.
*/
bool QGeoMapObjectInfo::contains(const QGeoCoordinate &coordinate) const
{
    Q_UNUSED(coordinate)
    return false;
}

/*!
    Returns the QGeoMapData instance associated with this info object.
*/
QGeoMapData* QGeoMapObjectInfo::mapData()
{
    return d_ptr->mapData;
}

// Need to keep this for BC, otherwise would probably replace with const
// version
/*!
    Returns the QGeoMapObject instance associated with this info object.
*/
QGeoMapObject* QGeoMapObjectInfo::mapObject()
{
    return d_ptr->mapObject;
}

/*!
    Returns the QGeoMapObject instance associated with this info object.
*/
QGeoMapObject* QGeoMapObjectInfo::mapObject() const
{
    return d_ptr->mapObject;
}

/*******************************************************************************
*******************************************************************************/

QGeoMapObjectInfoPrivate::QGeoMapObjectInfoPrivate(QGeoMapData *mapData, QGeoMapObject *mapObject)
    : mapData(mapData),
      mapObject(mapObject) {}

QGeoMapObjectInfoPrivate::~QGeoMapObjectInfoPrivate() {}

/*******************************************************************************
*******************************************************************************/

#include "moc_qgeomapobjectinfo.cpp"

QTM_END_NAMESPACE