MapView

java.lang.Object
- GLSurfaceView
- - us.ba3.me.MapView

```
public class MapView
extends GLSurfaceView
```
MapView is the primary way of interfacing with the Altus Mapping Engine. MapView extends GLSurfaceView, therefore, you must call onPause and onResume when your activity or view is paused or resumed. Also, on some devices, when paused / resumed you will need to re-add all maps and set all state as it was because the operating system may have destroyed the original OpenGL context and recreated it. You can extend MapView and override the function onSurfaceCreated if you need to know when this occurs. If you do override this method, call super.onSurfaceCreated prior to adding content to the map view so that it can create the necessary native objects behind the scenes.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CACHESIZE` Initial size of cache used for map assets.
`static boolean`	`CALL_EGL_DESTROYCONTEXT` Controls how the MapView's EGL factory responds to destroyContext requests from the operating system.
`static boolean`	`DEBUG` Controls display of OpenGL debug messages.
`static boolean`	`PRESERVE_GLCONTEXT_ONPAUSE` Controls whether or not the mapping engine asks the operating system to preserve its OpenGL context when paused.
`static int`	`TILESINFLIGHT` Controls the number of parallel requests the engine will make for raster, terrain, or vector tile data.

Constructor Summary

Constructors
Constructor and Description
`MapView(Context context)`
`MapView(Context context, AttributeSet attrs)`
`MapView(Context context, boolean translucent, int depth, int stencil)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addArrowPulse(ArrowPulse arrowPulse)` Adds an arrow pulse
`void`	`addCachedImage(java.lang.String imageName, Bitmap bitmap, boolean compressTexture)`
`void`	`addCachedPngImage(java.lang.String imageName, byte[] pngData, boolean compressTexture)` Add a png image to the internal cache.
`void`	`addDynamicLineToVectorMap(java.lang.String mapName, java.lang.String lineId, Location[] coordinates, LineStyle lineStyle)` Adds a dynamic line to a vector map.
`void`	`addDynamicMarkerToMap(java.lang.String mapName, DynamicMarker dynamicMarker)` Add a dynamic marker to a dynamic marker map.
`void`	`addHaloPulse(HaloPulse pulse)` Adds a halo pulse.
`void`	`addInternetMap(java.lang.String mapName, java.lang.String urlTemplate, java.lang.String subDomains, int maxLevel, int zOrder, int numWorkers, boolean useCache, boolean enableAlpha)` Add a map layer that is composed of spherical mercator projected tiles available on a web server.
`void`	`addLineToVectorMap(java.lang.String mapName, Location[] coordinates, LineStyle lineStyle)` Add a line (or path) to a dynamic vector map.
`void`	`addMap(java.lang.String mapName, java.lang.String mapSqliteFileName, java.lang.String mapDataFileName, boolean compressTextures)` Add a map layer to the current view.
`void`	`addMapUsingMapInfo(MapInfo mapInfo)` Adds a map layer whose type and properties are specified by a MapInfo object.
`void`	`addMBTilesMap(java.lang.String mapName, java.lang.String fileName, java.lang.String defaultTileName, ImageDataType imageDataType, boolean compressTextures, int zOrder, MapLoadingStrategy mapLoadingStrategy)` Adds an MBTiles raster map.
`void`	`addPolygonToVectorMap(java.lang.String mapName, Location[] coordinates, PolygonStyle style)` Add a polygon to a dynamic vector map.
`void`	`addPolygonToVectorMap(java.lang.String mapName, java.lang.String polygonId, Location[] coordinates, PolygonStyle style)` Add a polygon to a dynamic vector map.
`void`	`addReadyListener(ReadyListener newListener)`
`void`	`addVectorMap(java.lang.String mapName, java.lang.String mapSqliteFileName, java.lang.String mapDataFileName)` Add a vector map layer to the current view.
`void`	`clearDynamicGeometryFromMap(java.lang.String mapName)` Clears all dynamic lines and polygons from a vector map.
`PointF`	`convertCoordinate(Location coord)` Converts a Location to a screen point.
`void`	`createNativeObject()`
`void`	`destroyNativeObject(long nativeObjectHandle)`
`protected void`	`finalize()`
`double`	`getAltitude()` Returns the current view altitude in meters.
`Location`	`getCenterCoordinate()` Returns the geographic location that is currently at the center of the view.
`float`	`getDeviceScale()`
`Location3D`	`getLocation3D()` Returns the current 3D position of the virtual camera.
`void`	`getLocationForPoint(PointF point, ConvertPointCallback callback)` Converts a view point to a geographic location
`int`	`getterTest()`
`java.lang.String`	`getVersionHash()` Returns the version commit hash for this build of Altus.
`java.lang.String`	`getVersionTag()` Returns the version tag for this build of Altus.
`void`	`hideDynamicMarker(java.lang.String mapName, java.lang.String markerName)` Make a marker invisible
`boolean`	`onDown(MotionEvent arg0)`
`void`	`onDrawFrame(GL10 gl)`
`boolean`	`onFling(MotionEvent arg0, MotionEvent arg1, float arg2, float arg3)`
`void`	`onGLContextCreated(EGLContext glContext)`
`void`	`onGLContextDestroyed(EGLContext glContext)`
`void`	`onLongPress(MotionEvent arg0)`
`void`	`onNativeObjectCreated()`
`void`	`onNativeObjectDestroyed()`
`void`	`onPause()`
`void`	`onResume()`
`boolean`	`onScale(ScaleGestureDetector detector)`
`boolean`	`onScaleBegin(ScaleGestureDetector detector)`
`void`	`onScaleEnd(ScaleGestureDetector detector)`
`boolean`	`onScroll(MotionEvent arg0, MotionEvent arg1, float arg2, float arg3)`
`void`	`onShowPress(MotionEvent arg0)`
`boolean`	`onSingleTapUp(MotionEvent arg0)`
`void`	`onSurfaceChanged(GL10 gl, int width, int height)`
`void`	`onSurfaceCreated(GL10 gl, EGLConfig config)`
`boolean`	`onTouchEvent(MotionEvent event)`
`void`	`removeAllMaps(boolean clearCache)` Removes all maps currently displayed and optionally flushes the cache.
`void`	`removeArrowPulse(java.lang.String name)` Remove the arrow pulse
`void`	`removeDynamicMarkerFromMap(java.lang.String mapName, java.lang.String markerName)` Remove a marker
`void`	`removeHaloPulse(java.lang.String name)` Remove the animated vector circle.
`void`	`removeMap(java.lang.String mapName, boolean clearCache)` Remove a map layer from the current view and optionally clear the internal caches.
`void`	`setArrowPulseLocation(java.lang.String name, Location location)` Set the position of an arrow pulse
`void`	`setArrowPulseLocation(java.lang.String name, Location location, double animationDuration)` Set the position of an arrow pulse
`void`	`setBackgroundColor(int color)` Update background color of map view
`void`	`setCameraOrientation(double heading, double roll, double pitch, double animationDuration)` Sets the map view orientation
`void`	`setDynamicColorBarOffset(double offset)`
`void`	`setDynamicMarkerAnchorPoint(java.lang.String mapName, java.lang.String markerName, PointF anchorPoint)` Set a dynamic marker anchor point
`void`	`setDynamicMarkerImage(java.lang.String mapName, java.lang.String markerName, Bitmap bitmap)` Sets the image for the marker
`void`	`setDynamicMarkerLocation(java.lang.String mapName, java.lang.String markerName, Location location, double animationDuration)` Set a dynamic marker location.
`void`	`setDynamicMarkerMapColorBar(java.lang.String mapName, ColorBar colorBar)` A color bar applied to a marker map will multiply the color of the marker image by a color in the color map.
`void`	`setDynamicMarkerOffset(java.lang.String mapName, java.lang.String markerName, PointF offset)` Set a dynamic marker offset
`void`	`setDynamicMarkerRotation(java.lang.String mapName, java.lang.String markerName, double rotation, double animationDuration)` Set a dynamic marker rotation.
`void`	`setDynamicTerrainColorBar(ColorBar colorBar)`
`void`	`setHaloPulseLocation(java.lang.String name, Location location)` Set the position of the halo.
`void`	`setHaloPulseLocation(java.lang.String name, Location location, double animationDuration)` Set the position of the halo.
`void`	`setLicenseKey(java.lang.String licenseKey)` Set license key and disable BA3 watermark.
`void`	`setLineStyleOnVectorMap(java.lang.String mapName, int shapeId, LineStyle style)` Sets the vector style for a particular feature ID
`void`	`setLocation(Location location)` Sets the map view to center over the provided location.
`void`	`setLocation(Location location, double animationDuration)` Sets the map view to animate to the the provided location.
`void`	`setLocation3D(Location3D location)` Sets the map view to center over the provided location
`void`	`setLocation3D(Location3D location, double animationDuration)` Sets the map view to animate to the the provided location.
`void`	`setLocationThatFitsCoordinates(Location[] coordinates, double horizontalBuffer, double verticalBuffer)` Sets the map view to a location that contains all the coordinates
`void`	`setLocationThatFitsCoordinates(Location[] coordinates, double horizontalBuffer, double verticalBuffer, double animationDuration)` Sets the map view to animate to a location that contains all the coordinates
`void`	`setLocationThatFitsCoordinates(Location locationA, Location locationB, double horizontalBuffer, double verticalBuffer)` Sets the map view to a location that contains the 2 locations
`void`	`setLocationThatFitsCoordinates(Location locationA, Location locationB, double horizontalBuffer, double verticalBuffer, double animationDuration)` Sets the map view to animate to a location that contains the 2 locations
`void`	`setMapAlpha(java.lang.String mapName, float alpha)` Set the alpha value of a map layer.
`void`	`setMapZOrder(java.lang.String mapName, int zOrder)` Set the zorder value of a map layer
`void`	`setMarkerMapColorBar(java.lang.String mapName, ColorBar colorBar)` A color bar applied to a marker map will multiply the color of the marker image by a color in the color map.
`void`	`setMaximumZoom(double maxZoom)` Update maximum zoom size of map view
`void`	`setMaxTileRenderSize(int tileSize)` Sets the maximum tile size on screen.
`void`	`setMaxVirtualMapParentSearchDepth(int levels)` When a virtual map is displayed some tiles may be already cached and the search depth is how many levels lower than the target level to search for a tile in the cache to display when the target tile is not available.
`void`	`setMinimumZoom(double minZoom)` Update minimum zoom size of map view
`void`	`setMultithreaded(boolean multithreaded)` Toggles using single or multiple threads for threads managed by the map view
`void`	`setPanAcceleration(float panAcceleration)` After a pan gesture is complete this accleration is applied to the previous panVelocity
`void`	`setPanEnabled(boolean panEnabled)` Toggle whether or not panning gestures are processed.
`void`	`setPanVelocityScale(float panVelocityScale)` Scales pan velocity at small scales.
`void`	`setPolygonStyleOnVectorMap(java.lang.String mapName, int shapeId, PolygonStyle style)` Sets the vector style for a particular feature ID
`void`	`setRenderingThread(java.lang.Thread renderingThread)`
`void`	`setTerrainColorBar(ColorBar colorBar, int waterColor)` This color bar affects the color of all terrain maps.
`void`	`setTesselationThresholdForMap(java.lang.String mapName, float threshold)` Sets tesselation threshold for lines in nautical miles on dynamic vector maps.
`void`	`setTileLevelBias(float bias)` The tile level bias helps balance between a uniform level of tiles on screen vs maintaining the max tile specified by setMaxTileRenderSize.
`void`	`setTrackUp(boolean trackUpEnabled)` Enables or disables the map view to take into account the view heading.
`void`	`setTrackUpForwardDistance(double distance)` Set the point distance from the bottom of the view on which the virtual camera is centered in track-up mode.
`void`	`setTrackUpForwardDistance(double distance, double animationDuration)` Set the point distance from the bottom of the view on which the virtual camera is centered in track-up mode.
`void`	`setZoomEnabled(boolean zoomEnabled)` Disable zooming.
`void`	`showDynamicMarker(java.lang.String mapName, java.lang.String markerName)` Make a marker that was hidden now visible
`boolean`	`tileIsNeeded(TileProviderRequest tileRequest)` This function is reserved fo the TileFactor class.
`void`	`tileLoadComplete(TileProviderRequest request)` Called after a TileProvider tile request to add a tile to the mapView
`void`	`vectorTileLoadComplete(TileProviderRequest request, GeometryGroup geometryGroup)` Called after a TileProvider tile request to add a tile to the mapView

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEBUG
```
public static boolean DEBUG
```
    Controls display of OpenGL debug messages. The default is false. Set prior to creating instances of MapView.
  - PRESERVE_GLCONTEXT_ONPAUSE
```
public static boolean PRESERVE_GLCONTEXT_ONPAUSE
```
    Controls whether or not the mapping engine asks the operating system to preserve its OpenGL context when paused. The default is true. Set prior to creating instances of MapView
  - CACHESIZE
```
public static int CACHESIZE
```
    Initial size of cache used for map assets. The initial default is 90MB. Set to lower / higher before creating instances of MapView
  - TILESINFLIGHT
```
public static int TILESINFLIGHT
```
    Controls the number of parallel requests the engine will make for raster, terrain, or vector tile data. The default is 2. Set before creating instances of MapView
  - CALL_EGL_DESTROYCONTEXT
```
public static boolean CALL_EGL_DESTROYCONTEXT
```
    Controls how the MapView's EGL factory responds to destroyContext requests from the operating system. If set to true, we will destroy the context as requested, but this causes a SEG_FAULT on Nexus 7 2012 models. If set to false, we will ignore the request. In either case, we will assume our OpenGL context is not longer valid and we will delete all of our native objects and threads.
- Constructor Detail
  - MapView
```
public MapView(Context context)
```
  - MapView
```
public MapView(Context context,
       AttributeSet attrs)
