GeoPolygon

#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.

Inheritance

bb::platform::geo::Geographic
	bb::platform::geo::GeoShape
		bb::platform::geo::GeoPolygon

Properties Index

QList< bb::platform::geo::Polyline >	innerBoundaries
bb::platform::geo::Polyline	outerBoundary
bb::platform::geo::AltitudeMode::Type	altitudeMode
bb::platform::geo::BoundingBox	boundingBox [read-only]
QString	description
QString	geoId
QString	id
QString	name
QString	styleFamily

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

QList< bb::platform::geo::Polyline > innerBoundaries

The inner edges of the polygon.

Since:

BlackBerry 10.2.0

bb::platform::geo::Polyline outerBoundary

The outer edge of the polygon.

Since:

BlackBerry 10.2.0

bb::platform::geo::AltitudeMode::Type altitudeMode

How the altitude property of all Coordinates within this shape should be interpreted.

Default value is AltitudeMode::RelativeToGround.

The altitude measurement can be relative to the ground (default) or the sea level.

bb::platform::geo::BoundingBox boundingBox[read-only]

The axis-aligned bounding box in which this object is contained.

Since:

BlackBerry 10.0.0

QString description

The description of this object.

Since:

BlackBerry 10.0.0

QString geoId

The ID of this Geographic object.

Since:

BlackBerry 10.2.0

QString id

Deprecated

Use the geoId property instead.

QString name

The name of this object.

Since:

BlackBerry 10.0.0

QString styleFamily

The style family to be used in conjunction with this element.

Since:

BlackBerry 10.2.0

Public Functions

GeoPolygon (
QObject *parent)

Creates an instance of GeoPolygon.

Parameters
parent	The QObject parent of this object.

Since:

BlackBerry 10.2.0

GeoPolygon (
const QString &id,
QObject *parent )

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.

Since:

BlackBerry 10.2.0

virtual~GeoPolygon ()

Destructor.

Since:

BlackBerry 10.2.0

QList< Polyline > innerBoundaries ()

Retrieves a collection of all the inner boundaries within the polygon.

Return:

A collection of boundaries (instances of Polyline) that make up the inner boundaries of this polygon.

Since:

BlackBerry 10.2.0

Polyline outerBoundary ()

Retrieves the vertices of the outer boundary.

Return:

The vertices of the outer boundary of the polygon.

Since:

BlackBerry 10.2.0

void setInnerBoundaries (
const QList< bb::platform::geo::Polyline > &newInnerBoundaries)

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.

Since:

BlackBerry 10.2.0

bool setOuterBoundary (
const bb::platform::geo::Polyline &line)

Set polygon outer boundary.

Parameters
line	The new outer boundary for this polygon.

Return:

true if the operation resulted in a change.

Since:

BlackBerry 10.2.0

AltitudeMode::Type altitudeMode ()

Retrieves the altitude mode.

Since:

BlackBerry 10.2.0

virtualbb::platform::geo::BoundingBox boundingBox ()

Retrieves the axis-aligned bounding box for this Geographic.

Since:

BlackBerry 10.0.0

QString description ()

Gets the description of this Geographic.

Since:

BlackBerry 10.0.0

Geographic (
QObject *parent)

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.

Since:

BlackBerry 10.0.0

Geographic (
const QString &id,
QObject *parent )

Constructor.

Parameters
id	The identifier for this Geographic.
parent	The parent of this Geographic.

Since:

BlackBerry 10.0.0

QString geoId ()

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.

Since:

BlackBerry 10.2.0

QString id ()

Deprecated

Use geoId() instead.

QString name ()

Gets the name of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void resetAltitudeMode ()

Resets the altitude mode to the default value of AltitudeMode::RelativeToGround.

Since:

BlackBerry 10.2.0

Q_SLOT void setAltitudeMode (
bb::platform::geo::AltitudeMode::Typemode)

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.

Q_SLOT void setDescription (
const QString &desc)

Sets the description of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setGeoId (
const QString &id)

Sets the ID of this Geographic.

Since:

BlackBerry 10.2.0

Q_SLOT void setId (
const QString &id)

Deprecated

Use setGeoId() instead.

Q_SLOT void setName (
const QString &name)

Sets the name of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setStyleFamily (
const QString &styleFamily)

Sets the style family for this Geographic.

Parameters
styleFamily	The new style family for this element.

Since:

BlackBerry 10.2.0

QString styleFamily ()

Gets the style family for this Geographic.

Since:

BlackBerry 10.2.0

Protected Functions

(Only has inherited protected functions)

GeoShape (
QObject *parent)

Constructor.

Parameters
parent	The parent of this Geographic.

Since:

BlackBerry 10.2.0

GeoShape (
const QString &id,
QObject *parent )

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.

Since:

BlackBerry 10.2.0

void setBoundingBox (
const bb::platform::geo::BoundingBox &newBox)

Signals

void innerBoundariesChanged (
const QList< bb::platform::geo::Polyline > &newInnerBoundaries)

Emitted when the polygon's collection of inner boundaries have changed.

Parameters
newInnerBoundaries	The collection of new inner boundaries.

Since:

BlackBerry 10.2.0

void outerBoundaryChanged (
const bb::platform::geo::Polyline &outerBoundary)

Emitted when the polygon's outer boundary has changed.

