GeoPolygon
Since: BlackBerry 10.2.0
#include <bb/platform/geo/GeoPolygon>
To link against this class, add the following line to your .pro file: LIBS += -lbbcascadesmaps
A polygon is an arbitrary object in geographic space that is defined by a sequence of coordinates.
At a basic level, a simple polygon is defined as just an outer boundary. A more complex polygon can be created using an outer boundary with inner boundaries. All boundaries are closed-looped polylines.
Note: The associated Style edge properties only apply to the outer boundary, not the inner boundaries, of a GeoPolygon.
Note: Inner boundaries do not have any style associated with them. They represent areas where the fill of the GeoPolygon does not draw.
Overview
Inheritance
bb::platform::geo::Geographic | |||
bb::platform::geo::GeoShape | |||
bb::platform::geo::GeoPolygon |
Properties Index
Public Functions Index
GeoPolygon (QObject *parent=0) | |
GeoPolygon (const QString &id, QObject *parent=0) | |
virtual | ~GeoPolygon () |
QList< Polyline > | innerBoundaries () const |
Polyline | outerBoundary () const |
void | setInnerBoundaries (const QList< bb::platform::geo::Polyline > &newInnerBoundaries) |
bool | setOuterBoundary (const bb::platform::geo::Polyline &line) |
AltitudeMode::Type | altitudeMode () const ![]() |
virtual bb::platform::geo::BoundingBox | boundingBox () const ![]() |
QString | description () const ![]() |
Geographic (QObject *parent=0)![]() | |
Geographic (const QString &id, QObject *parent=0)![]() | |
QString | geoId () const ![]() |
QString | id () const BB_DEPRECATED![]() |
QString | name () const ![]() |
Q_SLOT void | resetAltitudeMode ()![]() |
Q_SLOT void | setAltitudeMode (bb::platform::geo::AltitudeMode::Type mode)![]() |
Q_SLOT void | setDescription (const QString &desc)![]() |
Q_SLOT void | setGeoId (const QString &id)![]() |
Q_SLOT void | setId (const QString &id) BB_DEPRECATED![]() |
Q_SLOT void | setName (const QString &name)![]() |
Q_SLOT void | setStyleFamily (const QString &styleFamily)![]() |
QString | styleFamily () const ![]() |
Protected Functions Index
Only has inherited protected functions
GeoShape (QObject *parent=0)![]() | |
GeoShape (const QString &id, QObject *parent=0)![]() | |
void | setBoundingBox (const bb::platform::geo::BoundingBox &newBox)![]() |
Signals Index
void | innerBoundariesChanged (const QList< bb::platform::geo::Polyline > &newInnerBoundaries) |
void | outerBoundaryChanged (const bb::platform::geo::Polyline &outerBoundary) |
void | altitudeModeChanged (bb::platform::geo::AltitudeMode::Type mode)![]() |
void | boundaryChanged (const bb::platform::geo::BoundingBox &box)![]() |
void | descriptionChanged (const QString &desc)![]() |
void | geoIdChanged (const QString &id)![]() |
void | idChanged (const QString &id) BB_DEPRECATED![]() |
void | nameChanged (const QString &name)![]() |
void | styleFamilyChanged (const QString &newFamily)![]() |
void | topographyChanged (const QString &id)![]() |
Properties
bb::platform::geo::AltitudeMode::Type
How the altitude property of all Coordinates within this shape should be interpreted.
The altitude measurement can be relative to the ground (default) or the sea level.
BlackBerry 10.0.0
BlackBerry 10.2.0
bb::platform::geo::BoundingBox
The axis-aligned bounding box in which this object is contained.
BlackBerry 10.0.0
QString
Use the geoId property instead.
Public Functions
Creates an instance of GeoPolygon.
Parameters | |
---|---|
parent |
The QObject parent of this object. |
BlackBerry 10.2.0
Creates an instance of GeoPolygon.
Parameters | |
---|---|
id |
The identifier for this Geographic. It is up to the caller to ensure the uniqueness of Geographic IDs. |
parent |
The QObject parent of this object. |
BlackBerry 10.2.0
virtual
Destructor.
BlackBerry 10.2.0
QList< Polyline >
Retrieves a collection of all the inner boundaries within the polygon.
A collection of boundaries (instances of Polyline) that make up the inner boundaries of this polygon.
BlackBerry 10.2.0
Polyline
Retrieves the vertices of the outer boundary.
The vertices of the outer boundary of the polygon.
BlackBerry 10.2.0
void
Sets the inner boundaries for this polygon.
Parameters | |
---|---|
newInnerBoundaries |
A collection of boundaries (instances of Polyline) that make up the inner boundaries of this polygon. |
BlackBerry 10.2.0
bool
Set polygon outer boundary.
Parameters | |
---|---|
line |
The new outer boundary for this polygon. |
true if the operation resulted in a change.
BlackBerry 10.2.0
virtualbb::platform::geo::BoundingBox 
Retrieves the axis-aligned bounding box for this Geographic.
BlackBerry 10.0.0
Constructor.
If no ID is supplied when constructing a Geographic entity, an ID that is guaranteed to be unique will be auto-generated.
Parameters | |
---|---|
parent |
The parent of this Geographic. |
BlackBerry 10.0.0
Constructor.
Parameters | |
---|---|
id |
The identifier for this Geographic. |
parent |
The parent of this Geographic. |
BlackBerry 10.0.0
QString 
Gets the unique identifier for this Geographic.
If two Geographics are attribute-wise equal, they still need to have different IDs. The ID needs to be unique within a process.
BlackBerry 10.2.0
Q_SLOT void 
Resets the altitude mode to the default value of AltitudeMode::RelativeToGround.
BlackBerry 10.2.0
Q_SLOT void 
Sets the altitude mode for the map's view.
Parameters | |
---|---|
mode |
The new altitude mode. The altitude measurement can be relative to the ground (default) or the sea level. |
BlackBerry 10.2.0
Q_SLOT void 
Use setGeoId() instead.
Q_SLOT void 
Sets the style family for this Geographic.
Parameters | |
---|---|
styleFamily |
The new style family for this element. |
BlackBerry 10.2.0
Protected Functions
(Only has inherited protected functions)
Constructor.
Parameters | |
---|---|
id |
The identifier for this Geographic. It is up to the caller to ensure the uniqueness of Geographic IDs. |
parent |
The parent of this Geographic. |
BlackBerry 10.2.0
void 
Signals
void
Emitted when the polygon's collection of inner boundaries have changed.
Parameters | |
---|---|
newInnerBoundaries |
The collection of new inner boundaries. |
BlackBerry 10.2.0
void
Emitted when the polygon's outer boundary has changed.
BlackBerry 10.2.0
void 
Emitted when the view's altitude mode has changed.
Parameters | |
---|---|
mode |
The new altitude mode for this shape. |
BlackBerry 10.2.0
void 
Emitted by derived classes when the bounding box has changed.
See the BoundingBox documentation.
BlackBerry 10.0.0
void 
Use geoIdChanged() instead.
void 
Emitted when the style family attribute changes.
BlackBerry 10.2.0
void 
Emitted when the topography of this Geographic changes.
Parameters | |
---|---|
id |
The ID of this Geographic. |
BlackBerry 10.1.0