```
  - MapView
```
public MapView(Context context,
       boolean translucent,
       int depth,
       int stencil)
```
- Method Detail
  - getVersionTag
```
public java.lang.String getVersionTag()
```
    Returns the version tag for this build of Altus.
    
    Returns:
    Version tag.
  - getVersionHash
```
public java.lang.String getVersionHash()
```
    Returns the version commit hash for this build of Altus.
    
    Returns:
  - onPause
```
public void onPause()
```
  - onResume
```
public void onResume()
```
  - onNativeObjectCreated
```
public void onNativeObjectCreated()
```
  - onNativeObjectDestroyed
```
public void onNativeObjectDestroyed()
```
  - createNativeObject
```
public void createNativeObject()
```
  - destroyNativeObject
```
public void destroyNativeObject(long nativeObjectHandle)
```
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Throws:
    
    java.lang.Throwable
  - onGLContextCreated
```
public void onGLContextCreated(EGLContext glContext)
```
  - onGLContextDestroyed
```
public void onGLContextDestroyed(EGLContext glContext)
```
  - onSurfaceChanged
```
public void onSurfaceChanged(GL10 gl,
                    int width,
                    int height)
```
  - onSurfaceCreated
```
public void onSurfaceCreated(GL10 gl,
                    EGLConfig config)