Since:

BlackBerry 10.2.0

void altitudeModeChanged (
bb::platform::geo::AltitudeMode::Typemode)

Emitted when the view's altitude mode has changed.

Parameters
mode	The new altitude mode for this shape.

Since:

BlackBerry 10.2.0

void boundaryChanged (
const bb::platform::geo::BoundingBox &box)

Emitted by derived classes when the bounding box has changed.

See the BoundingBox documentation.

Since:

BlackBerry 10.0.0

void descriptionChanged (
const QString &desc)

Emitted when the description of this Geographic changes.

Since:

BlackBerry 10.0.0

void geoIdChanged (
const QString &id)

Emitted when the ID of this Geographic changes.

Since:

BlackBerry 10.2.0

void idChanged (
const QString &id)

Deprecated

Use geoIdChanged() instead.

void nameChanged (
const QString &name)

Emitted when the name of this Geographic changes.

Since:

BlackBerry 10.0.0

void styleFamilyChanged (
const QString &newFamily)

Emitted when the style family attribute changes.

Since:

BlackBerry 10.2.0

void topographyChanged (
const QString &id)

Emitted when the topography of this Geographic changes.

A Geographic's topography captures the location (or geographic) properties of the element.

Parameters
id	The ID of this Geographic.

Since:

BlackBerry 10.1.0

Overview

Inheritance

Properties Index

Public Functions Index

Protected Functions Index

Signals Index

Properties

QList< bb::platform::geo::Polyline > innerBoundaries

bb::platform::geo::Polyline outerBoundary

bb::platform::geo::AltitudeMode::Type altitudeMode

bb::platform::geo::BoundingBox boundingBox[read-only]

QString description

QString geoId

QString id

QString name

QString styleFamily

Public Functions

GeoPolygon (QObject *parent)

GeoPolygon (const QString &id, QObject *parent )

virtual~GeoPolygon ()

QList< Polyline > innerBoundaries ()

Polyline outerBoundary ()

void setInnerBoundaries (const QList< bb::platform::geo::Polyline > &newInnerBoundaries)

bool setOuterBoundary (const bb::platform::geo::Polyline &line)

AltitudeMode::Type altitudeMode ()

virtualbb::platform::geo::BoundingBox boundingBox ()

QString description ()

Geographic (QObject *parent)

Geographic (const QString &id, QObject *parent )

QString geoId ()

QString id ()

QString name ()

Q_SLOT void resetAltitudeMode ()

Q_SLOT void setAltitudeMode (bb::platform::geo::AltitudeMode::Typemode)

Q_SLOT void setDescription (const QString &desc)

Q_SLOT void setGeoId (const QString &id)

Q_SLOT void setId (const QString &id)

Q_SLOT void setName (const QString &name)

Q_SLOT void setStyleFamily (const QString &styleFamily)

QString styleFamily ()

Protected Functions

GeoShape (QObject *parent)

GeoShape (const QString &id, QObject *parent )

void setBoundingBox (const bb::platform::geo::BoundingBox &newBox)

Signals

void innerBoundariesChanged (const QList< bb::platform::geo::Polyline > &newInnerBoundaries)

void outerBoundaryChanged (const bb::platform::geo::Polyline &outerBoundary)

void altitudeModeChanged (bb::platform::geo::AltitudeMode::Typemode)

void boundaryChanged (const bb::platform::geo::BoundingBox &box)

void descriptionChanged (const QString &desc)

void geoIdChanged (const QString &id)

void idChanged (const QString &id)

void nameChanged (const QString &name)

void styleFamilyChanged (const QString &newFamily)

void topographyChanged (const QString &id)

1. Choose your focus

2. Download the tools

3. Try the sample apps

4. Educate yourself

5. Start developing

GeoPolygon (
QObject *parent)

GeoPolygon (
const QString &id,
QObject *parent )

void setInnerBoundaries (
const QList< bb::platform::geo::Polyline > &newInnerBoundaries)

bool setOuterBoundary (
const bb::platform::geo::Polyline &line)

Geographic (
QObject *parent)

Geographic (
const QString &id,
QObject *parent )

Q_SLOT void setAltitudeMode (
bb::platform::geo::AltitudeMode::Typemode)

Q_SLOT void setDescription (
const QString &desc)

Q_SLOT void setGeoId (
const QString &id)

Q_SLOT void setId (
const QString &id)

Q_SLOT void setName (
const QString &name)

Q_SLOT void setStyleFamily (
const QString &styleFamily)

GeoShape (
QObject *parent)

GeoShape (
const QString &id,
QObject *parent )

void setBoundingBox (
const bb::platform::geo::BoundingBox &newBox)

void innerBoundariesChanged (
const QList< bb::platform::geo::Polyline > &newInnerBoundaries)

void outerBoundaryChanged (
const bb::platform::geo::Polyline &outerBoundary)

void altitudeModeChanged (
bb::platform::geo::AltitudeMode::Typemode)

void boundaryChanged (
const bb::platform::geo::BoundingBox &box)

void descriptionChanged (
const QString &desc)

void geoIdChanged (
const QString &id)

void idChanged (
const QString &id)

void nameChanged (
const QString &name)

void styleFamilyChanged (
const QString &newFamily)

void topographyChanged (
const QString &id)