diff options
Diffstat (limited to 'src/location/landmarks/qlandmarkproximityfilter.cpp')
| -rw-r--r-- | src/location/landmarks/qlandmarkproximityfilter.cpp | 171 |
1 files changed, 171 insertions, 0 deletions
diff --git a/src/location/landmarks/qlandmarkproximityfilter.cpp b/src/location/landmarks/qlandmarkproximityfilter.cpp new file mode 100644 index 00000000..cfe32e29 --- /dev/null +++ b/src/location/landmarks/qlandmarkproximityfilter.cpp @@ -0,0 +1,171 @@ +/**************************************************************************** +** +** Copyright (C) 2009 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 "qlandmarkproximityfilter.h" +#include "qlandmarkproximityfilter_p.h" +#include "qgeocoordinate.h" + +QTM_BEGIN_NAMESPACE + +/*! + \class QLandmarkProximityFilter + \brief The QLandmarkProximityFilter class is used to search for landmarks based on the radius + around a given coordinate and perform sorting by distance. + + \inmodule QtLocation + + \ingroup landmarks-filter + \since 1.1 + + In order to be a valid filter, the region covered by the proximity filter must not cover one of the poles. + The landmarks are returned in ascending order of distance. A proximity filter may + be used inside an intersection filter to sort landmarks by distance in combination with other + criteria such as categories. (Note that a using sort order other than QLandmarkSortOrder (i.e. no sort) + will override the sorting by distance). + +*/ + +Q_IMPLEMENT_LANDMARKFILTER_PRIVATE(QLandmarkProximityFilter) + +/*! + Creates a filter that will select landmarks within a given \a radius around + a \a center coordinate. +*/ +QLandmarkProximityFilter::QLandmarkProximityFilter(const QGeoCoordinate ¢er, qreal radius) + : QLandmarkFilter(new QLandmarkProximityFilterPrivate(QGeoBoundingCircle(center, radius))) +{ +} + +/*! + Creates a filter that will select landmarks withiin a given bounding \a circle. + */ +QLandmarkProximityFilter::QLandmarkProximityFilter(const QGeoBoundingCircle &circle) + : QLandmarkFilter(new QLandmarkProximityFilterPrivate(circle)) +{ +} + +/*! + \fn QLandmarkProximityFilter::QLandmarkProximityFilter(const QLandmarkFilter &other) + Constructs a copy of \a other if possible, otherwise constructs a new proximity filter. +*/ + +/*! + Destroys the filter. +*/ +QLandmarkProximityFilter::~QLandmarkProximityFilter() +{ + // pointer deleted in superclass destructor +} + +/*! + Returns the center coordinate of the filter. +*/ +QGeoCoordinate QLandmarkProximityFilter::center() const +{ + Q_D(const QLandmarkProximityFilter); + return d->circle.center(); +} + +/*! + Sets the \a center coordinate of the filter. +*/ +void QLandmarkProximityFilter::setCenter(const QGeoCoordinate ¢er) +{ + Q_D(QLandmarkProximityFilter); + d->circle.setCenter(center); +} + +/*! + Returns the radius of the filter. The unit of the radius is meters. +*/ +qreal QLandmarkProximityFilter::radius() const +{ + Q_D(const QLandmarkProximityFilter); + return d->circle.radius(); +} + +/*! + Sets the \a radius of the filter. The unit of the radius is meters. +*/ +void QLandmarkProximityFilter::setRadius(qreal radius) +{ + Q_D(QLandmarkProximityFilter); + d->circle.setRadius(radius); +} + +/*! + Sets the bounding circle for the proximity filter. +*/ +QGeoBoundingCircle QLandmarkProximityFilter::boundingCircle() +{ + Q_D(const QLandmarkProximityFilter); + return d->circle; +} + +/*! + Sets the bounding \a circle for the proximity filter +*/ +void QLandmarkProximityFilter::setBoundingCircle(const QGeoBoundingCircle &circle) +{ + Q_D(QLandmarkProximityFilter); + d->circle = circle; +} + +/******************************************************************************* +*******************************************************************************/ + +QLandmarkProximityFilterPrivate::QLandmarkProximityFilterPrivate(const QGeoBoundingCircle &circle) + : QLandmarkFilterPrivate(), + circle(circle) +{ + type = QLandmarkFilter::ProximityFilter; +} + +QLandmarkProximityFilterPrivate::QLandmarkProximityFilterPrivate(const QLandmarkProximityFilterPrivate &other) + : QLandmarkFilterPrivate(other) +{ + circle.setCenter(other.circle.center()); + circle.setRadius(other.circle.radius()); +} + +QLandmarkProximityFilterPrivate::~QLandmarkProximityFilterPrivate() {} + +QTM_END_NAMESPACE |