MapController (Libraries

```
public interface MapController
```
This is the main interface to talk to the TomTom MapView. It provides all the functionality required to use, control and embellish the map.

Since:

2 (15.2 Fisichella)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`MapController.OnAutoCenterChangedListener` These listeners will be triggered when the auto-centering option changes.
`static interface`	`MapController.OnPanEnabledChangedListener` These listeners will be triggered when the user panning option changes.
`static interface`	`MapController.OnZoomEnabledChangedListener` These listeners will be triggered when the user zooming option changes.
`static class`	`MapController.UnknownLocationException` Thrown when trying to get the current location but the enabled providers don't have one and there is no last known location available.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addOnAutoCenterChangedListener(MapController.OnAutoCenterChangedListener onAutoCenterChangedListener)` Adds an auto-center listener to the list.
`void`	`addOnPanEnabledChangedListener(MapController.OnPanEnabledChangedListener onPanEnabledChangedListener)` Adds a user panning listener to the list.
`void`	`addOnZoomEnabledChangedListener(MapController.OnZoomEnabledChangedListener onZoomEnabledChangedListener)` Adds a user zooming listener to the list.
`MarkerLayer`	`createLayer()` Creates a new `MarkerLayer` for the map.
`int`	`getId()`
`List<MarkerLayer>`	`getLayers()` Returns the list of all `MarkerLayer`'s that the map currently contains.
`MarkerLayer`	`getLayerWithId(long id)` Returns the `MarkerLayer` with the given ID.
`LocationConverter`	`getLocationConverter()`
`MapArea`	`getMapArea()` Returns the currently visible map area.
`Location`	`getMapCenter()` Returns the current location as shown at the center of the map.
`int`	`getMapScale()`
`Marker`	`getMarkerWithId(long id)` Returns the `Marker` with the given ID.
`int`	`getMaxZoomLevel()`
`int`	`getMinZoomLevel()`
`RenderableLayer`	`getRenderableLayer()` Gets the root `RenderableLayer`.
`int`	`getZoomLevel()` Returns the current zoom level.
`boolean`	`isAutoCenterEnabled()`
`boolean`	`isLayerVisible(MarkerLayer layer)` Determine if a `MarkerLayer` is currently shown or not.
`boolean`	`isMapReady()` Check if the map is ready to receive commands.
`boolean`	`isPanEnabled()` Note that setting this to false will not prevent panning when the panning functions are called.
`boolean`	`isSensorLocationEnabled()` Check if map matched location enabled.
`boolean`	`isUserPanDisablesAutoCenterEnabled()`
`boolean`	`isZoomEnabled()`
`void`	`onDestroy()` Called when activity is being destroyed.
`void`	`onPause()` Called when activity goes to non-active state.
`void`	`onResume()` Called when activity goes to active state.
`void`	`registerMapEventCallbacks(MapEventCallbacks eventCallbacks)` Register callbacks to be invoked on map events.
`void`	`removeLayer(MarkerLayer layer)` Removes the given `MarkerLayer` from the map.
`void`	`removeMarkers(long[] markerIds)` Removes the given default `Marker`s.
`void`	`removeMarkers(long layerId, long[] markersIds)` Removes the given `Marker`s from given layer with current ids.
`void`	`setAutoCenterEnabled(boolean enable)` Keeps the map centered at the current location of the device.
`void`	`setId(int id)` Sets the identifier for this `MapController`.
`void`	`setLayerVisibility(long layerId, boolean show)` Show or hide a specific layer, including `StockLayers`.
`void`	`setLayerVisibility(MarkerLayer layer, boolean show)` Show or hide a specific layer.
`void`	`setMapArea(double latitudeFirst, double longitudeFirst, double latitudeSecond, double longitudeSecond)` Pans and zooms the map to the smallest possible part of the map that still contains the given points.
`void`	`setMapCenter(double latitude, double longitude)` Centers the map on the given location.
`void`	`setMapCenter(Location location)` Centers the map on the given location.
`void`	`setMapCenterToCurrentLocation()` Centers the map on the current location of the device.
`void`	`setMapScale(int scale)` Sets the map scale to an arbitrary value
`void`	`setPanEnabled(boolean enable)` Control whether or not the user is allowed to pan the map using touch gestures.
`void`	`setSensorLocationEnabled(boolean enable, Drawable icon)` Enable/disable sensor location.
`void`	`setUserPanDisablesAutoCenterEnabled(boolean enable)` Disables the auto-center mode once the user pans.
`void`	`setZoomEnabled(boolean enable)` Control whether or not the user is allowed to zoom the map using touch gestures.
`void`	`setZoomLevel(int level)` Zoom the map to the given level.

- Method Detail
  - setZoomEnabled
```
void setZoomEnabled(boolean enable)
```
    Control whether or not the user is allowed to zoom the map using touch gestures. Zooming programmatically is always possible and does not require setting this value to true.
    
    Parameters:
    
    enable - When true, the user is allowed to zoom the map.
  - isZoomEnabled
```
boolean isZoomEnabled()
```
    Returns:
    
    Returns true when the user is allowed to zoom using touch; false otherwise.
  - getMinZoomLevel
```
int getMinZoomLevel()
```
    Returns:
    
    The minimum supported zoom level for the current map.
  - getMaxZoomLevel
```
int getMaxZoomLevel()
```
    Returns:
    
    The maximum supported zoom level for the current map.
  - getZoomLevel
```
int getZoomLevel()
```
    Returns the current zoom level.
    
    Returns:
    
    The current zoom level, ranging from 0 (the world) to 20 (finest detail).
  - setZoomLevel
```
void setZoomLevel(int level)
```
    Zoom the map to the given level. The map will be scaled ranging from 0 (the world) to 20 (finest detail).
    
    Parameters:
    
    level - The zoom level. This zoom level will be clamped to the valid range [0, 20], dependent on the range the currently loaded map can support.
  - addOnZoomEnabledChangedListener
```
void addOnZoomEnabledChangedListener(MapController.OnZoomEnabledChangedListener onZoomEnabledChangedListener)
```
    Adds a user zooming listener to the list.
    
    Parameters:
    
    onZoomEnabledChangedListener - Listener that will be notified of user zooming state changes.
  - getMapCenter
```
Location getMapCenter()
```
    Returns the current location as shown at the center of the map. Note that this is not the current GPS location but the location as shown in the view.
    
    Returns:
    
    The center location of the map.
  - setPanEnabled
```
void setPanEnabled(boolean enable)
```
    Control whether or not the user is allowed to pan the map using touch gestures. Panning programmatically is always possible and does not require setting this value to true.
    
    Parameters:
    
    enable - When true, the user is allowed to pan the map.
  - isPanEnabled
```
boolean isPanEnabled()
```
    Note that setting this to false will not prevent panning when the panning functions are called. False will only prevent the user from moving the map.
    
    Returns:
    
    Returns true when the user is allowed to pan using touch; false otherwise.
  - addOnPanEnabledChangedListener
```
void addOnPanEnabledChangedListener(MapController.OnPanEnabledChangedListener onPanEnabledChangedListener)
```
    Adds a user panning listener to the list.
    
    Parameters:
    
    onPanEnabledChangedListener - Listener that will be notified of user panning state changes.
  - setAutoCenterEnabled
```
void setAutoCenterEnabled(boolean enable)
```
    Keeps the map centered at the current location of the device.
    
    Parameters:
    
    enable - When true, the map will be kept centered at the current location.
  - isAutoCenterEnabled
```
boolean isAutoCenterEnabled()
```
    Returns:
    
    Whether or not the map is in auto center mode.
  - addOnAutoCenterChangedListener
```
void addOnAutoCenterChangedListener(MapController.OnAutoCenterChangedListener onAutoCenterChangedListener)
```
    Adds an auto-center listener to the list.
    
    Parameters:
    
    onAutoCenterChangedListener - Listener that will be notified of auto-center state changes.
  - setUserPanDisablesAutoCenterEnabled
```
void setUserPanDisablesAutoCenterEnabled(boolean enable)
```
    Disables the auto-center mode once the user pans.
    
    Parameters:
    
    enable - When true, the auto-center will be disabled once the user pans the map. When false, the auto-center will remain active.
  - isUserPanDisablesAutoCenterEnabled
```
boolean isUserPanDisablesAutoCenterEnabled()
```
    Returns:
    
    Whether or not auto-center mode is disabled when the user pans.
  - setMapCenterToCurrentLocation
```
void setMapCenterToCurrentLocation()
```
    Centers the map on the current location of the device. If the new location is too far from the current one, MapController will go to the given location instantaneously; otherwise it will pan to it.
    
    Throws:
    
    MapController.UnknownLocationException - If no provider is enabled.
  - setMapCenter
```
void setMapCenter(Location location)
```
    Centers the map on the given location. If the new location is too far from the current one, MapController will go to the given location instantaneously; otherwise it will pan to it.
    
    Parameters:
    
    location - The location the map should show at the center of the MapView.
    
    Throws:
    
    IllegalArgumentException - When the Location is invalid.
  - setMapCenter
```
void setMapCenter(double latitude,
                  double longitude)
```
    Centers the map on the given location. If the new location is too far from the current one, MapController will go to the given location instantaneously; otherwise it will pan to it.
    
    Parameters:
    
    latitude - The latitude degrees of the location the map should show at the center of the MapView.
    
    longitude - The longitude degrees of the location the map should show at the center of the MapView.
    
    Throws:
    
    IllegalArgumentException - When one of the given values is invalid.
  - setMapArea
```
void setMapArea(double latitudeFirst,
                double longitudeFirst,
                double latitudeSecond,
                double longitudeSecond)
         throws IllegalArgumentException
```
    Pans and zooms the map to the smallest possible part of the map that still contains the given points. The points are the top-left and bottom-right corners of the area.
    
    Parameters:
    
    latitudeFirst - Latitude of the left-top location.
    
    longitudeFirst - Longitude of the left-top location.
    
    latitudeSecond - Latitude of the bottom-right location.
    
    longitudeSecond - Longitude of the bottom-right location.
    
    Throws:
    
    IllegalArgumentException - When one of the given values is invalid.
  - getMapArea
```
MapArea getMapArea()
```
    Returns the currently visible map area. Note that the returned area might be larger than the actual visible region due to an error introduced when trying to match a curved surface to a flat rectangle, e.g. when the full globe is visible.
    
    Since:
    
    11 (17.1 Viviani)
  - removeMarkers
```
void removeMarkers(long[] markerIds)
```
    Removes the given default Markers.
    
    Parameters:
    
    markerIds - array of marker's ids that will be deleted.
  - removeMarkers
```
void removeMarkers(long layerId,
                   long[] markersIds)
```
    Removes the given Markers from given layer with current ids.
    
    Parameters:
    
    layerId - layer's id from which markers will be deleted.
    
    markersIds - array of marker's ids that will be deleted.
  - getMarkerWithId
```
Marker getMarkerWithId(long id)
```
    Returns the Marker with the given ID. Will search through all layers to find it.
    
    Parameters:
    
    id - The ID of the Marker.
    
    Returns:
    
    The Marker with the given ID, or null if it does not exist.
  - createLayer
```
MarkerLayer createLayer()
```
    Creates a new MarkerLayer for the map.
    
    Returns:
    
    A valid MarkerLayer.
  - removeLayer
```
void removeLayer(MarkerLayer layer)
```
    Removes the given MarkerLayer from the map.
    
    Parameters:
    
    layer - The MarkerLayer to remove.
  - getLayers
```
List<MarkerLayer> getLayers()
```
    Returns the list of all MarkerLayer's that the map currently contains.
    
    Returns:
    
    The list of all MarkerLayer's.
  - getLayerWithId
```
MarkerLayer getLayerWithId(long id)
```
    Returns the MarkerLayer with the given ID.
    
    Parameters:
    
    id - The ID of the MarkerLayer.
    
    Returns:
    
    The MarkerLayer with the given ID, or null if it does not exist.
  - setLayerVisibility
```
void setLayerVisibility(MarkerLayer layer,
                        boolean show)
```
    Show or hide a specific layer.
    
    Parameters:
    
    layer - The MarkerLayer to change the visibility of.
    
    show - When true, the layer will be visible; when false the layer will be hidden.
  - setLayerVisibility
```
void setLayerVisibility(long layerId,
                        boolean show)
```
    Show or hide a specific layer, including StockLayers.
    
    Parameters:
    
    layerId - The id of the layer to change the visibility of. Can be one of the StockLayers values.
    
    show - When true, the layer will be visible; when false the layer will be hidden.
  - isLayerVisible
```
boolean isLayerVisible(MarkerLayer layer)
```
    Determine if a MarkerLayer is currently shown or not.
    
    Parameters:
    
    layer - The MarkerLayer to determine the visibility of.
    
    Returns:
    
    True if the layer is visible; false otherwise.
  - getLocationConverter
```
LocationConverter getLocationConverter()
```
    Returns:
    
    The LocationConverter that can be used with this MapController instance.
  - setSensorLocationEnabled
```
void setSensorLocationEnabled(boolean enable,
                              Drawable icon)
```
    Enable/disable sensor location.
    
    Parameters:
    
    enable - When true then map sensor location is enabled; when false, the matched location is used.
    
    icon - an icon to show sensor match. The icon must point to north, it will be rotated according to the heading when shown on the map.
  - isSensorLocationEnabled
```
boolean isSensorLocationEnabled()
```
    Check if map matched location enabled.
    
    Returns:
    
    True if the map matched location is enabled; false otherwise.
  - registerMapEventCallbacks
```
void registerMapEventCallbacks(MapEventCallbacks eventCallbacks)
```
    Register callbacks to be invoked on map events.
    
    Parameters:
    
    eventCallbacks - map callbacks
  - onResume
```
void onResume()
```
    Called when activity goes to active state.
  - onPause
```
void onPause()
```
    Called when activity goes to non-active state.
  - onDestroy
```
void onDestroy()
```
    Called when activity is being destroyed.
  - isMapReady
```
boolean isMapReady()
```
    Check if the map is ready to receive commands.
    
    Returns:
    
    true if map is ready.
  - getRenderableLayer
```
RenderableLayer getRenderableLayer()
```
    Gets the root RenderableLayer.
    
    Returns:
    
    RenderableLayer object or null if the overlay for drawing wasn't created.
  - setId
```
void setId(int id)
```
    Sets the identifier for this MapController.
    
    Parameters:
    
    id - a number used to identify the MapController. May not be zero.
  - getId
```
int getId()
```
    Returns:
    
    the ID of this MapController.
  - setMapScale
```
void setMapScale(int scale)
```
    Sets the map scale to an arbitrary value
    
    Parameters:
    
    scale - the value to set the map scale to. The less the value, the more the map would be zoomed in.
    
    Since:
    
    10 (16.6 Raphael)
  - getMapScale
```
int getMapScale()
```
    Returns:
    
    the current scale the map is zoomed to, with 1 meaning the map is at maximum zoom in level.
    
    Since:
    
    10 (16.6 Raphael)

Interface MapController

Nested Class Summary

Method Summary

Method Detail

setZoomEnabled

isZoomEnabled

getMinZoomLevel

getMaxZoomLevel

getZoomLevel

setZoomLevel

addOnZoomEnabledChangedListener

getMapCenter

setPanEnabled

isPanEnabled

addOnPanEnabledChangedListener

setAutoCenterEnabled

isAutoCenterEnabled

addOnAutoCenterChangedListener

setUserPanDisablesAutoCenterEnabled

isUserPanDisablesAutoCenterEnabled

setMapCenterToCurrentLocation

setMapCenter

setMapCenter

setMapArea

getMapArea

removeMarkers

removeMarkers

getMarkerWithId

createLayer

removeLayer

getLayers

getLayerWithId

setLayerVisibility

setLayerVisibility

isLayerVisible

getLocationConverter

setSensorLocationEnabled

isSensorLocationEnabled

registerMapEventCallbacks

onResume

onPause

onDestroy

isMapReady

getRenderableLayer

setId

getId

setMapScale

getMapScale