```
  - onDrawFrame
```
public void onDrawFrame(GL10 gl)
```
  - addReadyListener
```
public void addReadyListener(ReadyListener newListener)
```
  - setRenderingThread
```
public void setRenderingThread(java.lang.Thread renderingThread)
```
  - getterTest
```
public int getterTest()
```
  - getCenterCoordinate
```
public Location getCenterCoordinate()
```
    Returns the geographic location that is currently at the center of the view.
  - getAltitude
```
public double getAltitude()
```
    Returns the current view altitude in meters.
    
    Returns:
    the altitude of over the center of the view.
  - getLocation3D
```
public Location3D getLocation3D()
```
    Returns the current 3D position of the virtual camera. You can save this to later restore the view to the same location and altitude.
    
    Returns:
    the 3D position of the view
  - getLocationForPoint
```
public void getLocationForPoint(PointF point,
                       ConvertPointCallback callback)
```
    Converts a view point to a geographic location
    
    Parameters:
    point - a point in view space
    callback - called when the geographic location is computed
  - convertCoordinate
```
public PointF convertCoordinate(Location coord)
```
    Converts a Location to a screen point. NOTE: This call can block the main thread while waiting for a return value from the mapping engine.
    
    Parameters:
    coord - Location coordinate to convert
    
    Returns:
    Returns a screen point that represents the coordinate.
  - tileIsNeeded
```
public boolean tileIsNeeded(TileProviderRequest tileRequest)
```
    This function is reserved fo the TileFactor class.
    
    Parameters:
    tileRequest -
    
    Returns:
  - setBackgroundColor
```
public void setBackgroundColor(int color)
```
    Update background color of map view
    
    Parameters:
    color - Integer color in the format ARGB.
  - setMinimumZoom
```
public void setMinimumZoom(double minZoom)
```
    Update minimum zoom size of map view
    
    Parameters:
    minZoom - Double closest point camera/viewer can get to the map in meters
  - setMaximumZoom
```
public void setMaximumZoom(double maxZoom)
```
    Update maximum zoom size of map view
    
    Parameters:
    maximum - Double closest point camera/viewer can get to the map in meters
  - setPanEnabled
```
public void setPanEnabled(boolean panEnabled)
```
    Toggle whether or not panning gestures are processed.
    
    Parameters:
    panEnabled - boolean whether or not to enable panning
  - setZoomEnabled
```
public void setZoomEnabled(boolean zoomEnabled)
```
    Disable zooming. By default a zoom is a pinch gesture, double tap, or two finger tap
    
    Parameters:
    zoomEnabled -
  - setMaxVirtualMapParentSearchDepth
```
public void setMaxVirtualMapParentSearchDepth(int levels)
```
    When a virtual map is displayed some tiles may be already cached and the search depth is how many levels lower than the target level to search for a tile in the cache to display when the target tile is not available.
    
    Parameters:
    levels - Default is 5
  - setMultithreaded
```
public void setMultithreaded(boolean multithreaded)
```
    Toggles using single or multiple threads for threads managed by the map view
    
    Parameters:
    multithreaded - flag where true is multithreaded and false is singlethreaded.
  - setMaxTileRenderSize
```
public void setMaxTileRenderSize(int tileSize)
```
    Sets the maximum tile size on screen. This minimum tile size on screen is half of the max.
    
    Parameters:
    tileSize - size in dp. Default is 380.
  - setTileLevelBias
```
public void setTileLevelBias(float bias)
```
    The tile level bias helps balance between a uniform level of tiles on screen vs maintaining the max tile specified by setMaxTileRenderSize. A bias of 1 will attempt to move tiles up to one level towards the most common level for a particular view. In general this increases the number of tiles visible and memory usage for a tile map by a significant amount at small scales (when the view is zoomed out a significant ammount). With a bias of 0, traditional tiled raster maps with varied content per level can look odd at small scales because at one one view tiles of several different levels may be visible.
    
    Parameters:
    bias - Default is 1
  - setPanVelocityScale
```
public void setPanVelocityScale(float panVelocityScale)
```
    Scales pan velocity at small scales. At large scales panning locks to geographic position of finger location
    
    Parameters:
    panVelocityScale - Default is 1
  - setTerrainColorBar
```
public void setTerrainColorBar(ColorBar colorBar,
                      int waterColor)
