org.osmdroid.views.overlay

Class PolyOverlayWithIW

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.OverlayWithIW

org.osmdroid.views.overlay.PolyOverlayWithIW

All Implemented Interfaces:

OverlayConstants

Direct Known Subclasses:

Polygon, Polyline

public abstract class PolyOverlayWithIW
extends OverlayWithIW

Repository of common methods for Polyline and Polygon

Since:

6.1.0

Nested Class Summary

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

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected float	mDensity
protected Paint	mFillPaint
protected List<LinearRing>	mHoles
protected LinearRing	mOutline
protected Paint	mOutlinePaint
protected Path	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

Modifier	Constructor and Description
protected	PolyOverlayWithIW(MapView pMapView, boolean pUsePath, boolean pClosePath)

Method Summary

Modifier and Type	Method and Description
void	addPoint(GeoPoint p)
protected abstract boolean	click(MapView pMapView, GeoPoint pEventPos)
boolean	contains(MotionEvent pEvent) Used to be if Polygon Important note: this function returns correct results only if the Poly has been drawn before, and if the MapView positioning has not changed.
void	draw(Canvas pCanvas, Projection pProjection)
List<GeoPoint>	getActualPoints()
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
GeoPoint	getCloseTo(GeoPoint pPoint, double pTolerance, MapView pMapView)
double	getDistance()
protected Paint	getFillPaint()
GeoPoint	getInfoWindowLocation()
Paint	getOutlinePaint()
List<PaintList>	getOutlinePaintLists() assuming if someone uses this method, someone wants to use List instead of mere Paint
boolean	isCloseTo(GeoPoint pPoint, double pTolerance, MapView pMapView)
boolean	isGeodesic()
boolean	isVisible()
void	onDetach(MapView mapView) Override to perform clean up of resources before shutdown.
boolean	onSingleTapConfirmed(MotionEvent pEvent, MapView pMapView) Used to be in both Polyline and Polygon Default listener for a single tap event on a Poly: set the infowindow at the tapped position, and open the infowindow (if any).
protected void	setDefaultInfoWindowLocation() 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.
void	setDensityMultiplier(float pDensityMultiplier)
void	setDowngradeDisplay(boolean pDowngradeDisplay)
void	setDowngradePixelSizes(int pPolySize, int pRectangleSize)
void	setGeodesic(boolean geodesic) Sets whether to draw each segment of the line as a geodesic or not.
void	setInfoWindow(InfoWindow infoWindow) Set the InfoWindow to be used.
void	setInfoWindowLocation(GeoPoint location) Sets the info window anchor point to a geopoint location
void	setMilestoneManagers(List<MilestoneManager> pMilestoneManagers)
void	setPoints(List<GeoPoint> points)
void	setVisible(boolean visible)
void	showInfoWindow() Show the infowindow, if any.
void	usePath(boolean pUsePath)

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

mOutline

protected LinearRing mOutline

mHoles

protected List<LinearRing> mHoles

mOutlinePaint

protected Paint mOutlinePaint

mFillPaint

protected Paint mFillPaint

mPath

protected Path mPath

mDensity

protected float mDensity

Constructor Detail

PolyOverlayWithIW

protected PolyOverlayWithIW(MapView pMapView,
                            boolean pUsePath,
                            boolean pClosePath)

Method Detail

usePath

public void usePath(boolean pUsePath)

Since:

6.2.0 Use Path or not for the display drawPath can be notoriously slower than drawLines, therefore when relevant "Polygon"s would be better off if displayed with drawLines. On the other hand, drawPath sometimes looks better, therefore when relevant "Polyline"s would be better off if displayed with drawPath

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

getOutlinePaint

public Paint getOutlinePaint()

Returns:

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

getOutlinePaintLists

public List<PaintList> getOutlinePaintLists()

assuming if someone uses this method, someone wants to use List instead of mere Paint

getFillPaint

protected Paint getFillPaint()

Returns:

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

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.

isGeodesic

public boolean isGeodesic()

setInfoWindow

public void setInfoWindow(InfoWindow infoWindow)

Set the InfoWindow to be used. Default is a BasicInfoWindow, 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. 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()

Show the infowindow, if any. It will be opened either at the latest location, if any, or to a default location computed by setDefaultInfoWindowLocation method. Note that you can manually set this location with: setInfoWindowLocation

setInfoWindowLocation

public void setInfoWindowLocation(GeoPoint location)

Sets the info window anchor point to a geopoint location

getInfoWindowLocation

public GeoPoint getInfoWindowLocation()

Returns:

the geopoint location where the infowindow should point at. Doesn't matter if the infowindow is currently opened or not.

setMilestoneManagers

public void setMilestoneManagers(List<MilestoneManager> pMilestoneManagers)

getDistance

public double getDistance()

Returns:

aggregate distance (in meters)

setDefaultInfoWindowLocation

protected void setDefaultInfoWindowLocation()

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. Currently, set the position on the center of the polygon bounding box.

draw

public void draw(Canvas pCanvas,
                 Projection pProjection)

Overrides:

draw in class Overlay

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

getBounds

public BoundingBox getBounds()

Description copied from class: Overlay

Gets the bounds of the overlay, useful for skipping draw cycles on overlays that are not in the current bounding box of the view

Overrides:

getBounds in class Overlay

Returns:

Since:

6.2.0

setPoints

public void setPoints(List<GeoPoint> points)

Since:

6.2.0 Used to be in Polygon and Polyline Set the points of the outline. 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)

Since:

6.2.0 Used to be in Polygon and Polyline Add the point at the end of the outline If geodesic mode has been set, the long segments will follow the earth "great circle".

getActualPoints

public List<GeoPoint> getActualPoints()

Returns:

a direct link to the list of polygon's vertices, which are the original points if we didn't use the geodesic feature Warning: changes on this list may cause strange results on the display.

Since:

6.2.0

setDowngradeDisplay

public void setDowngradeDisplay(boolean pDowngradeDisplay)

Since:

6.2.0 See setDowngradePixelSizes(int, int)

setDowngradePixelSizes

public void setDowngradePixelSizes(int pPolySize,
                                   int pRectangleSize)

Parameters:

pPolySize - Size in pixels below which we will display an optimized list of segments

pRectangleSize - Size in pixels below which we will display a mere rectangle (faster); supposed to be lower than pPolySize

Since:

6.2.0 If the size of the Poly (width or height) projected on the screen is lower than the parameter, the Poly won't be displayed as a real Poly, but downgraded to an optimized list of segments or an even more optimized rectangle (or not displayed at all, depending on setDowngradeDisplay(boolean)

click

protected abstract boolean click(MapView pMapView,
                                 GeoPoint pEventPos)

Since:

6.2.0

setDensityMultiplier

public void setDensityMultiplier(float pDensityMultiplier)

Since:

6.2.0 Used to be in Polyline

contains

public boolean contains(MotionEvent pEvent)

Used to be if Polygon Important note: this function returns correct results only if the Poly has been drawn before, and if the MapView positioning has not changed.

Returns:

true if the Poly contains the event position.

isCloseTo

public boolean isCloseTo(GeoPoint pPoint,
                         double pTolerance,
                         MapView pMapView)

Parameters:

pTolerance - in pixels

Returns:

true if the Poly is close enough to the point.

Since:

6.2.0 Used to be in Polyline Detection is done is screen coordinates.

getCloseTo

public GeoPoint getCloseTo(GeoPoint pPoint,
                           double pTolerance,
                           MapView pMapView)

Parameters:

pTolerance - in pixels

Returns:

the first GeoPoint of the Poly close enough to the point

Since:

6.2.0 Used to be in Polyline Detection is done is screen coordinates.

onSingleTapConfirmed

public boolean onSingleTapConfirmed(MotionEvent pEvent,
                                    MapView pMapView)

Used to be in both Polyline and Polygon Default listener for a single tap event on a Poly: set the infowindow at the tapped position, and open the infowindow (if any).

Overrides:

onSingleTapConfirmed in class Overlay

Returns:

true if tapped