org.osmdroid.views.overlay

Class Polyline

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.OverlayWithIW

org.osmdroid.views.overlay.PolyOverlayWithIW

org.osmdroid.views.overlay.Polyline

All Implemented Interfaces:

OverlayConstants

public class Polyline
extends PolyOverlayWithIW

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).

See Also:

Google Maps Polyline

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Polyline.OnClickListener Internal method used to ensure that the infowindow will have a default position in all cases, so that the user can call showInfoWindow even if no tap occured before.

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

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected Polyline.OnClickListener	mOnClickListener

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

mDensity, mFillPaint, mHoles, mOriginalPoints, mOutline, mOutlinePaint, mPath

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

mId, 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() If MapView is not provided, infowindow popup will not function unless you set it yourself.
Polyline(MapView mapView) If MapView is null, infowindow popup will not function unless you set it yourself.
Polyline(MapView pMapView, boolean pUsePath)

Method Summary

Modifier and Type	Method and Description
void	addPoint(GeoPoint p) Add the point at the end.
GeoPoint	getCloseTo(GeoPoint point, double tolerance, MapView mapView)
int	getColor() Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead
double	getDistance()
Paint	getPaint() Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead
ArrayList<GeoPoint>	getPoints()
float	getWidth() Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead
boolean	isCloseTo(GeoPoint point, double tolerance, MapView mapView) Detection is done is screen coordinates.
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) Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead
void	setOnClickListener(Polyline.OnClickListener listener)
void	setPoints(List<GeoPoint> points) Set the points.
void	setWidth(float width) Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead

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

draw, getFillPaint, getInfoWindowLocation, getOutlinePaint, isGeodesic, isVisible, setDefaultInfoWindowLocation, setGeodesic, setInfoWindow, setInfoWindowLocation, setMilestoneManagers, setVisible, showInfoWindow

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

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

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

draw, 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

mOnClickListener

protected Polyline.OnClickListener mOnClickListener

Constructor Detail

Polyline

public Polyline()

If MapView is not provided, infowindow popup will not function unless you set it yourself.

Polyline

public Polyline(MapView mapView)

If MapView is null, infowindow popup will not function unless you set it yourself.

Polyline

public Polyline(MapView pMapView,
                boolean pUsePath)

Parameters:

pUsePath - true if you want the drawing to use Path instead of Canvas.drawLines Not recommended in all cases, given the performances. Useful though if you want clean alpha vertices cf. https://github.com/osmdroid/osmdroid/issues/1280

Since:

6.1.0

Method Detail

getPoints

public ArrayList<GeoPoint> getPoints()

Returns:

a copy of the points.

getColor

@Deprecated
public int getColor()

Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead

getWidth

@Deprecated
public float getWidth()

Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead

getPaint

@Deprecated
public Paint getPaint()

Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead

setColor

@Deprecated
public void setColor(int color)

Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead

setWidth

@Deprecated
public void setWidth(float width)

Deprecated. Use {PolyOverlayWithIW.getOutlinePaint()} instead

setOnClickListener

public void setOnClickListener(Polyline.OnClickListener listener)

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 remove/change points, you must call setPoints again. If geodesic mode has been set, the long segments will follow the earth "great circle".

addPoint

public void addPoint(GeoPoint p)

Add the point at the end. If geodesic mode has been set, the long segments will follow the earth "great circle".

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.

getCloseTo

public GeoPoint getCloseTo(GeoPoint point,
                           double tolerance,
                           MapView mapView)

Parameters:

point -

tolerance - in pixels

Returns:

the first GeoPoint of the Polyline close enough to the point

Since:

6.0.3 Detection is done is screen coordinates.

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

onClickDefault

public 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 PolyOverlayWithIW

getDistance

public double getDistance()

Overrides:

getDistance in class PolyOverlayWithIW

Returns:

aggregate distance (in meters)

Since:

6.0.3