```
    This color bar affects the color of all terrain maps. It is recommended you remove and add existing terrain maps and clearing the cache for that map when changing this property otherwise terrain tiles already cached will not reflect the new color bar.
    
    Parameters:
    colorBar - a map of height values to color values
    waterColor - the color for all water in the terrain map
  - setDynamicMarkerMapColorBar
```
public void setDynamicMarkerMapColorBar(java.lang.String mapName,
                               ColorBar colorBar)
```
    A color bar applied to a marker map will multiply the color of the marker image by a color in the color map. The marker weight is used as a key for the color bar to determine the color.
    
    Parameters:
    mapName - name of a marker map
    colorBar - a map of double values to color values
  - setMarkerMapColorBar
```
public void setMarkerMapColorBar(java.lang.String mapName,
                        ColorBar colorBar)
```
    A color bar applied to a marker map will multiply the color of the marker image by a color in the color map. The marker weight is used as a key for the color bar to determine the color.
    
    Parameters:
    mapName - name of a marker map
    colorBar - a map of double values to color values
  - setDynamicTerrainColorBar
```
public void setDynamicTerrainColorBar(ColorBar colorBar)
```
  - setDynamicColorBarOffset
```
public void setDynamicColorBarOffset(double offset)
```
  - addMap
```
public void addMap(java.lang.String mapName,
          java.lang.String mapSqliteFileName,
          java.lang.String mapDataFileName,
          boolean compressTextures)
