GeoShape

Since: BlackBerry 10.2.0

#include <bb/platform/geo/GeoShape>

To link against this class, add the following line to your .pro file: LIBS += -lbbcascadesmaps

A base class for all geographic shapes.


Overview

Public Functions Index

virtual ~GeoShape ()
AltitudeMode::TypealtitudeMode () const
Q_SLOT voidresetAltitudeMode ()
Q_SLOT voidsetAltitudeMode (bb::platform::geo::AltitudeMode::Type mode)
virtual bb::platform::geo::BoundingBoxboundingBox () const Inherited
QStringdescription () const Inherited
Geographic (QObject *parent=0)Inherited
Geographic (const QString &id, QObject *parent=0)Inherited
QStringgeoId () const Inherited
QStringid () const BB_DEPRECATEDInherited
QStringname () const Inherited
Q_SLOT voidsetDescription (const QString &desc)Inherited
Q_SLOT voidsetGeoId (const QString &id)Inherited
Q_SLOT voidsetId (const QString &id) BB_DEPRECATEDInherited
Q_SLOT voidsetName (const QString &name)Inherited
Q_SLOT voidsetStyleFamily (const QString &styleFamily)Inherited
QStringstyleFamily () const Inherited

Protected Functions Index

GeoShape (QObject *parent=0)
GeoShape (const QString &id, QObject *parent=0)
voidsetBoundingBox (const bb::platform::geo::BoundingBox &newBox)Inherited

Signals Index

voidaltitudeModeChanged (bb::platform::geo::AltitudeMode::Type mode)
voidboundaryChanged (const bb::platform::geo::BoundingBox &box)Inherited
voiddescriptionChanged (const QString &desc)Inherited
voidgeoIdChanged (const QString &id)Inherited
voididChanged (const QString &id) BB_DEPRECATEDInherited
voidnameChanged (const QString &name)Inherited
voidstyleFamilyChanged (const QString &newFamily)Inherited
voidtopographyChanged (const QString &id)Inherited

Properties

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.

Since:

BlackBerry 10.0.0

Since:

BlackBerry 10.2.0

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

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

Since:

BlackBerry 10.0.0

QString descriptionInherited

The description of this object.

Since:

BlackBerry 10.0.0

QString geoIdInherited

The ID of this Geographic object.

Since:

BlackBerry 10.2.0

QString idInherited

Deprecated

Use the geoId property instead.

QString nameInherited

The name of this object.

Since:

BlackBerry 10.0.0

QString styleFamilyInherited

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

Since:

BlackBerry 10.2.0

Public Functions

virtual~GeoShape ()

Destructor.

Since:

BlackBerry 10.2.0

AltitudeMode::Type altitudeMode ()

Retrieves the altitude mode.

Since:

BlackBerry 10.2.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 (

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.

Since:

BlackBerry 10.2.0

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

Retrieves the axis-aligned bounding box for this Geographic.

Since:

BlackBerry 10.0.0

QString description ()Inherited

Gets the description of this Geographic.

Since:

BlackBerry 10.0.0

Geographic (Inherited

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 (Inherited

Constructor.

Parameters
id

The identifier for this Geographic.

parent

The parent of this Geographic.

Since:

BlackBerry 10.0.0

QString geoId ()Inherited

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 ()Inherited

Deprecated

Use geoId() instead.

QString name ()Inherited

Gets the name of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setDescription (Inherited

Sets the description of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setGeoId (Inherited

Sets the ID of this Geographic.

Since:

BlackBerry 10.2.0

Q_SLOT void setId (Inherited

Deprecated

Use setGeoId() instead.

Q_SLOT void setName (Inherited

Sets the name of this Geographic.

Since:

BlackBerry 10.0.0

Q_SLOT void setStyleFamily (Inherited

Sets the style family for this Geographic.

Parameters
styleFamily

The new style family for this element.

Since:

BlackBerry 10.2.0

See also:

StyleSheet

QString styleFamily ()Inherited

Gets the style family for this Geographic.

Since:

BlackBerry 10.2.0

See also:

StyleSheet

Protected Functions

GeoShape (

Constructor.

Parameters
parent

The parent of this Geographic.

Since:

BlackBerry 10.2.0

GeoShape (

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 (Inherited

Signals

void altitudeModeChanged (

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 (Inherited

Emitted by derived classes when the bounding box has changed.

See the BoundingBox documentation.

Since:

BlackBerry 10.0.0

void descriptionChanged (Inherited

Emitted when the description of this Geographic changes.

Since:

BlackBerry 10.0.0

void geoIdChanged (Inherited

Emitted when the ID of this Geographic changes.

Since:

BlackBerry 10.2.0

void idChanged (Inherited

Deprecated

Use geoIdChanged() instead.

void nameChanged (Inherited

Emitted when the name of this Geographic changes.

Since:

BlackBerry 10.0.0

void styleFamilyChanged (Inherited

Emitted when the style family attribute changes.

Since:

BlackBerry 10.2.0

void topographyChanged (Inherited

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

Last modified: 2014-03-13

comments powered by Disqus