An AfrigisMapSDK object provides an embeddable map interface. You use this class as-is to display map information and to manipulate the map contents from your application. You can centre the map on a given coordinate, specify the size of the area you want to display, and annotate the map with custom information. More...

#include <AfrigisMapSDK.hpp>

Inheritance diagram for AfrigisMapSDK:

Public Types
enum	ViewType { SatelliteView, MapView }

Public Slots
void	clearMap ()
	clears the map. Removes all pins, annotations, routes and traffic layers. More...

void	removeLocateMe ()
	remove locate-me. More...

void	trackMe (AGTrackMeType type)
	Starts track-me. More...

void	enableLocatingUserInCenter (bool enable)
	enable or disable re-centre map in user's current location. More...

void	stopTracking ()
	stop tracking but show the last tracking position. More...

void	stopAndRemoveTracking ()
	stop tracking and remove the indicator. More...

void	addTrafficLayer ()
	show traffic layer on map. More...

void	removeTrafficLayer ()
	remove traffic layer. More...

QObject *	addRouteView (QList< QPair< float, float > > *routeGeoLocationCoordinates, bool startMarkerOn, bool endMarkerOn)
	show route on map. More...

void	removeRouteView (QObject *routeView)
	remove route view. More...

void	zoomToExtend (QList< AGLocationCoordinate2D > *listOfPoints)
	zoom to extend to show the given list of points fully on map. More...

void	addPinView (AGGeoInformation geoInfo, QByteArray imageData, bool callOutBubbleEnabled, bool contextMenuEnabled)
	add pin view to show pin in certain location. More...

void	removePinView ()
	remove pin view. More...

AnnotationView *	addAnnotationView (QList< Item * > *itemList=NULL)
	add annotation view. More...

void	removeAnnotationView (AnnotationView *annotationView)
	remove annotation view. More...

PolylineItem *	createPolylineItem (QList< AGLocationCoordinate2D > *geoLocationCoordinates, bool enableZoomToExtend, AGOffsetInPixel offset=AGOffsetInPixel())
	add poly-line item. More...

CircleItem *	createCircleItem (QList< AGLocationCoordinate2D > circleCenter, float circleRadius, QColor circleColor, AGOffsetInPixel offset=AGOffsetInPixel())
	add circle item. More...

ImageItem *	createImageItem (QList< AGLocationCoordinate2D > imageCenter, QByteArray image, int imageWidth, int imageHeight, AGOffsetInPixel offset=AGOffsetInPixel())
	add Image item. More...

void	updateLocation (AGLocationCoordinate2D *updatedLocationCoordinate=NULL, int zoomLevel=0)
	update centre location of map. More...

void	pauseRender ()
	private. More...

void	resumeRender ()
	private. More...

void	enableZoomInOutButton (bool zoomInOutButtonEnabled)
	enable disable zoom in out button. More...

bool	isBubbleTouched (double localX, double localY)
	private. More...

void	setBubbleEnabled (bool bubbleStatus)
	enable disable bubble to show. More...

bool	isBubbleEnabled ()
	get bubble enable status. More...

Signals
void	signalTrackingStarted ()
	signal emits when tracking started. More...

void	signalTrackingStopped ()
	signal emits when tracking stopped. More...

void	signalUserLocatedWithAccuracy (int)
	signal emits when user located after tracking start. More...

void	signalUserLocatingFailed ()
	signal emits when located user failed. More...

void	signalMapViewTouchedDown (AGGeoInformation *)
	signal emits when touch down event occurs on map. More...

Public Member Functions
	AfrigisMapSDK (bb::cascades::Page mapPage, double lat, double lon, int zoom, QString serviceName, QString serviceKey, AGMapViewDelegate mapViewDelegate, ViewType viewType, int x, int y, int width, int height)
	Constructor to create map. More...

	AfrigisMapSDK (bb::cascades::Container mapContainer, double lat, double lon, int zoom, QString serviceName, QString serviceKey, AGMapViewDelegate mapViewDelegate, ViewType viewType, int x, int y, int width, int height, double scaleX=1.0, double scaleY=1.0)
	Constructor to create map. More...

void	setViewType (ViewType viewType)
	set different view type of map: SatelliteView, MapView. More...

AGLocalPixelCoordinate2D *	getLocalPixelFromLatLon (AGLocationCoordinate2D *geoCoordinate)
	get device's local pixel coordinate of a latitude-longitude pair. More...

AGLocationCoordinate2D *	getLatLonFromLocalPixel (AGLocalPixelCoordinate2D *pixelCoordinate)
	get latitude-longitude pair of a device's local pixel coordinate. More...

AGGeoInformation *	getCurrentBoundingBox ()
	get current bounding box informaion. More...

Detailed Description

An AfrigisMapSDK object provides an embeddable map interface. You use this class as-is to display map information and to manipulate the map contents from your application. You can centre the map on a given coordinate, specify the size of the area you want to display, and annotate the map with custom information.

Since: v0.6.0

Constructor & Destructor Documentation

