Map (vtm 0.6.0 API)

java.lang.Object
- org.oscim.map.Map

All Implemented Interfaces:: TaskQueue

public abstract class Map
extends java.lang.Object
implements TaskQueue

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Map.InputListener` Listener interface for input events.
`static interface`	`Map.UpdateListener` Listener interface for map update notifications.

Field Summary

Fields
Modifier and Type	Field and Description
`static Event`	`ANIM_END`
`static Event`	`ANIM_START`
`static Event`	`CLEAR_EVENT` UpdateListerner event.
`EventDispatcher<Map.UpdateListener,MapPosition>`	`events`
`EventDispatcher<Map.InputListener,MotionEvent>`	`input`
`protected Animator`	`mAnimator`
`protected boolean`	`mClearMap`
`protected MapEventLayer`	`mEventLayer`
`protected MapPosition`	`mMapPosition`
`static Event`	`MOVE_EVENT` UpdateListener event.
`static Event`	`POSITION_EVENT` UpdateListener event.
`static Event`	`UPDATE_EVENT` UpdateLister event.

Constructor Summary

Constructors
Constructor and Description

Map()

Constructors
Constructor and Description
`Map()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTask(java.lang.Runnable task)` Post a task to run on a shared worker-thread.
`Animator`	`animator()`
`abstract void`	`beginFrame()` Called on render thread, use synchronized!
`void`	`clearMap()` Request to clear all layers before rendering next frame
`void`	`destroy()`
`abstract void`	`doneFrame(boolean needsRedraw)` Called on render thread, use synchronized!
`BoundingBox`	`getBoundingBox(int expand)`
`MapEventLayer`	`getEventLayer()`
`abstract int`	`getHeight()` Return screen height in pixel.
`MapPosition`	`getMapPosition()` Get current `MapPosition`.
`boolean`	`getMapPosition(MapPosition mapPosition)` Get current `MapPosition`.
`abstract int`	`getWidth()` Return screen width in pixel.
`boolean`	`handleGesture(Gesture g, MotionEvent e)`
`Layers`	`layers()`
`abstract boolean`	`post(java.lang.Runnable action)` Post a runnable to be executed on main-thread
`abstract boolean`	`postDelayed(java.lang.Runnable action, long delay)` Post a runnable to be executed on main-thread.
`protected void`	`prepareFrame()` This function is run on main-thread before rendering a frame.
`abstract void`	`render()` Request to render a frame.
`TileLayer`	`setBaseMap(TileLayer tileLayer)`
`VectorTileLayer`	`setBaseMap(TileSource tileSource)` Create OsmTileLayer with given TileSource and set as base map (layer 1)
`void`	`setMapPosition(double latitude, double longitude, double scale)`
`void`	`setMapPosition(MapPosition mapPosition)` Set `MapPosition` of `Viewport` and trigger a redraw.
`void`	`setTheme(IRenderTheme theme)`
`void`	`setTheme(IRenderTheme theme, boolean allLayers)`
`void`	`setTheme(ThemeFile theme)` Utility function to set theme of base vector-layer and use map background color from theme.
`void`	`setTheme(ThemeFile theme, boolean allLayers)` Utility function to set theme of base vector-layer, optionally to all vector layers and use map background color from theme.
`abstract void`	`updateMap(boolean redraw)` Request call to onUpdate for all layers.
`ViewController`	`viewport()`

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

- Field Detail
  - POSITION_EVENT
```
public static final Event POSITION_EVENT
```
    UpdateListener event. Map position has changed.
  - MOVE_EVENT
```
public static final Event MOVE_EVENT
```
    UpdateListener event. Map was moved by user.
  - UPDATE_EVENT
```
public static final Event UPDATE_EVENT
```
    UpdateLister event. Delivered on main-thread when updateMap() was called and no CLEAR_EVENT or POSITION_EVENT was triggered.
  - CLEAR_EVENT
```
public static final Event CLEAR_EVENT
```
    UpdateListerner event. Map state has changed in a way that all layers should clear their state e.g. the theme or the TilesSource has changed. TODO should have an event-source to only clear affected layers.
  - ANIM_END
```
public static final Event ANIM_END
```
  - ANIM_START
```
public static final Event ANIM_START
```
  - input
```
public final EventDispatcher<Map.InputListener,MotionEvent> input
```
  - events
```
public final EventDispatcher<Map.UpdateListener,MapPosition> events
```
  - mAnimator
```
protected final Animator mAnimator
```
  - mMapPosition
```
protected final MapPosition mMapPosition
```
  - mEventLayer
```
protected final MapEventLayer mEventLayer
```
  - mClearMap
```
protected boolean mClearMap
```
- Constructor Detail
  - Map
```
public Map()
```
- Method Detail
  - getEventLayer
```
public MapEventLayer getEventLayer()
```
  - setBaseMap
```
public VectorTileLayer setBaseMap(TileSource tileSource)
```
    Create OsmTileLayer with given TileSource and set as base map (layer 1)
    TODO deprecate
  - setBaseMap
```
public TileLayer setBaseMap(TileLayer tileLayer)
```
  - setTheme
```
public void setTheme(ThemeFile theme)
```
    Utility function to set theme of base vector-layer and use map background color from theme.
  - setTheme
```
public void setTheme(ThemeFile theme,
                     boolean allLayers)
