QtMobility Reference Documentation

Contents

QGeoBoundingCircle Class Reference

The QGeoBoundingCircle class defines a circular geographic area. More...

 #include <QGeoBoundingCircle>

Inherits QGeoBoundingArea.

This class was introduced in Qt Mobility 1.1.

Public Functions

QGeoBoundingCircle ()
QGeoBoundingCircle ( const QGeoCoordinate & center, qreal radius )
QGeoBoundingCircle ( const QGeoBoundingCircle & other )
~QGeoBoundingCircle ()
QGeoCoordinate center () const
qreal radius () const
void setCenter ( const QGeoCoordinate & center )
void setRadius ( qreal radius )
void translate ( double degreesLatitude, double degreesLongitude )
QGeoBoundingCircle translated ( double degreesLatitude, double degreesLongitude ) const
bool operator!= ( const QGeoBoundingCircle & other ) const
QGeoBoundingCircle & operator= ( const QGeoBoundingCircle & other )
bool operator== ( const QGeoBoundingCircle & other ) const

Reimplemented Public Functions

virtual bool contains ( const QGeoCoordinate & coordinate ) const
virtual bool isEmpty () const
virtual bool isValid () const
virtual QGeoBoundingArea::AreaType type () const

Detailed Description

The QGeoBoundingCircle class defines a circular geographic area.

The circle is defined in terms of a QGeoCoordinate which specifies the center of the circle and a qreal which specifies the radius of the circle in metres.

The circle is considered invalid if the center coordinate is invalid or if the radius is less than zero.

Member Function Documentation

QGeoBoundingCircle::QGeoBoundingCircle ()

Constructs a new, invalid bounding circle.

QGeoBoundingCircle::QGeoBoundingCircle ( const QGeoCoordinate & center, qreal radius )

Constructs a new bounding circle centered at center and with a radius of radius metres.

QGeoBoundingCircle::QGeoBoundingCircle ( const QGeoBoundingCircle & other )

Constructs a new bounding circle from the contents of other.

QGeoBoundingCircle::~QGeoBoundingCircle ()

Destroys this bounding circle.

QGeoCoordinate QGeoBoundingCircle::center () const

Returns the center coordinate of this bounding circle.

See also setCenter().

bool QGeoBoundingCircle::contains ( const QGeoCoordinate & coordinate ) const [virtual]

Reimplemented from QGeoBoundingArea::contains().

Returns whether the coordinate coordinate is contained within this bounding circle.

bool QGeoBoundingCircle::isEmpty () const [virtual]

Reimplemented from QGeoBoundingArea::isEmpty().

Returns whether this bounding circle has a geometrical area of zero.

Returns true if this bounding circle is invalid.

bool QGeoBoundingCircle::isValid () const [virtual]

Reimplemented from QGeoBoundingArea::isValid().

Returns whether this bounding circle is valid.

A valid bounding circle has a valid center coordinate and a radius greater than or equal to zero.

qreal QGeoBoundingCircle::radius () const

Returns the radius in meters of this bounding circle.

See also setRadius().

void QGeoBoundingCircle::setCenter ( const QGeoCoordinate & center )

Sets the center coordinate of this bounding circle to center.

See also center().

void QGeoBoundingCircle::setRadius ( qreal radius )

Sets the radius in metres of this bounding circle to radius.

See also radius().

void QGeoBoundingCircle::translate ( double degreesLatitude, double degreesLongitude )

Translates this bounding circle by degreesLatitude northwards and degreesLongitude eastwards.

Negative values of degreesLatitude and degreesLongitude correspond to southward and westward translation respectively.

QGeoBoundingCircle QGeoBoundingCircle::translated ( double degreesLatitude, double degreesLongitude ) const

Returns a copy of this bounding circle translated by degreesLatitude northwards and degreesLongitude eastwards.

Negative values of degreesLatitude and degreesLongitude correspond to southward and westward translation respectively.

See also translate().

QGeoBoundingArea::AreaType QGeoBoundingCircle::type () const [virtual]

Reimplemented from QGeoBoundingArea::type().

Returns QGeoBoundingArea::CircleType to identify this as a QGeoBoundingCircle instance.

This function is provided to help find the specific type of aQGeoBoundingArea instance.

bool QGeoBoundingCircle::operator!= ( const QGeoBoundingCircle & other ) const

Returns whether this bounding circle is not equal to other.

QGeoBoundingCircle & QGeoBoundingCircle::operator= ( const QGeoBoundingCircle & other )

Assigns other to this bounding circle and returns a reference to this bounding circle.

bool QGeoBoundingCircle::operator== ( const QGeoBoundingCircle & other ) const

Returns whether this bounding circle is equal to other.