MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QGeoMapCircleObject Class Reference

The QGeoMapCircleObject class is a QGeoMapObject used to draw the region within a given distance of a coordinate. More...

 #include <QGeoMapCircleObject>

Inherits: QGeoMapObject.

This class was introduced in Qt Mobility 1.1.

Properties

Public Functions

QGeoMapCircleObject ()
QGeoMapCircleObject ( const QGeoBoundingCircle & circle )
QGeoMapCircleObject ( const QGeoCoordinate & center, qreal radius )
~QGeoMapCircleObject ()
QBrush brush () const
QGeoCoordinate center () const
QGeoBoundingCircle circle () const
QPen pen () const
quint32 pointCount () const
qreal radius () const
void setBrush ( const QBrush & brush )
void setCenter ( const QGeoCoordinate & center )
void setCircle ( const QGeoBoundingCircle & circle )
void setPen ( const QPen & pen )
void setPointCount ( quint32 pointCount )
void setRadius ( qreal radius )

Reimplemented Public Functions

virtual bool contains ( const QGeoCoordinate & coordinate ) const
virtual QGeoMapObject::Type type () const

Signals

void brushChanged ( const QBrush & brush )
void centerChanged ( const QGeoCoordinate & center )
void penChanged ( const QPen & pen )
void radiusChanged ( qreal radius )

Additional Inherited Members

  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 4 static public members inherited from QObject
  • 3 protected functions inherited from QGeoMapObject
  • 7 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QGeoMapCircleObject class is a QGeoMapObject used to draw the region within a given distance of a coordinate.

The circle is specified by either a valid QGeoBoundingCircle instance or a valid QGeoCoordinate instance and a qreal with value greater than 0.0, which represent the center of the circle and the radius of the circle in metres respectively.

The circle may appear as an ellipse on maps which use the Mercator projection. This is done so that the circle accurately covers all points at a distance of the radius or less from the center.

Property Documentation

brush : QBrush

This property holds the brush that will be used to draw this object.

The brush is used to fill in circle.

The outline around the perimeter of the circle is drawn using the QGeoMapCircleObject::pen property.

This property was introduced in Qt Mobility 1.1.

Access functions:

QBrush brush () const
void setBrush ( const QBrush & brush )

Notifier signal:

void brushChanged ( const QBrush & brush )

center : QGeoCoordinate

This property holds the coordinate of the center of the circle to be drawn by this circle object.

The default value of this property is an invalid coordinate. While the value of this property is invalid the circle object will not be displayed.

This property was introduced in Qt Mobility 1.1.

Access functions:

QGeoCoordinate center () const
void setCenter ( const QGeoCoordinate & center )

Notifier signal:

void centerChanged ( const QGeoCoordinate & center )

pen : QPen

This property holds the pen that will be used to draw this object.

The pen is used to draw an outline around the circle. The circle is filled using the QGeoMapCircleObject::brush property.

The pen will be treated as a cosmetic pen, which means that the width of the pen will be independent of the zoom level of the map.

This property was introduced in Qt Mobility 1.1.

Access functions:

QPen pen () const
void setPen ( const QPen & pen )

Notifier signal:

void penChanged ( const QPen & pen )

pointCount : quint32

This property holds the number of vertices used in an approximate polygon.

For a circle using ExactTransform, this property describes the number of sides that should be used to generate a polygonal approximation which is then transformed vertex-by-vertex into screen coordinates.

This property was introduced in Qt Mobility 1.2.

Access functions:

quint32 pointCount () const
void setPointCount ( quint32 pointCount )

radius : qreal

This property holds the radius in metres of the circle that will be drawn by this circle object.

The default value of this property is -1.0. While the value of this property is not greater than 0 the circle object will not be displayed.

This property was introduced in Qt Mobility 1.1.

Access functions:

qreal radius () const
void setRadius ( qreal radius )

Notifier signal:

void radiusChanged ( qreal radius )

Member Function Documentation

QGeoMapCircleObject::QGeoMapCircleObject ()

Constructs a new circle object.

QGeoMapCircleObject::QGeoMapCircleObject ( const QGeoBoundingCircle & circle )

Constructs a new circle object based on the circle circle.

This function was introduced in Qt Mobility 1.1.

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

Constructs a new circle object with a center at coordinate center and a radius in meters of radius.

This function was introduced in Qt Mobility 1.1.

QGeoMapCircleObject::~QGeoMapCircleObject ()

Destroys this circle object.

void QGeoMapCircleObject::brushChanged ( const QBrush & brush ) [signal]

This signal is emitted when the brush used to fill the inside of the circle object has changed.

The new value is brush.

This function was introduced in Qt Mobility 1.1.

void QGeoMapCircleObject::centerChanged ( const QGeoCoordinate & center ) [signal]

This signal is emitted when the center of the circle object has changed.

The new value is center.

This function was introduced in Qt Mobility 1.1.

QGeoBoundingCircle QGeoMapCircleObject::circle () const

Returns a QGeoBoundingCircle instance which corresponds to the circle that will be drawn by this object.

This is equivalent to

 QGeoMapCircleObject *object;
 // setup object
 QGeoBoundingCircle(object->center(), object->radius());

This function was introduced in Qt Mobility 1.1.

See also setCircle().

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

Reimplemented from QGeoMapObject::contains().

This function was introduced in Qt Mobility 1.2.

void QGeoMapCircleObject::penChanged ( const QPen & pen ) [signal]

This signal is emitted when the pen used to draw the edge of the circle object has changed.

The new value is pen.

This function was introduced in Qt Mobility 1.1.

void QGeoMapCircleObject::radiusChanged ( qreal radius ) [signal]

This signal is emitted when the radius of the circle object has changed.

The new value is radius.

This function was introduced in Qt Mobility 1.1.

void QGeoMapCircleObject::setCircle ( const QGeoBoundingCircle & circle )

Sets the circle that will be drawn by this object to circle.

This is equivalent to

 QGeoMapCircleObject *object;
 // setup object
 object->setCenter(circle.center());
 object->setRadius(circle.radius());

This function was introduced in Qt Mobility 1.1.

See also circle().

QGeoMapObject::Type QGeoMapCircleObject::type () const [virtual]

Reimplemented from QGeoMapObject::type().

This function was introduced in Qt Mobility 1.1.

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.