org.osmdroid.views.overlay

Class Polygon

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.OverlayWithIW

org.osmdroid.views.overlay.Polygon

All Implemented Interfaces:

OverlayConstants

public class Polygon
extends OverlayWithIW

A polygon on the earth's surface that can have a popup-InfoWindow (a bubble). Mimics the Polygon class from Google Maps Android API v2 as much as possible. Main differences:
- Doesn't support: Z-Index, Geodesic mode
- Supports InfoWindow.

See Also:

Google Maps Polygon

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 static InfoWindow	mDefaultInfoWindow

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
Polygon()
Polygon(MapView mapView)

Method Summary

Modifier and Type	Method and Description
boolean	contains(MotionEvent event) Important note: this function returns correct results only if the Polygon has been drawn before, and if the MapView positioning has not changed.
void	draw(Canvas canvas, MapView mapView, boolean shadow) Draw the overlay over the map.
int	getFillColor()
List<List<GeoPoint>>	getHoles() returns a copy of the holes this polygon contains
String	getId()
GeoPoint	getInfoWindowAnchorPoint(GeoPoint eventPos) returns a point that the info window cartoon bubble will point at.
Paint	getOutlinePaint()
List<GeoPoint>	getPoints()
int	getStrokeColor()
float	getStrokeWidth()
boolean	isVisible()
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).
static ArrayList<GeoPoint>	pointsAsCircle(GeoPoint center, double radiusInMeters) Build a list of GeoPoint as a circle.
static ArrayList<IGeoPoint>	pointsAsRect(BoundingBox rectangle) Build a list of GeoPoint as a rectangle.
static ArrayList<IGeoPoint>	pointsAsRect(GeoPoint center, double lengthInMeters, double widthInMeters) Build a list of GeoPoint as a rectangle.
void	setFillColor(int fillColor)
void	setHoles(List<? extends List<GeoPoint>> holes)
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	setPoints(List<GeoPoint> points) This method will take a copy of the points.
void	setStrokeColor(int color)
void	setStrokeWidth(float width)
void	setVisible(boolean visible)
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

Constructor Detail

Polygon

public Polygon()

Polygon

public Polygon(MapView mapView)

Method Detail

getFillColor

public int getFillColor()

getStrokeColor

public int getStrokeColor()

getStrokeWidth

public float getStrokeWidth()

getOutlinePaint

public Paint getOutlinePaint()

Returns:

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

getPoints

public List<GeoPoint> getPoints()

Returns:

a copy of the list of polygon's vertices.

isVisible

public boolean isVisible()

setFillColor

public void setFillColor(int fillColor)

setStrokeColor

public void setStrokeColor(int color)

setStrokeWidth

public void setStrokeWidth(float width)

setVisible

public void setVisible(boolean visible)

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.

setPoints

public void setPoints(List<GeoPoint> points)

This method will take a copy of the points.

setHoles

public void setHoles(List<? extends List<GeoPoint>> holes)

getHoles

public List<List<GeoPoint>> getHoles()

returns a copy of the holes this polygon contains

Returns:

never null

pointsAsCircle

public static ArrayList<GeoPoint> pointsAsCircle(GeoPoint center,
                                                 double radiusInMeters)

Build a list of GeoPoint as a circle.

Parameters:

center - center of the circle

radiusInMeters -

Returns:

the list of GeoPoint

pointsAsRect

public static ArrayList<IGeoPoint> pointsAsRect(BoundingBox rectangle)

Build a list of GeoPoint as a rectangle.

Parameters:

rectangle - defined as a BoundingBox

Returns:

the list of 4 GeoPoint

pointsAsRect

public static ArrayList<IGeoPoint> pointsAsRect(GeoPoint center,
                                                double lengthInMeters,
                                                double widthInMeters)

Build a list of GeoPoint as a rectangle.

Parameters:

center - of the rectangle

lengthInMeters - on longitude

widthInMeters - on latitude

Returns:

the list of 4 GeoPoint

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

showInfoWindow

public void showInfoWindow(GeoPoint position)

contains

public boolean contains(MotionEvent event)

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

Parameters:

event -

Returns:

true if the Polygon contains the event 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

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

getId

public String getId()

Returns:

Since:

6.0.0

setId

public void setId(String id)

Parameters:

id -

Since:

6.0.0

setMilestoneManagers

public void setMilestoneManagers(List<MilestoneManager> pMilestoneManagers)

Since:

6.0.0