com.telenav.mapkit

Class MapView

java.lang.Object

GLMapSurfaceView

com.telenav.mapkit.MapView

public class MapView
extends GLMapSurfaceView

This is the main class in the MapView SDK. When you want to show mapView in your application, create an instance of this class and add it to your activity. Prerequisites: call the MapService:provideApiKeyAndSecret method to configure the key and secret values before initializing the instance. Created by xizhens on 2/28/14. Copyright reserved by Telenav.Inc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapView.RasterMode Raster Modes supported by the mapView API
static class	MapView.RenderMode The Enum for the rendering modes supported by mapView
static class	MapView.TouchMode The Enum defining the touch mode supported by mapView

Constructor Summary

Constructors

Constructor and Description
MapView(android.content.Context context) This is the class' default constructor.
MapView(android.content.Context context, android.util.AttributeSet attrs) This is the constructor used by the system when creating MapView from an XML layout file.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAnnotation(Annotation annotation) This method is used to add an annotation to the map view
OverlayId	addOverLay(Overlay overlay) This method is used to add an overlay to the map view.
float	calculateZoom(ArrayList<Annotation> annotations, Annotation centerAnno) This method is used to calculate the zoom level at which to show the annotations.
void	disableAllAnnotationLayers() This method is used to disable all annotation layers at once.
void	disableAnnotationLayer(Annotation.AnnotationLayer layer) This method is used to disable an annotation layer.
void	disableAnnotationLayers(ArrayList<Annotation.AnnotationLayer> layers) This method is used to disable a list of specific annotation layers at once.
void	enableAnnotationLayer(Annotation.AnnotationLayer layer) This method is used to enable an annotation layer.
void	enableAnnotationLayers(ArrayList<Annotation.AnnotationLayer> layers) This method is used to enable a list of annotation layers.
void	followVehicle(boolean follow) This method is used to configure the camera to follow the vehicle moving.
android.location.Location	getCameraLocation() This method is used to get the camera location.
android.location.Location	getLocationForScreenPoint(android.graphics.Point point) This method is used to get information for the screen location
byte[]	getSnapShot(int x, int y, int width, int height) This method is used to get a bitmap snapshot for the current map view window.
MapView.TouchMode	getTouchMode() This method is used to get the touch mode of the current map view.
boolean	getUseMetricUnits() This method is used to get the current configuration of the unit system.
float	getZoomLevel() This method is used to get the current zoom level as a float value.
boolean	hideAnnotation(Annotation annotation) This method is used to hide an annotation on screen.
boolean	isNightMode() This method is used to get the current display mode.
void	loadConfiguration(String configFile) This method is used to load a new configuration file specified by user.
void	loadConfigurationForTvOut(String configFile) This method is used to load a new configuration file for TV out specified by user.
void	loadConfigurations(ArrayList<String> configFiles) This method is used to load the list of configurations specified by user.
void	lookAt(ArrayList<Annotation> annotations) This method is used to configure the camera to show the annotations on the screen.
void	lookAt(double north, double west, double south, double east) This method is used to configure the map view camera to look at the boundary.
void	lookAt(android.location.Location location) This method is used to change the camera configuration.
void	removeAllAnnotation() This method is used to remove all annotations.
void	removeAnnotation(Annotation annotation) This method is used to remove the annotation from the map view
void	removeOverLay(OverlayId ids) This method is used to remove an overlay by the overlay Id.
void	setDisplaySpeedTraps(boolean enable) This method is used to turn on or off speed traps information.
void	setDisplayTraffic(boolean enable) This method is used to turn on or off the traffic information.
void	setDisplayTrafficCameras(boolean enable) This method is used to turn on or off traffic camera information.
void	setDisplayTrafficIncidents(boolean enable) This method is used to turn on or off the traffic incidents information.
void	setDisplayVehicle(boolean enable) This method is used to turn on or off vehicle visibility.
void	setNightMode(boolean nightMode) This method is used to configure the map view style to night mode or day mode.
void	setRasterMode(MapView.RasterMode mode) This method is used to configure the map raster mode.
void	setRenderMode(MapView.RenderMode mode) This method is used to change the render mode.
void	setTouchMode(MapView.TouchMode mode) This method is used to configure the touch mode of the map view.
void	setUseMetricUnits(Boolean useMetric) This method is used to change the configuration of the unit system.
void	setVehicle2D(Annotation annotation) This method is used to change the vehicle style in 2D mode.
void	setVehicle3D(String modelName) This method is used to configure the vehicle texture in 3D mode.
void	setVehiclePosition(android.location.Location l) This method is used to configure the vehicle location.
void	setViewConfigPrefix(String configPrefix) This method is used to set the configuration prefix which is possible to append to configuration path.
void	setZoomLevel(float zoom, boolean needTransition) This method is used to configure the map view zoom level.
boolean	showAnnotation(Annotation annotation) This method is used to show the annotation on screen.
void	showCopyRight(int x, int y, int pixelWidth, int pixelHeight) This method is used to configure the copyright information location.
Annotation.AnnotationLayer	unusedAnnotationLayer() This method is used to get an unused annotation layer.
void	updateAnnotationLocation(Annotation annotation) This method is used to update annotation information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapView

public MapView(android.content.Context context)

This is the class' default constructor. It is used to create a default instance of MapView.

Parameters:

context - the owner context; used to retrieve a resource from the context

MapView

public MapView(android.content.Context context,
       android.util.AttributeSet attrs)

This is the constructor used by the system when creating MapView from an XML layout file.

Parameters:

context - the owner context used to retrieve a resource

attrs - the XML attributes defined in the layout file

Method Detail

getCameraLocation

public android.location.Location getCameraLocation()

This method is used to get the camera location.

Returns:

the location of the camera

getLocationForScreenPoint

public android.location.Location getLocationForScreenPoint(android.graphics.Point point)

This method is used to get information for the screen location

Parameters:

point - the x,y offset on the map view

Returns:

the location info (latitude &longitude)

removeAnnotation

public void removeAnnotation(Annotation annotation)

This method is used to remove the annotation from the map view

Parameters:

annotation - the annotation you want remove

addAnnotation

public void addAnnotation(Annotation annotation)

This method is used to add an annotation to the map view

Note: If you want to remove it later, keep a reference of this annotation.

Parameters:

annotation - the annotation you want to add

updateAnnotationLocation

public void updateAnnotationLocation(Annotation annotation)

This method is used to update annotation information.

Note: if you want to change an attribute of the annotation, change the attribute first, and then call this method to update the information on the map view.

Parameters:

annotation - the annotation you want update

showAnnotation

public boolean showAnnotation(Annotation annotation)

This method is used to show the annotation on screen.

Parameters:

annotation - the annotation you want to show on the screen

Returns:

boolean true is success to show, false is failed to show

hideAnnotation

public boolean hideAnnotation(Annotation annotation)

This method is used to hide an annotation on screen.

Parameters:

annotation - the annotation you want to hide from the screen

Returns:

boolean true is success to hide, false is failed to hide

setNightMode

public void setNightMode(boolean nightMode)

This method is used to configure the map view style to night mode or day mode.

Parameters:

nightMode - to use night mode or not

isNightMode

public boolean isNightMode()

This method is used to get the current display mode.

Returns:

boolean true is night mode, false is day mode

setRasterMode

public void setRasterMode(MapView.RasterMode mode)

This method is used to configure the map raster mode.

Parameters:

mode - a value of the RasterMode Enum

See Also:

MapView.RasterMode

lookAt

public void lookAt(ArrayList<Annotation> annotations)

This method is used to configure the camera to show the annotations on the screen.

The camera will automatically zoom in or out to make all annotations available on the screen.

Parameters:

annotations - an array of annotations you want show .

calculateZoom

public float calculateZoom(ArrayList<Annotation> annotations,
                  Annotation centerAnno)

This method is used to calculate the zoom level at which to show the annotations.

Parameters:

annotations - an array of annotation you want to be available on the screen

centerAnno - the annotation you want display in the center

Returns:

float value for the zoom level at which to show these annotations

lookAt

public void lookAt(android.location.Location location)

This method is used to change the camera configuration.

Parameters:

location - the location you want show in the center of the map

lookAt

public void lookAt(double north,
          double west,
          double south,
          double east)

This method is used to configure the map view camera to look at the boundary.

Parameters:

north - the most northward

west - the most westward

south - the most southward

east - the most eastward

setDisplayTraffic

public void setDisplayTraffic(boolean enable)

This method is used to turn on or off the traffic information.

Parameters:

enable - boolean value, to enable traffic or not

setDisplayTrafficIncidents

public void setDisplayTrafficIncidents(boolean enable)

This method is used to turn on or off the traffic incidents information.

Parameters:

enable - boolean value, to enable incidents information or not

setDisplayTrafficCameras

public void setDisplayTrafficCameras(boolean enable)

This method is used to turn on or off traffic camera information.

Parameters:

enable - boolean value, to enable traffic camera information or not

setDisplaySpeedTraps

public void setDisplaySpeedTraps(boolean enable)

This method is used to turn on or off speed traps information.

Parameters:

enable - boolean value, to enable speed traps information or not

setDisplayVehicle

public void setDisplayVehicle(boolean enable)

This method is used to turn on or off vehicle visibility.

Parameters:

enable - to show vehicle icon or not

followVehicle

public void followVehicle(boolean follow)

This method is used to configure the camera to follow the vehicle moving.

Parameters:

follow - boolean value, to follow the vehicle or not

