org.osmdroid.views.overlay

Class Polygon

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.OverlayWithIW

org.osmdroid.views.overlay.PolyOverlayWithIW

org.osmdroid.views.overlay.Polygon

All Implemented Interfaces:

OverlayConstants

public class Polygon
extends PolyOverlayWithIW

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

Modifier and Type	Class and Description
static interface	Polygon.OnClickListener

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

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected Polygon.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
Polygon()
Polygon(MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	addPoint(GeoPoint p) Add the point at the end of the polygon outline.
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.
int	getFillColor() Deprecated. Use getFillPaint() instead
Paint	getFillPaint()
List<List<GeoPoint>>	getHoles() returns a copy of the holes this polygon contains
List<GeoPoint>	getPoints()
int	getStrokeColor() Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead
float	getStrokeWidth() Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead
boolean	onClickDefault(Polygon polygon, 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) Default listener for a single tap event on a Polygon: set the infowindow at the tapped position, and open the infowindow (if any).
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) Deprecated. Use getFillPaint() instead
void	setHoles(List<? extends List<GeoPoint>> holes)
void	setOnClickListener(Polygon.OnClickListener listener)
void	setPoints(List<GeoPoint> points) Set the points of the polygon outline.
void	setStrokeColor(int color) Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead
void	setStrokeWidth(float width) Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead

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

draw, getDistance, 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 Polygon.OnClickListener mOnClickListener

Constructor Detail

Polygon

public Polygon()

Polygon

public Polygon(MapView mapView)

Method Detail

getFillColor

@Deprecated
public int getFillColor()

Deprecated. Use getFillPaint() instead

getStrokeColor

@Deprecated
public int getStrokeColor()

Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead

getStrokeWidth

@Deprecated
public float getStrokeWidth()

Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead

getFillPaint

public Paint getFillPaint()

Overrides:

getFillPaint in class PolyOverlayWithIW

Returns:

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

Since:

6.0.2

getPoints

public List<GeoPoint> getPoints()

Returns:

a copy of the list of polygon's vertices. Warning: changes on this list may cause strange results on the polygon display.

setFillColor

@Deprecated
public void setFillColor(int fillColor)

Deprecated. Use getFillPaint() instead

setStrokeColor

@Deprecated
public void setStrokeColor(int color)

Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead

setStrokeWidth

@Deprecated
public void setStrokeWidth(float width)

Deprecated. Use PolyOverlayWithIW.getOutlinePaint() instead

setPoints

public void setPoints(List<GeoPoint> points)

Set the points of the polygon 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)

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

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

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)

Default listener for a single tap event on a Polygon: set the infowindow at the tapped position, and open the infowindow (if any).

Overrides:

onSingleTapConfirmed in class Overlay

Parameters:

event -

mapView -

Returns:

true if tapped

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

onClickDefault

public boolean onClickDefault(Polygon polygon,
                              MapView mapView,
                              GeoPoint eventPos)

default behaviour when no click listener is set

setOnClickListener

public void setOnClickListener(Polygon.OnClickListener listener)

Parameters:

listener -

Since:

6.0.2