AfrigisMapSDK::AfrigisMapSDK	(	bb::cascades::Page *	mapPage,
		double	lat,
		double	lon,
		int	zoom,
		QString	serviceName,
		QString	serviceKey,
		AGMapViewDelegate *	mapViewDelegate,
		ViewType	viewType,
		int	x,
		int	y,
		int	width,
		int	height
	)

Constructor to create map.

Parameters

Page	Container page where map will be displayed.
lat	latitude of centre location.
lon	longitude of centre location.
zoom	zoom level of map.
serviceName	valid service name.
serviceKey	valid service key.
AGMapViewDelegate	defines a set of optional methods that you can use to receive map related update messages.
ViewType	of map: SatelliteView, MapView.
x	coordinate of map window.
y	coordinate of map window.
width	of the map window.
height	of the map window.

Since: v0.6.0

AfrigisMapSDK::AfrigisMapSDK	(	bb::cascades::Container *	mapContainer,
		double	lat,
		double	lon,
		int	zoom,
		QString	serviceName,
		QString	serviceKey,
		AGMapViewDelegate *	mapViewDelegate,
		ViewType	viewType,
		int	x,
		int	y,
		int	width,
		int	height,
		double	scaleX = `1.0`,
		double	scaleY = `1.0`
	)

Constructor to create map.

Parameters

Container	where map will be displayed.
lat	latitude of centre location.
lon	longitude of centre location.
zoom	level of map.
serviceName	valid service name.
serviceKey	valid service key.
AGMapViewDelegate	defines a set of optional methods that you can use to receive map related update messages.
ViewType	of map: SatelliteView, MapView.
x	coordinate of map window.
y	coordinate of map window.
width	of the map window.
scaleX	x-coordinate scale factor.
scaleY	y-coordinate scale factor.

Since: v0.6.0

Member Function Documentation

AnnotationView * AfrigisMapSDK::addAnnotationView ( QList< Item * > * itemList = NULL )

slot

add annotation view.

Parameters

itemList items to be shown on this annotation view.

Returns: AnnotationView reference

Since: v0.6.0

void AfrigisMapSDK::addPinView	(	AGGeoInformation *	geoInfo,
		QByteArray *	imageData,
		bool	callOutBubbleEnabled,
		bool	contextMenuEnabled
	)

slot

add pin view to show pin in certain location.

Parameters

AGGeoInformation	latitude and longitude of the location.
imageData	to show as pin on map.
callOutBubbleEnabled	enable call-out bubble.
contextMenuEnabled	enable showing context menu.

Since: v0.6.0

QObject * AfrigisMapSDK::addRouteView	(	QList< QPair< float, float > > *	routeGeoLocationCoordinates,
		bool	startMarkerOn,
		bool	endMarkerOn
	)

slot

show route on map.

Parameters

routeGeoLocationCoordinates	for start point and end point.
startMarkerOn	enable the start marker.
endMarkerOn	enable the end marker.

Returns: created route view as QObject reference

Since: v0.6.0

void AfrigisMapSDK::addTrafficLayer ( )

slot

show traffic layer on map.

Since: v0.6.0

void AfrigisMapSDK::clearMap ( )

slot

clears the map. Removes all pins, annotations, routes and traffic layers.

Since: v0.6.0

CircleItem * AfrigisMapSDK::createCircleItem	(	QList< AGLocationCoordinate2D > *	circleCenter,
		float	circleRadius,
		QColor *	circleColor,
		AGOffsetInPixel	offset = `AGOffsetInPixel()`
	)

slot

add circle item.

Parameters

circleCenter	lat lon for the circle.
circleRadius	in pixel.
circleColor	to fill the circle.
AGOffsetInPixel	Move offset pixel to draw circle.

Returns: CircleItem reference

Since: v0.6.0

ImageItem * AfrigisMapSDK::createImageItem	(	QList< AGLocationCoordinate2D > *	imageCenter,
		QByteArray *	image,
		int	imageWidth,
		int	imageHeight,
		AGOffsetInPixel	offset = `AGOffsetInPixel()`
	)

slot

add Image item.

Parameters

imageCenter	lat lon for the image to draw.
image	data to draw.
imageWidth	data to draw.
imageHeight	data to draw.
AGOffsetInPixel	Move offset pixel to draw image.

Returns: ImageItem reference

Since: v0.6.0

PolylineItem * AfrigisMapSDK::createPolylineItem	(	QList< AGLocationCoordinate2D > *	geoLocationCoordinates,
		bool	enableZoomToExtend,
		AGOffsetInPixel	offset = `AGOffsetInPixel()`
	)

slot

add poly-line item.

Parameters

geoLocationCoordinates	for the poly-line.
enableZoomToExtend	for the poly-line.
AGOffsetInPixel	Move offset pixel to draw poly-line.

Returns: PolylineItem reference

Since: v0.6.0

void AfrigisMapSDK::enableLocatingUserInCenter ( bool enable )

slot

enable or disable re-centre map in user's current location.

Parameters

enable value

Since: v0.6.0

void AfrigisMapSDK::enableZoomInOutButton ( bool zoomInOutButtonEnabled )

slot

enable disable zoom in out button.