setVehicle2D

public void setVehicle2D(Annotation annotation)

This method is used to change the vehicle style in 2D mode.

Parameters:

annotation - using the configuration of the annotation to show the vehicle

setVehicle3D

public void setVehicle3D(String modelName)

This method is used to configure the vehicle texture in 3D mode.

Parameters:

modelName - the name of the 3D model file. That file must be placed in the correct path. For the path information, see the Developer Documentation.

setVehiclePosition

public void setVehiclePosition(android.location.Location l)

This method is used to configure the vehicle location.

Parameters:

l - the location at which you want to place the vehicle

setRenderMode

public void setRenderMode(MapView.RenderMode mode)

This method is used to change the render mode.

Parameters:

mode - one of the RenderMode Enum values

addOverLay

public OverlayId addOverLay(Overlay overlay)

This method is used to add an overlay to the map view.

Parameters:

overlay - the overlay you want to add to the map view.

Note: Before adding an overlay, you mush configure it.

Returns:

the overlayId for the added overlay. If you want to remove that overlay later, retain this Id value.

removeAllAnnotation

public void removeAllAnnotation()

This method is used to remove all annotations.

removeOverLay

public void removeOverLay(OverlayId ids)

This method is used to remove an overlay by the overlay Id.

Parameters:

ids - the id of the overlay you want to remove

getSnapShot

public byte[] getSnapShot(int x,
                 int y,
                 int width,
                 int height)

This method is used to get a bitmap snapshot for the current map view window.

Parameters:

x - the origin x of the window

y - the origin y of the window

width - the width of the window

height - the height of the window

Returns:

setTouchMode

public void setTouchMode(MapView.TouchMode mode)

This method is used to configure the touch mode of the map view.

Parameters:

mode - a value of the TouchMode Enum

getTouchMode

public final MapView.TouchMode getTouchMode()

This method is used to get the touch mode of the current map view.

Returns:

the current touch mode configuration

setUseMetricUnits

public void setUseMetricUnits(Boolean useMetric)

This method is used to change the configuration of the unit system.

Parameters:

useMetric - boolean value, to use metric values or not

getUseMetricUnits

public boolean getUseMetricUnits()

This method is used to get the current configuration of the unit system.

Returns:

the boolean value, to use metric units or not

getZoomLevel

public float getZoomLevel()

This method is used to get the current zoom level as a float value.

Returns:

the current zoom level

setZoomLevel

public void setZoomLevel(float zoom,
                boolean needTransition)

This method is used to configure the map view zoom level.

Parameters:

zoom - the zoom level you want to set

needTransition - boolean value, to use transition animation or not

showCopyRight

public void showCopyRight(int x,
                 int y,
                 int pixelWidth,
                 int pixelHeight)

This method is used to configure the copyright information location.

Parameters:

x - original x location

y - original y location

pixelWidth - width of the copyright box

pixelHeight - height of the copyright box

unusedAnnotationLayer

public Annotation.AnnotationLayer unusedAnnotationLayer()

This method is used to get an unused annotation layer.

Returns:

the first unused annotation layer, null if none available

enableAnnotationLayer

public void enableAnnotationLayer(Annotation.AnnotationLayer layer)

This method is used to enable an annotation layer.

Parameters:

layer - the annotation layer to enable

enableAnnotationLayers

public void enableAnnotationLayers(ArrayList<Annotation.AnnotationLayer> layers)

This method is used to enable a list of annotation layers.

Parameters:

layers - the list of annotation layers to enable

disableAnnotationLayer

public void disableAnnotationLayer(Annotation.AnnotationLayer layer)

This method is used to disable an annotation layer.

Parameters:

layer - the annotation layer to disable

disableAnnotationLayers

public void disableAnnotationLayers(ArrayList<Annotation.AnnotationLayer> layers)

This method is used to disable a list of specific annotation layers at once.

Parameters:

layers - the list of annotation layers to disable

disableAllAnnotationLayers

public void disableAllAnnotationLayers()

This method is used to disable all annotation layers at once.

loadConfiguration

public void loadConfiguration(String configFile)

This method is used to load a new configuration file specified by user.

Parameters:

configFile - the configuration file name to load.

loadConfigurations

public void loadConfigurations(ArrayList<String> configFiles)

This method is used to load the list of configurations specified by user.

Parameters:

configFiles - the list of configuration file names to load.

loadConfigurationForTvOut

public void loadConfigurationForTvOut(String configFile)

This method is used to load a new configuration file for TV out specified by user.

Parameters:

configFile - the configuration file name for TV out to load.

setViewConfigPrefix

public void setViewConfigPrefix(String configPrefix)

This method is used to set the configuration prefix which is possible to append to configuration path.

Parameters:

configPrefix - the possible prefix to append to configuration path.