Overlay (osmdroid-android 6.1.1 API)

java.lang.Object
- org.osmdroid.views.overlay.Overlay

All Implemented Interfaces:

OverlayConstants

Direct Known Subclasses:

CompassOverlay, CopyrightOverlay, DirectedLocationOverlay, FolderOverlay, GroundOverlay, GroundOverlay2, GroundOverlay4, IconOverlay, ItemizedOverlay, LatLonGridlineOverlay2, MapEventsOverlay, MyLocationNewOverlay, NonAcceleratedOverlay, OverlayWithIW, PathOverlay, RotationGestureOverlay, ScaleBarOverlay, ScaleDiskOverlay, SimpleFastPointOverlay, SimpleLocationOverlay, SpeechBalloonOverlay, TilesOverlay
```
public abstract class Overlay
extends Object
implements OverlayConstants
```
Overlay: Base class representing an overlay which may be displayed on top of a MapView. To add an overlay, subclass this class, create an instance, and add it to the list obtained from getOverlays() of MapView. This class implements a form of Gesture Handling similar to GestureDetector.SimpleOnGestureListener and GestureDetector.OnGestureListener. The difference is there is an additional argument for the item.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Overlay.Snappable` Interface definition for overlays that contain items that can be snapped to (for example, when the user invokes a zoom, this could be called allowing the user to snap the zoom to an interesting point.)

Field Summary

Fields
Modifier and Type Field and Description

protected BoundingBox mBounds

protected static float SHADOW_X_SKEW

protected static float SHADOW_Y_SCALE
- Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants
  DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Fields
Modifier and Type	Field and Description
`protected BoundingBox`	`mBounds`
`protected static float`	`SHADOW_X_SKEW`
`protected static float`	`SHADOW_Y_SCALE`

Constructor Summary

Constructors
Constructor and Description

Overlay()

Overlay(Context ctx)
Deprecated.

Constructors
Constructor and Description
`Overlay()`
`Overlay(Context ctx)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(Canvas pCanvas, MapView pMapView, boolean pShadow)` Draw the overlay over the map.
`void`	`draw(Canvas pCanvas, Projection pProjection)`
`protected static void`	`drawAt(Canvas canvas, Drawable drawable, int x, int y, boolean shadow, float aMapOrientation)` Convenience method to draw a Drawable at an offset.
`BoundingBox`	`getBounds()` Gets the bounds of the overlay, useful for skipping draw cycles on overlays that are not in the current bounding box of the view
`protected static int`	`getSafeMenuId()` Since the menu-chain will pass through several independent Overlays, menu IDs cannot be fixed at compile time.
`protected static int`	`getSafeMenuIdSequence(int count)` Similar to `getSafeMenuId()`, except this reserves a sequence of IDs of length `count`.
`boolean`	`isEnabled()` Specifies if the Overlay is marked to be enabled.
`void`	`onDetach(MapView mapView)` Override to perform clean up of resources before shutdown.
`boolean`	`onDoubleTap(MotionEvent e, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onDoubleTapEvent(MotionEvent e, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onDown(MotionEvent e, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onFling(MotionEvent pEvent1, MotionEvent pEvent2, float pVelocityX, float pVelocityY, MapView pMapView)` By default does nothing (`return false`).
`boolean`	`onKeyDown(int keyCode, KeyEvent event, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onKeyUp(int keyCode, KeyEvent event, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onLongPress(MotionEvent e, MapView mapView)` By default does nothing (`return false`).
`void`	`onPause()` Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806
`void`	`onResume()` Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806
`boolean`	`onScroll(MotionEvent pEvent1, MotionEvent pEvent2, float pDistanceX, float pDistanceY, MapView pMapView)` By default does nothing (`return false`).
`void`	`onShowPress(MotionEvent pEvent, MapView pMapView)`
`boolean`	`onSingleTapConfirmed(MotionEvent e, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onSingleTapUp(MotionEvent e, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onTouchEvent(MotionEvent event, MapView mapView)` You can prevent all(!) other Touch-related events from happening! By default does nothing (`return false`).
`boolean`	`onTrackballEvent(MotionEvent event, MapView mapView)` By default does nothing (`return false`).
`void`	`setEnabled(boolean pEnabled)` Sets whether the Overlay is marked to be enabled.

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

- Field Detail
  - SHADOW_X_SKEW
```
protected static final float SHADOW_X_SKEW
```
    See Also:
    
    Constant Field Values
  - SHADOW_Y_SCALE
```
protected static final float SHADOW_Y_SCALE
```
    See Also:
    
    Constant Field Values
  - mBounds
```
protected BoundingBox mBounds
```
- Constructor Detail
  - Overlay
```
@Deprecated
public Overlay(Context ctx)
```
    Deprecated.
    
    Use Overlay() instead
  - Overlay
```
public Overlay()
```
- Method Detail
  - getBounds
```
public BoundingBox getBounds()
```
    Gets the bounds of the overlay, useful for skipping draw cycles on overlays that are not in the current bounding box of the view
    
    Returns:
    
    Since:
    
    6.0.0
  - setEnabled
```
public void setEnabled(boolean pEnabled)
```
    Sets whether the Overlay is marked to be enabled. This setting does nothing by default, but should be checked before calling draw().
  - isEnabled
```
public boolean isEnabled()
```
    Specifies if the Overlay is marked to be enabled. This should be checked before calling draw().
    
    Returns:
    
    true if the Overlay is marked enabled, false otherwise
  - getSafeMenuId
```
protected static final int getSafeMenuId()
```
    Since the menu-chain will pass through several independent Overlays, menu IDs cannot be fixed at compile time. Overlays should use this method to obtain and store a menu id for each menu item at construction time. This will ensure that two overlays don't use the same id.
    
    Returns:
    
    an integer suitable to be used as a menu identifier
  - getSafeMenuIdSequence
```
protected static final int getSafeMenuIdSequence(int count)
```
    Similar to getSafeMenuId(), except this reserves a sequence of IDs of length count. The returned number is the starting index of that sequential list.
    
    Returns:
    
    an integer suitable to be used as a menu identifier
    
    See Also:
    
    getSafeMenuId()
  - draw
```
public void draw(Canvas pCanvas,
                 MapView pMapView,
                 boolean pShadow)
```
    Draw the overlay over the map. This will be called on all active overlays with shadow=true, to lay down the shadow layer, and then again on all overlays with shadow=false. Callers should check isEnabled() before calling draw(). By default, draws nothing. changed for 5.6 to be public see https://github.com/osmdroid/osmdroid/issues/466 If possible, use draw(Canvas, Projection) instead (cf. MapSnapshot
  - draw
```
public void draw(Canvas pCanvas,
                 Projection pProjection)
```
    Since:
    
    6.1.0
  - onDetach
```
public void onDetach(MapView mapView)
```
    Override to perform clean up of resources before shutdown. By default does nothing.
  - onKeyDown
```
public boolean onKeyDown(int keyCode,
                         KeyEvent event,
                         MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onKeyUp
```
public boolean onKeyUp(int keyCode,
                       KeyEvent event,
                       MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onTouchEvent
```
public boolean onTouchEvent(MotionEvent event,
                            MapView mapView)
```
    You can prevent all(!) other Touch-related events from happening!
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onTrackballEvent
```
public boolean onTrackballEvent(MotionEvent event,
                                MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onDoubleTap
```
public boolean onDoubleTap(MotionEvent e,
                           MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onDoubleTapEvent
```
public boolean onDoubleTapEvent(MotionEvent e,
                                MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onSingleTapConfirmed
```
public boolean onSingleTapConfirmed(MotionEvent e,
                                    MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onDown
```
public boolean onDown(MotionEvent e,
                      MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onFling
```
public boolean onFling(MotionEvent pEvent1,
                       MotionEvent pEvent2,
                       float pVelocityX,
                       float pVelocityY,
                       MapView pMapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onLongPress
```
public boolean onLongPress(MotionEvent e,
                           MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onScroll
```
public boolean onScroll(MotionEvent pEvent1,
                        MotionEvent pEvent2,
                        float pDistanceX,
                        float pDistanceY,
                        MapView pMapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - onShowPress
```
public void onShowPress(MotionEvent pEvent,
                        MapView pMapView)
```
  - onSingleTapUp
```
public boolean onSingleTapUp(MotionEvent e,
                             MapView mapView)
```
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
  - drawAt
```
protected static void drawAt(Canvas canvas,
                             Drawable drawable,
                             int x,
                             int y,
                             boolean shadow,
                             float aMapOrientation)
```
    Convenience method to draw a Drawable at an offset. x and y are pixel coordinates. You can find appropriate coordinates from latitude/longitude using the MapView.getProjection() method on the MapView passed to you in draw(Canvas, MapView, boolean).
    
    Parameters:
    
    shadow - If true, draw only the drawable's shadow. Otherwise, draw the drawable itself.
    
    aMapOrientation -
  - onPause
```
public void onPause()
```
    Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806
    
    Since:
    
    6.0.0
  - onResume
```
public void onResume()
```
    Triggered on application lifecycle changes, assuming the mapview is triggered appropriately related issue https://github.com/osmdroid/osmdroid/issues/823 https://github.com/osmdroid/osmdroid/issues/806
    
    Since:
    
    6.0.0

Class Overlay

Nested Class Summary

Field Summary

Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHADOW_X_SKEW

SHADOW_Y_SCALE

mBounds

Constructor Detail

Overlay

Overlay

Method Detail

getBounds

setEnabled

isEnabled

getSafeMenuId

getSafeMenuIdSequence

draw

draw

onDetach

onKeyDown

onKeyUp

onTouchEvent

onTrackballEvent

onDoubleTap

onDoubleTapEvent

onSingleTapConfirmed

onDown

onFling

onLongPress

onScroll

onShowPress

onSingleTapUp

drawAt

onPause

onResume