```
    Utility function to set theme of base vector-layer, optionally to all vector layers and use map background color from theme.
  - setTheme
```
public void setTheme(IRenderTheme theme)
```
  - setTheme
```
public void setTheme(IRenderTheme theme,
                     boolean allLayers)
```
  - destroy
```
public void destroy()
```
  - updateMap
```
public abstract void updateMap(boolean redraw)
```
    Request call to onUpdate for all layers. This function can be called from any thread. Request will be handled on main thread.
    
    Parameters:
    
    redraw - pass true to render next frame afterwards
  - render
```
public abstract void render()
```
    Request to render a frame. Request will be handled on main thread. Use this for animations in RenderLayers.
  - post
```
public abstract boolean post(java.lang.Runnable action)
```
    Post a runnable to be executed on main-thread
    
    Specified by:
    
    post in interface TaskQueue
  - postDelayed
```
public abstract boolean postDelayed(java.lang.Runnable action,
                                    long delay)
```
    Post a runnable to be executed on main-thread. Execution is delayed for at least 'delay' milliseconds.
  - addTask
```
public void addTask(java.lang.Runnable task)
```
    Post a task to run on a shared worker-thread. Should only use for tasks running less than a second.
    
    Specified by:
    
    addTask in interface TaskQueue
  - getWidth
```
public abstract int getWidth()
```
    Return screen width in pixel.
  - getHeight
```
public abstract int getHeight()
```
    Return screen height in pixel.
  - clearMap
```
public void clearMap()
```
    Request to clear all layers before rendering next frame
  - setMapPosition
```
public void setMapPosition(MapPosition mapPosition)
```
    Set MapPosition of Viewport and trigger a redraw.
  - setMapPosition
```
public void setMapPosition(double latitude,
                           double longitude,
                           double scale)
```
  - getMapPosition
```
public boolean getMapPosition(MapPosition mapPosition)
```
    Get current MapPosition.
    
    Returns:
    
    true when MapPosition was updated (has changed)
  - getMapPosition
```
public MapPosition getMapPosition()
```
    Get current MapPosition. Consider using getViewport.getMapPosition(pos) instead to reuse MapPosition instance.
  - getBoundingBox
```
public BoundingBox getBoundingBox(int expand)
```
  - viewport
```
public ViewController viewport()
```
    Returns:
    
    Viewport instance
  - layers
```
public Layers layers()
```
    Returns:
    
    Layers instance
  - animator
```
public Animator animator()
```
    Returns:
    
    MapAnimator instance
  - prepareFrame
```
protected void prepareFrame()
```
    This function is run on main-thread before rendering a frame.
    For internal use only. Do not call!
  - handleGesture
```
public boolean handleGesture(Gesture g,
                             MotionEvent e)
```
  - beginFrame
```
public abstract void beginFrame()
```
    Called on render thread, use synchronized!
  - doneFrame
```
public abstract void doneFrame(boolean needsRedraw)
```
    Called on render thread, use synchronized!

Class Map

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POSITION_EVENT

MOVE_EVENT

UPDATE_EVENT

CLEAR_EVENT

ANIM_END

ANIM_START

input

events

mAnimator

mMapPosition

mEventLayer

mClearMap

Constructor Detail

Map

Method Detail

getEventLayer

setBaseMap

setBaseMap

setTheme

setTheme

setTheme

setTheme

destroy

updateMap

render

post

postDelayed

addTask

getWidth

getHeight

clearMap

setMapPosition

setMapPosition

getMapPosition

getMapPosition

getBoundingBox

viewport

layers

animator

prepareFrame

handleGesture

beginFrame

doneFrame