Parameters

zoomInOutButtonEnabled to set.

Since: v0.6.0

AGGeoInformation * AfrigisMapSDK::getCurrentBoundingBox ( )

get current bounding box informaion.

Returns: AGGeoInformation struct for current bounding box information.

Since: v0.6.0

AGLocationCoordinate2D * AfrigisMapSDK::getLatLonFromLocalPixel ( AGLocalPixelCoordinate2D * pixelCoordinate )

get latitude-longitude pair of a device's local pixel coordinate.

Parameters

AGLocationCoordinate2D struct for latitude and longitude.

Returns: AGLocalPixelCoordinate2D struct for local pixel coordinate.

Since: v0.6.0

AGLocalPixelCoordinate2D * AfrigisMapSDK::getLocalPixelFromLatLon ( AGLocationCoordinate2D * geoCoordinate )

get device's local pixel coordinate of a latitude-longitude pair.

Parameters

AGLocationCoordinate2D struct for latitude and longitude.

Returns: AGLocalPixelCoordinate2D struct for local pixel coordinate.

Since: v0.6.0

bool AfrigisMapSDK::isBubbleEnabled ( )

slot

get bubble enable status.

Since: v0.6.0

bool AfrigisMapSDK::isBubbleTouched	(	double	localX,
		double	localY
	)

slot

private.

Since: v0.6.0

void AfrigisMapSDK::pauseRender ( )

slot

private.

Since: v0.6.0

void AfrigisMapSDK::removeAnnotationView ( AnnotationView * annotationView )

slot

remove annotation view.

Parameters

annotationView to be removed.

Since: v0.6.0

void AfrigisMapSDK::removeLocateMe ( )

slot

remove locate-me.

Since: v0.6.0

void AfrigisMapSDK::removePinView ( )

slot

remove pin view.

Since: v0.6.0

void AfrigisMapSDK::removeRouteView ( QObject * routeView )

slot

remove route view.

Parameters

routeView reference of route view to be removed.

Since: v0.6.0

void AfrigisMapSDK::removeTrafficLayer ( )

slot

remove traffic layer.

Since: v0.6.0

void AfrigisMapSDK::resumeRender ( )

slot

private.

Since: v0.6.0

void AfrigisMapSDK::setBubbleEnabled ( bool bubbleStatus )

slot

enable disable bubble to show.

Parameters

bubbleStatus to set

Since: v0.6.0

void AfrigisMapSDK::setViewType ( ViewType viewType )

set different view type of map: SatelliteView, MapView.

Parameters

ViewType of map: SatelliteView, MapView.

Since: v0.6.0

void AfrigisMapSDK::signalMapViewTouchedDown ( AGGeoInformation * )

signal

signal emits when touch down event occurs on map.

Parameters

AGGeoInformation bounding box information.

Since: v0.6.0

void AfrigisMapSDK::signalTrackingStarted ( )

signal

signal emits when tracking started.

Since: v0.6.0

void AfrigisMapSDK::signalTrackingStopped ( )

signal

signal emits when tracking stopped.

Since: v0.6.0

void AfrigisMapSDK::signalUserLocatedWithAccuracy ( int )

signal

signal emits when user located after tracking start.

Parameters

accuracy of location information.

Since: v0.6.0

void AfrigisMapSDK::signalUserLocatingFailed ( )

signal

signal emits when located user failed.

Since: v0.6.0

void AfrigisMapSDK::stopAndRemoveTracking ( )

slot

stop tracking and remove the indicator.

Since: v0.6.0

void AfrigisMapSDK::stopTracking ( )

slot

stop tracking but show the last tracking position.

Since: v0.6.0

void AfrigisMapSDK::trackMe ( AGTrackMeType type )

slot

Starts track-me.

Parameters

AGTrackMeType Type of track-me: AGTrackMeTypeAccuracy, AGTrackMeTypeDirection, AGTrackMeTypeBoth AGTrackMeTypeAccuracy : It will show a circle to represent accuracy AGTrackMeTypeDirection : It will show an arrow to represent direction AGTrackMeTypeBoth : It will show both circle and arrow.

Since: v0.6.0

void AfrigisMapSDK::updateLocation	(	AGLocationCoordinate2D *	updatedLocationCoordinate = `NULL`,
		int	zoomLevel = `0`
	)

slot

update centre location of map.

Parameters

AGLocationCoordinate2D	lat lon of centre.
zoomLevel	to set.

Since: v0.6.0

void AfrigisMapSDK::zoomToExtend ( QList< AGLocationCoordinate2D > * listOfPoints )

slot

zoom to extend to show the given list of points fully on map.

Parameters

listOfPoints given to show on map.

Since: v0.6.0

The documentation for this class was generated from the following files:

D:/office_workspaces/ndk-10.2.0-workspace/AfrigisMapSDK/src/PublicMap/include/AfrigisMapSDK.hpp
D:/office_workspaces/ndk-10.2.0-workspace/AfrigisMapSDK/src/PublicMap/PublicImplementation/AfrigisMapSDK.cpp

Public Types

Public Slots

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation