org.osmdroid.views.overlay

Class Polyline

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.OverlayWithIW

org.osmdroid.views.overlay.Polyline

All Implemented Interfaces:

OverlayConstants

public class Polyline
extends OverlayWithIW

A polyline is a list of points, where line segments are drawn between consecutive points. Mimics the Polyline class from Google Maps Android API v2 as much as possible. Main differences:
- Doesn't support Z-Index: drawing order is the order in map overlays
- Supports InfoWindow (must be a BasicInfoWindow).

Mimics the Polyline class from Google Maps Android API v2 as much as possible. Main differences:
- Doesn't support Z-Index: drawing order is the order in map overlays
- Supports InfoWindow (must be a BasicInfoWindow).

See Also:

Google Maps Polyline

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Polyline.OnClickListener

Nested classes/interfaces inherited from class org.osmdroid.views.overlay.Overlay

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected static InfoWindow	mDefaultInfoWindow
protected Polyline.OnClickListener	mOnClickListener

Fields inherited from class org.osmdroid.views.overlay.OverlayWithIW

mInfoWindow, mRelatedObject, mSnippet, mSubDescription, mTitle

Fields inherited from class org.osmdroid.views.overlay.Overlay

mBounds, SHADOW_X_SKEW, SHADOW_Y_SCALE

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

DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Constructor Summary

Constructors

Constructor and Description
Polyline() highly suggested that you provide context, if MapView is not provided or is null info window popups will not function unless you handle it yourself
Polyline(MapView mapView) highly suggested that you provide MapView , if MapView is not provided or is null info window popups will not function unless you handle it yourself

Method Summary

Modifier and Type	Method and Description
protected void	addGreatCircle(GeoPoint startPoint, GeoPoint endPoint, int numberOfPoints)
protected void	addPoint(GeoPoint aPoint)
protected void	addPoint(int aLatitudeE6, int aLongitudeE6) Deprecated.
protected void	clearPath()
void	draw(Canvas canvas, MapView mapView, boolean shadow) Draw the overlay over the map.
int	getColor()
String	getId()
GeoPoint	getInfoWindowAnchorPoint(GeoPoint eventPos) returns a point that the info window cartoon bubble will point at.
int	getNumberOfPoints()
Paint	getPaint()
List<GeoPoint>	getPoints()
float	getWidth()
boolean	isCloseTo(GeoPoint point, double tolerance, MapView mapView) Detection is done is screen coordinates.
boolean	isGeodesic()
boolean	isVisible()
protected boolean	onClickDefault(Polyline polyline, MapView mapView, GeoPoint eventPos) default behaviour when no click listener is set
void	onDetach(MapView mapView) Override to perform clean up of resources before shutdown.
boolean	onSingleTapConfirmed(MotionEvent event, MapView mapView) By default does nothing (return false).
void	setColor(int color)
void	setGeodesic(boolean geodesic) Sets whether to draw each segment of the line as a geodesic or not.
void	setId(String id)
void	setInfoWindow(InfoWindow infoWindow) Set the InfoWindow to be used.
void	setInfoWindowLocation(GeoPoint location) Sets the info window's cartoon bubble point to this location
void	setMilestoneManagers(List<MilestoneManager> pMilestoneManagers)
void	setOnClickListener(Polyline.OnClickListener listener)
void	setPoints(List<GeoPoint> points) Set the points.
void	setVisible(boolean visible)
void	setWidth(float width)
void	showInfoWindow(GeoPoint position)

Methods inherited from class org.osmdroid.views.overlay.OverlayWithIW

closeInfoWindow, getInfoWindow, getRelatedObject, getSnippet, getSubDescription, getTitle, isInfoWindowOpen, onDestroy, setRelatedObject, setSnippet, setSubDescription, setTitle

Methods inherited from class org.osmdroid.views.overlay.Overlay

drawAt, getBounds, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onLongPress, onPause, onResume, onScroll, onShowPress, onSingleTapUp, onTouchEvent, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

mDefaultInfoWindow

protected static InfoWindow mDefaultInfoWindow

mOnClickListener

protected Polyline.OnClickListener mOnClickListener

Constructor Detail

Polyline