```
    Add a map layer to the current view. The map must have been a map produced by the BA3 metool.
    
    Parameters:
    mapName - Unique name of the map for this view.
    mapSqliteFileName - The fully qualifed path/filename of the map's .sqlite file.
    mapDataFileName - The fully qualified path/filename of the map's .map data file.
    compressTextures - Whether or not raster data from the map should be compressed to 2-byte format internally.
  - addVectorMap
```
public void addVectorMap(java.lang.String mapName,
                java.lang.String mapSqliteFileName,
                java.lang.String mapDataFileName)
```
    Add a vector map layer to the current view. The map must have been a map produced by the BA3 metool.
    
    Parameters:
    mapName - Unique name of the map for this view.
    mapSqliteFileName - The fully qualified path/filename of the map's .sqlite file.
    mapDataFileName - The fully qualified path/filename of the map's .map data file.
  - addMBTilesMap
```
public void addMBTilesMap(java.lang.String mapName,
                 java.lang.String fileName,
                 java.lang.String defaultTileName,
                 ImageDataType imageDataType,
                 boolean compressTextures,
                 int zOrder,
                 MapLoadingStrategy mapLoadingStrategy)
```
    Adds an MBTiles raster map. Generally, these maps are produced with TileMill from MapBox. The map is added using an internal native tile provider path. Map bounds and maximum zoom level are read from the MBTiles database. Internally, the mapping engine will use a completely native tile provider to load tiles from the MBTiles database and no extra image memory copies are ever created. This is the fastest way possible to load an MBTiles map using the mapping engine.
    
    Parameters:
    mapName - Unique name of the map layer
    fileName - Fully qualified path to the mbtiles filename
    defaultTileName - The name of a cached image to use if waiting for tiles to load.
    imageDataType - Indicates whether the raster tiles are JPG or PNG
    compressTextures - YES to compress tile textures to a 2 byte format
    zOrder - Layer order for this map
    mapLoadingStrategy - Controls how tiles get loaded, kLowestDetailFirst will load tiles top down (less efficient but better user experience, kHighestDetailOnly will load only tiles at the current zoom level, faster)
  - addInternetMap
```
public void addInternetMap(java.lang.String mapName,
                  java.lang.String urlTemplate,
                  java.lang.String subDomains,
                  int maxLevel,
                  int zOrder,
                  int numWorkers,
                  boolean useCache,
                  boolean enableAlpha)
```
    Add a map layer that is composed of spherical mercator projected tiles available on a web server. Map tiles will be downloaded and saved to the application cache directory/mapName as individual files. Under the hood, the mapping engine is creating a virtual map layer, and using an instance of us.ba3.me.virtualmaps.TileFactory as the TileProvider for the virtual map. The TileFactory will use up to numWorkers TileDownlaoder tile workers. This simple approach will work with internet-based maps from a variety of map sources.
    
    Parameters:
    mapName - Unique name of the map for this view.
    urlTemplate - A URL template that will be used to construct final URLs for image downloading. For example: http://{s}.tiles.mapbox.com/v3/dxjacob.ho6k3ag9/{z}/{x}/{y}.jpg Where {s} will be the subdomain (i.e. a, b, c, or d, etc.) and {z}, {x}, and {y} will be replaced with spherical mercator tile tree numbers respectively.
    subDomains - A comma separate list of sub-domains (i.e. "a,b,c,d")
    zOrder - Layer order for the map
    numWorkers - the number of parallel workers to create (don't make this high, try 3 or so)
    useCache - If true try reading from the cache, if false, ignore the cache.
    enableAlpha - If true, the map is comprised of tiles that may not be fully opaque (like a weather overlay)
  - addMapUsingMapInfo
```
public void addMapUsingMapInfo(MapInfo mapInfo)
```
    Adds a map layer whose type and properties are specified by a MapInfo object.
    
    Parameters:
    mapInfo - An MapInfo object or MapInfo derived object that specifies the map type and properties.
  - removeMap
```
public void removeMap(java.lang.String mapName,
             boolean clearCache)
```
    Remove a map layer from the current view and optionally clear the internal caches. If caches are not cleared, and you re-enable the same map at a future point, cached data 'may' be used to draw the map. If you choose to clear the cache, the engine will re-request all map data if you later re-add that map. Whether or not you want to flush the cache depends on your scenario. For example, if your application has downloaded an updated map, you would want to remove the existing one and clear its data from the cache. If the user is just toggling a map on and off, you would not want to clear it data from the cache the cache.
    
    Parameters:
    mapName - The name of the map file (or layer name).
    clearCache - A boolean value that indicates whether or not to flush the map's data from the cache.
  - removeAllMaps
```
public void removeAllMaps(boolean clearCache)
```
    Removes all maps currently displayed and optionally flushes the cache.
    
    Parameters:
    clearCache - True to clear cache.
  - setMapAlpha
```
public void setMapAlpha(java.lang.String mapName,
               float alpha)
```
    Set the alpha value of a map layer.
    
    Parameters:
    mapName - The name of the map file wihout the file extension.
    alpha - Value to set alpha to. Range is 0 to 1.
  - setMapZOrder
```
public void setMapZOrder(java.lang.String mapName,
                int zOrder)
