summaryrefslogtreecommitdiffstats
path: root/src/location/landmarks/qlandmarkboxfilter.cpp
blob: 9bbc3a6b501131a3ac849867589672c7cb334b95 (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
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia 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.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qlandmarkboxfilter.h"
#include "qlandmarkboxfilter_p.h"
#include "qgeocoordinate.h"

QTM_BEGIN_NAMESPACE

/*!
    \class QLandmarkBoxFilter
    \brief The QLandmarkBoxFilter class is used to search for landmarks within a given bounding box.

    \inmodule QtLocation

    \ingroup landmarks-filter
    \since 1.1

    In order to be a valid filter, the region covered by the box filter must not cover one of the poles.
*/

Q_IMPLEMENT_LANDMARKFILTER_PRIVATE(QLandmarkBoxFilter);

/*!
    Creates a filter that will search for landmarks within a bounding
    box defined by the \a topLeft and \a bottomRight coordinates.
    \since 1.1
*/
QLandmarkBoxFilter::QLandmarkBoxFilter(const QGeoCoordinate &topLeft,
                                       const QGeoCoordinate &bottomRight)
        : QLandmarkFilter(new QLandmarkBoxFilterPrivate(QGeoBoundingBox(topLeft, bottomRight)))
{
}

/*!
    Creates a filter that will search for landmarks within the \a boundingBox.
    \since 1.1
*/
QLandmarkBoxFilter::QLandmarkBoxFilter(const QGeoBoundingBox &boundingBox)
        : QLandmarkFilter(new QLandmarkBoxFilterPrivate(boundingBox))
{
}

/*!
    \fn QLandmarkBoxFilter::QLandmarkBoxFilter(const QLandmarkFilter &other)
    Constructs a copy of \a other if possible, otherwise constructs a new box filter.
    \since 1.1
*/

/*!
    Destroys the filter.
*/
QLandmarkBoxFilter::~QLandmarkBoxFilter()
{
    // pointer deleted in superclass destructor
}

/*!
    Returns the filter's bounding box.
    \since 1.1
*/
QGeoBoundingBox QLandmarkBoxFilter::boundingBox() const
{
    Q_D(const QLandmarkBoxFilter);
    return d->boundingBox;
}

/*!
    Sets the \a boundingBox of the filter.
    \since 1.1
*/
void QLandmarkBoxFilter::setBoundingBox(const QGeoBoundingBox &boundingBox)
{
    Q_D(QLandmarkBoxFilter);
    d->boundingBox = boundingBox;
}

/*!
    Returns the top left coordinate of the box filter.
    \since 1.1
*/
QGeoCoordinate QLandmarkBoxFilter::topLeft()
{
    Q_D(const QLandmarkBoxFilter);
    return d->boundingBox.topLeft();
}

/*!
  Sets the \a topLeft coordinate of the box filter.
    \since 1.1
*/
void QLandmarkBoxFilter::setTopLeft(const QGeoCoordinate &topLeft)
{
    Q_D(QLandmarkBoxFilter);
    d->boundingBox.setTopLeft(topLeft);
}


/*!
    Returns the bottom right coordinate of the box filter.
    \since 1.1
*/
QGeoCoordinate QLandmarkBoxFilter::bottomRight()
{
    Q_D(const QLandmarkBoxFilter);
    return d->boundingBox.bottomRight();
}

/*!
    Sets the \a bottomRight coordinate of the box filter.
    \since 1.1
*/
void QLandmarkBoxFilter::setBottomRight(const QGeoCoordinate &bottomRight)
{
    Q_D(QLandmarkBoxFilter);
    return d->boundingBox.setBottomRight(bottomRight);
}

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

QLandmarkBoxFilterPrivate::QLandmarkBoxFilterPrivate(const QGeoBoundingBox &box)
        : QLandmarkFilterPrivate(),
        boundingBox(box)
{
    type = QLandmarkFilter::BoxFilter;
}

QLandmarkBoxFilterPrivate::QLandmarkBoxFilterPrivate(const QLandmarkBoxFilterPrivate &other)
        : QLandmarkFilterPrivate(other),
        boundingBox(other.boundingBox) {}

QLandmarkBoxFilterPrivate::~QLandmarkBoxFilterPrivate() {}

QTM_END_NAMESPACE