public Polyline()

highly suggested that you provide context, if MapView is not provided or is null info window popups will not function unless you handle it yourself

Polyline

public Polyline(MapView mapView)

highly suggested that you provide MapView , if MapView is not provided or is null info window popups will not function unless you handle it yourself

Method Detail

clearPath

protected void clearPath()

addPoint

protected void addPoint(GeoPoint aPoint)

addPoint

@Deprecated
protected void addPoint(int aLatitudeE6,
                                     int aLongitudeE6)

Deprecated.

getPoints

public List<GeoPoint> getPoints()

Returns:

a copy of the points.

getNumberOfPoints

public int getNumberOfPoints()

getColor

public int getColor()

getWidth

public float getWidth()

getPaint

public Paint getPaint()

Returns:

the Paint used. This allows to set advanced Paint settings.

isVisible

public boolean isVisible()

isGeodesic

public boolean isGeodesic()

setColor

public void setColor(int color)

setWidth

public void setWidth(float width)

setVisible

public void setVisible(boolean visible)

setOnClickListener

public void setOnClickListener(Polyline.OnClickListener listener)

addGreatCircle

protected void addGreatCircle(GeoPoint startPoint,
                              GeoPoint endPoint,
                              int numberOfPoints)

setPoints

public void setPoints(List<GeoPoint> points)

Set the points. Note that a later change in the original points List will have no effect. To add/remove/change points, you must call setPoints again. If geodesic mode has been set, the long segments will follow the earth "great circle".

setGeodesic

public void setGeodesic(boolean geodesic)

Sets whether to draw each segment of the line as a geodesic or not. Warning: it takes effect only if set before setting the points in the Polyline.

draw

public void draw(Canvas canvas,
                 MapView mapView,
                 boolean shadow)

Description copied from class: Overlay

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

Specified by:

draw in class Overlay

isCloseTo

public boolean isCloseTo(GeoPoint point,
                         double tolerance,
                         MapView mapView)

Detection is done is screen coordinates.

Parameters:

point -

tolerance - in pixels

Returns:

true if the Polyline is close enough to the point.

setInfoWindow

public void setInfoWindow(InfoWindow infoWindow)

Set the InfoWindow to be used. Default is a MarkerInfoWindow, with the layout named "bonuspack_bubble". You can use this method either to use your own layout, or to use your own sub-class of InfoWindow. Note that this InfoWindow will receive the Marker object as an input, so it MUST be able to handle Marker attributes. If you don't want any InfoWindow to open, you can set it to null.

Overrides:

setInfoWindow in class OverlayWithIW

Parameters:

infoWindow - the InfoWindow to be opened when tapping the overlay. This InfoWindow MUST be able to handle an OverlayWithIW (as BasicInfoWindow does). Set it to null to remove an existing InfoWindow.

showInfoWindow

public void showInfoWindow(GeoPoint position)

onSingleTapConfirmed

public boolean onSingleTapConfirmed(MotionEvent event,
                                    MapView mapView)

Description copied from class: Overlay

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.

Overrides:

onSingleTapConfirmed in class Overlay

getInfoWindowAnchorPoint

public GeoPoint getInfoWindowAnchorPoint(GeoPoint eventPos)

returns a point that the info window cartoon bubble will point at. default implementation uses the first point of the line.

Parameters:

eventPos -

Returns:

Since:

6.0.0

setInfoWindowLocation

public void setInfoWindowLocation(GeoPoint location)

Sets the info window's cartoon bubble point to this location

Parameters:

location -

Since:

6.0.0

getId

public String getId()

Returns:

Since:

6.0.0

setId

public void setId(String id)

Parameters:

id -

Since:

6.0.0

onClickDefault

protected boolean onClickDefault(Polyline polyline,
                                 MapView mapView,
                                 GeoPoint eventPos)

default behaviour when no click listener is set

onDetach

public void onDetach(MapView mapView)

Description copied from class: Overlay

Override to perform clean up of resources before shutdown. By default does nothing.

Overrides:

onDetach in class Overlay

setMilestoneManagers

public void setMilestoneManagers(List<MilestoneManager> pMilestoneManagers)

Since:

6.0.0