```
    Set the zorder value of a map layer
    
    Parameters:
    mapName - The name of the map.
    zOrder - Value to set the zorder to.
  - addCachedPngImage
```
public void addCachedPngImage(java.lang.String imageName,
                     byte[] pngData,
                     boolean compressTexture)
```
    Add a png image to the internal cache.
    
    Parameters:
    imageName - Unique name of cached image
    pngData - Bytes that represent the png file.
    compressTexture - Whether or not to internally compress the image data to a 2-byte format.
  - addCachedImage
```
public void addCachedImage(java.lang.String imageName,
                  Bitmap bitmap,
                  boolean compressTexture)
```
  - tileLoadComplete
```
public void tileLoadComplete(TileProviderRequest request)
```
    Called after a TileProvider tile request to add a tile to the mapView
    
    Parameters:
    request - must be an object from a previous TileProvider requestTile method call
  - vectorTileLoadComplete
```
public void vectorTileLoadComplete(TileProviderRequest request,
                          GeometryGroup geometryGroup)
```
    Called after a TileProvider tile request to add a tile to the mapView
    
    Parameters:
    request - must be an object from a previous TileProvider requestTile method call
    geometry - polygons and lines for the tiles
  - addDynamicMarkerToMap
```
public void addDynamicMarkerToMap(java.lang.String mapName,
                         DynamicMarker dynamicMarker)
```
    Add a dynamic marker to a dynamic marker map.
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    dynamicMarker - Object that fully describes the dynamic marker. Either uiImage or cachedImageName MUST be set.
  - removeDynamicMarkerFromMap
```
public void removeDynamicMarkerFromMap(java.lang.String mapName,
                              java.lang.String markerName)
```
    Remove a marker
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker.
  - setDynamicMarkerImage
```
public void setDynamicMarkerImage(java.lang.String mapName,
                         java.lang.String markerName,
                         Bitmap bitmap)
```
    Sets the image for the marker
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker to be updated.
    bitmap -
  - setDynamicMarkerAnchorPoint
```
public void setDynamicMarkerAnchorPoint(java.lang.String mapName,
                               java.lang.String markerName,
                               PointF anchorPoint)
```
    Set a dynamic marker anchor point
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker to be updated.
    anchorPoint - center of rotation in the marker image in pixels. An anchor point of (0,0) would rotate around the bottom left of the image
  - setDynamicMarkerOffset
```
public void setDynamicMarkerOffset(java.lang.String mapName,
                          java.lang.String markerName,
                          PointF offset)
```
    Set a dynamic marker offset
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker to be updated.
    offset - offset in pixels to be applied after rotation. If the rotation is 0, and offset of (10,10) is equivalent to an anchor point of (10,10).
  - setDynamicMarkerLocation
```
public void setDynamicMarkerLocation(java.lang.String mapName,
                            java.lang.String markerName,
                            Location location,
                            double animationDuration)
```
    Set a dynamic marker location.
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker to be updated.
    location - New location for the marker.
    animationDuration - Amount of time to animate marker to new location.
  - setDynamicMarkerRotation
```
public void setDynamicMarkerRotation(java.lang.String mapName,
                            java.lang.String markerName,
                            double rotation,
                            double animationDuration)
```
    Set a dynamic marker rotation.
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker to be updated.
    rotation - New rotation for the marker.
    animationDuration - Amount of time to animate marker to new location.
  - showDynamicMarker
```
public void showDynamicMarker(java.lang.String mapName,
                     java.lang.String markerName)
```
    Make a marker that was hidden now visible
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker to be made visible.
  - hideDynamicMarker
```
public void hideDynamicMarker(java.lang.String mapName,
                     java.lang.String markerName)
```
    Make a marker invisible
    
    Parameters:
    mapName - Unique name of the dynamic marker map layer.
    markerName - Unique name of the marker to be hidden.
  - addHaloPulse
```
public void addHaloPulse(HaloPulse pulse)
```
    Adds a halo pulse. This can be used for pulsating location beacons.
    
    Parameters:
    pulse - Describes the style and animation properties of the halo.
  - setHaloPulseLocation
```
public void setHaloPulseLocation(java.lang.String name,
                        Location location)
```
    Set the position of the halo.
    
    Parameters:
    name - The name of the halo
    location - location of the halo.
  - setHaloPulseLocation
```
public void setHaloPulseLocation(java.lang.String name,
                        Location location,
                        double animationDuration)
```
    Set the position of the halo.
    
    Parameters:
    name - The name of the halo
    location - location of the halo.
    animationDuration - If non-zero, the number of seconds to make it to its new position.
  - removeHaloPulse
```
public void removeHaloPulse(java.lang.String name)
```
    Remove the animated vector circle.
    
    Parameters:
    name - The name of the vector circle.
  - addArrowPulse
```
public void addArrowPulse(ArrowPulse arrowPulse)
```
    Adds an arrow pulse
    
    Parameters:
    arrowPulse - Describes the style and animation properties
  - setArrowPulseLocation
```
public void setArrowPulseLocation(java.lang.String name,
                         Location location)
```
    Set the position of an arrow pulse
    
    Parameters:
    name - The name of the pulse.
    location - center position
  - setArrowPulseLocation
```
public void setArrowPulseLocation(java.lang.String name,
                         Location location,
                         double animationDuration)
