QGeoShape Class

The QGeoShape class defines a geographic area. More...

Header:	#include <QGeoShape>
qmake:	QT += positioning
Since:	Qt 5.2
Inherited By:	QGeoCircle, QGeoPath, QGeoPolygon, and QGeoRectangle

This class was introduced in Qt 5.2.

• List of all members, including inherited members
• Obsolete members

Public Types

enum	ShapeType { UnknownType, RectangleType, CircleType, PathType, PolygonType }

Properties

• isEmpty : const bool
• isValid : const bool
• type : const ShapeType

Public Functions

	QGeoShape(const QGeoShape &other)
	QGeoShape()
QGeoShape &	operator=(const QGeoShape &other)
	~QGeoShape()
QGeoRectangle	boundingGeoRectangle() const
QGeoCoordinate	center() const
bool	contains(const QGeoCoordinate &coordinate) const
bool	isEmpty() const
bool	isValid() const
QString	toString() const
QGeoShape::ShapeType	type() const
bool	operator!=(const QGeoShape &other) const
bool	operator==(const QGeoShape &other) const

Detailed Description

This class is the base class for classes which specify a geographic area.

For the sake of consistency, subclasses should describe the specific details of the associated areas in terms of QGeoCoordinate instances and distances in meters.

This class is a Q_GADGET since Qt 5.5. It can be directly used from C++ and QML.

Member Type Documentation

enum QGeoShape::ShapeType

Describes the type of the shape.

Constant	Value	Description
QGeoShape::UnknownType	0	A shape of unknown type
QGeoShape::RectangleType	1	A rectangular shape
QGeoShape::CircleType	2	A circular shape
QGeoShape::PathType	3	A path type
QGeoShape::PolygonType	4	A polygon type

Member Function Documentation

QGeoShape::QGeoShape(const QGeoShape &other)

Constructs a new geo shape which is a copy of other.

QGeoShape::QGeoShape()

Constructs a new invalid geo shape of UnknownType.

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

Assigns other to this geo shape and returns a reference to this geo shape.

QGeoShape::~QGeoShape()

Destroys this geo shape.

QGeoRectangle QGeoShape::boundingGeoRectangle() const

Returns a QGeoRectangle representing the geographical bounding rectangle of the geo shape, that defines the latitudinal/longitudinal bounds of the geo shape.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Qt 5.9.

QGeoCoordinate QGeoShape::center() const

Returns the coordinate located at the geometric center of the geo shape.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Qt 5.5.

bool QGeoShape::contains(const QGeoCoordinate &coordinate) const

Returns whether the coordinate coordinate is contained within this geo shape.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

bool QGeoShape::isEmpty() const

Returns whether this geo shape is empty.

An empty geo shape is a region which has a geometrical area of 0.

Note: Getter function for property isEmpty.

bool QGeoShape::isValid() const

Returns whether this geo shape is valid.

Note: Getter function for property isValid.

QString QGeoShape::toString() const

Returns a string representation of this geo shape.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Qt 5.5.

QGeoShape::ShapeType QGeoShape::type() const

Returns the type of this geo shape.

Note: Getter function for property type.

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

Returns true if the other geo shape is not equivalent to this geo shape, otherwise returns false.

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

Returns true if the other geo shape is equivalent to this geo shape, otherwise returns false.