```
    Set the position of an arrow pulse
    
    Parameters:
    name - The name of the pulse.
    location - center position
    animationDuration - If non-zero, the number of seconds to make it to its new position.
  - removeArrowPulse
```
public void removeArrowPulse(java.lang.String name)
```
    Remove the arrow pulse
    
    Parameters:
    name - The name of the pulse.
  - setLineStyleOnVectorMap
```
public void setLineStyleOnVectorMap(java.lang.String mapName,
                           int shapeId,
                           LineStyle style)
```
    Sets the vector style for a particular feature ID
    
    Parameters:
    mapName - name of the vector map
    shapeId - same id set in Line or Polygon
    style - line style properties
  - setPolygonStyleOnVectorMap
```
public void setPolygonStyleOnVectorMap(java.lang.String mapName,
                              int shapeId,
                              PolygonStyle style)
```
    Sets the vector style for a particular feature ID
    
    Parameters:
    mapName - name of the vector map
    shapeId - same id set in Line or Polygon
    style - polygon style properties
  - addPolygonToVectorMap
```
public void addPolygonToVectorMap(java.lang.String mapName,
                         java.lang.String polygonId,
                         Location[] coordinates,
                         PolygonStyle style)
```
    Add a polygon to a dynamic vector map.
    
    Parameters:
    mapName - The name of the dynamic vector map to add the polygon to.
    polygonId - An identifier for the polygon which will be returned if polygon hit testing is enabled.
    coordinates - Closed loop of coordinates.
    style - Describes how to render the polygon.
  - addPolygonToVectorMap
```
public void addPolygonToVectorMap(java.lang.String mapName,
                         Location[] coordinates,
                         PolygonStyle style)
```
    Add a polygon to a dynamic vector map.
    
    Parameters:
    mapName - The name of the dynamic vector map to add the polygon to.
    coordinates - Closed loop of coordinates.
    style - Describes how to render the polygon.
  - addLineToVectorMap
```
public void addLineToVectorMap(java.lang.String mapName,
                      Location[] coordinates,
                      LineStyle lineStyle)
```
    Add a line (or path) to a dynamic vector map.
    
    Parameters:
    mapName - The name of the dynamic vector map to add the line to.
    coordiantes -
    lineStyle - Describes How to render the line.
  - addDynamicLineToVectorMap
```
public void addDynamicLineToVectorMap(java.lang.String mapName,
                             java.lang.String lineId,
                             Location[] coordinates,
                             LineStyle lineStyle)
```
    Adds a dynamic line to a vector map.
    
    Parameters:
    mapName - The name of the vector map.
    coordiantes -
    style - The style of the polygon.
  - clearDynamicGeometryFromMap
```
public void clearDynamicGeometryFromMap(java.lang.String mapName)
```
    Clears all dynamic lines and polygons from a vector map.
    
    Parameters:
    mapName - The name of the vector map.
  - setTesselationThresholdForMap
```
public void setTesselationThresholdForMap(java.lang.String mapName,
                                 float threshold)
```
    Sets tesselation threshold for lines in nautical miles on dynamic vector maps.
    
    Parameters:
    mapName - The name of the vector map.
    threshold - The minimum distance in nautical miles between vertices for computed lines.
  - setLocation
```
public void setLocation(Location location)
```
    Sets the map view to center over the provided location. The current camera zoom or altitude remains the same.
    
    Parameters:
    location -
  - setLocation
```
public void setLocation(Location location,
               double animationDuration)
```
    Sets the map view to animate to the the provided location. The current camera zoom or altitude remains the same.
    
    Parameters:
    location -
    animationDuration - duration in seconds
  - setLocation3D
```
public void setLocation3D(Location3D location)
```
    Sets the map view to center over the provided location
    
    Parameters:
    location -
  - setLocation3D
```
public void setLocation3D(Location3D location,
                 double animationDuration)
```
    Sets the map view to animate to the the provided location.
    
    Parameters:
    location -
    animationDuration - duration in seconds
  - setLocationThatFitsCoordinates
```
public void setLocationThatFitsCoordinates(Location[] coordinates,
                                  double horizontalBuffer,
                                  double verticalBuffer)
```
    Sets the map view to a location that contains all the coordinates
    
    Parameters:
    coordinates -
    horizontalBuffer - buffer in pixels from the left and right edge of the screen to the nearest provided coordinate
    verticalBuffer - buffer in pixels from the top and bottom edge of the screen to the nearest provided coordinate
  - setLocationThatFitsCoordinates
```
public void setLocationThatFitsCoordinates(Location[] coordinates,
                                  double horizontalBuffer,
                                  double verticalBuffer,
                                  double animationDuration)
```
    Sets the map view to animate to a location that contains all the coordinates
    
    Parameters:
    coordinates -
    horizontalBuffer - buffer in pixels from the left and right edge of the screen to the nearest provided coordinate
    verticalBuffer - buffer in pixels from the top and bottom edge of the screen to the nearest provided coordinate
    animationDuration - duration in seconds
  - setLocationThatFitsCoordinates
```
public void setLocationThatFitsCoordinates(Location locationA,
                                  Location locationB,
                                  double horizontalBuffer,
                                  double verticalBuffer)
```
    Sets the map view to a location that contains the 2 locations
    
    Parameters:
    locationA -
    locationB -
    horizontalBuffer - buffer in pixels from the left and right edge of the screen to the nearest provided coordinate
    verticalBuffer - buffer in pixels from the top and bottom edge of the screen to the nearest provided coordinate
  - setLocationThatFitsCoordinates
```
public void setLocationThatFitsCoordinates(Location locationA,
                                  Location locationB,
                                  double horizontalBuffer,
                                  double verticalBuffer,
                                  double animationDuration)
```
    Sets the map view to animate to a location that contains the 2 locations
    
    Parameters:
    locationA -
    locationB -
    horizontalBuffer - buffer in pixels from the left and right edge of the screen to the nearest provided coordinate
    verticalBuffer - buffer in pixels from the top and bottom edge of the screen to the nearest provided coordinate
    animationDuration - duration in seconds
  - setCameraOrientation
```
public void setCameraOrientation(double heading,
                        double roll,
                        double pitch,
                        double animationDuration)
```
    Sets the map view orientation
    
    Parameters:
    heading - in degrees. Default is 0 (North)
    roll - in degrees
    pitch - in degrees
    animationDuration - in seconds
  - setTrackUp
```
public void setTrackUp(boolean trackUpEnabled)
```
    Enables or disables the map view to take into account the view heading. If disabled, the current heading is maintained but map view is displayed as if N is always pointed towards the top of the screen.
    
    Parameters:
    trackUpEnabled -
  - setTrackUpForwardDistance
```
public void setTrackUpForwardDistance(double distance)
```
    Set the point distance from the bottom of the view on which the virtual camera is centered in track-up mode.
    
    Parameters:
    distance - in dp (Density-Independent Pixels)
  - setTrackUpForwardDistance
```
public void setTrackUpForwardDistance(double distance,
                             double animationDuration)
```
    Set the point distance from the bottom of the view on which the virtual camera is centered in track-up mode.
    
    Parameters:
    distance - in dp (Density-Independent Pixels)
    animationDuration - in seconds
  - setLicenseKey
```
public void setLicenseKey(java.lang.String licenseKey)
```
    Set license key and disable BA3 watermark.
    
    Parameters:
    licenseKeyString -
  - setPanAcceleration
```
public void setPanAcceleration(float panAcceleration)
```
    After a pan gesture is complete this accleration is applied to the previous panVelocity
    
    Parameters:
    accleration - Default is -1
  - getDeviceScale
```
public float getDeviceScale()
```
  - onTouchEvent
```
public boolean onTouchEvent(MotionEvent event)
```
  - onDown
```
public boolean onDown(MotionEvent arg0)
```
  - onFling
```
public boolean onFling(MotionEvent arg0,
              MotionEvent arg1,
              float arg2,
              float arg3)
```
  - onLongPress
```
public void onLongPress(MotionEvent arg0)
```
  - onScroll
```
public boolean onScroll(MotionEvent arg0,
               MotionEvent arg1,
               float arg2,
               float arg3)
```
  - onShowPress
```
public void onShowPress(MotionEvent arg0)
```
  - onSingleTapUp
```
public boolean onSingleTapUp(MotionEvent arg0)
```
  - onScaleBegin
```
public boolean onScaleBegin(ScaleGestureDetector detector)
```
  - onScale
```
public boolean onScale(ScaleGestureDetector detector)
```
  - onScaleEnd
```
public void onScaleEnd(ScaleGestureDetector detector)
```

Class MapView

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG

PRESERVE_GLCONTEXT_ONPAUSE

CACHESIZE

TILESINFLIGHT

CALL_EGL_DESTROYCONTEXT

Constructor Detail

MapView

MapView

MapView

Method Detail

getVersionTag

getVersionHash

onPause

onResume

onNativeObjectCreated

onNativeObjectDestroyed

createNativeObject

destroyNativeObject

finalize

onGLContextCreated

onGLContextDestroyed

onSurfaceChanged

onSurfaceCreated

onDrawFrame

addReadyListener

setRenderingThread

getterTest

getCenterCoordinate

getAltitude

getLocation3D

getLocationForPoint

convertCoordinate

tileIsNeeded

setBackgroundColor

setMinimumZoom

setMaximumZoom

setPanEnabled

setZoomEnabled

setMaxVirtualMapParentSearchDepth

setMultithreaded

setMaxTileRenderSize

setTileLevelBias

setPanVelocityScale

setTerrainColorBar

setDynamicMarkerMapColorBar

setMarkerMapColorBar

setDynamicTerrainColorBar

setDynamicColorBarOffset

addMap

addVectorMap

addMBTilesMap

addInternetMap

addMapUsingMapInfo

removeMap

removeAllMaps

setMapAlpha

setMapZOrder

addCachedPngImage

addCachedImage

tileLoadComplete

vectorTileLoadComplete

addDynamicMarkerToMap

removeDynamicMarkerFromMap

setDynamicMarkerImage

setDynamicMarkerAnchorPoint

setDynamicMarkerOffset

setDynamicMarkerLocation

setDynamicMarkerRotation

showDynamicMarker

hideDynamicMarker

addHaloPulse

setHaloPulseLocation

setHaloPulseLocation

removeHaloPulse