public class

Polyline

extends Overlay
java.lang.Object
   ↳ com.neomades.maps.overlay.BaseOverlay
     ↳ com.neomades.maps.overlay.Overlay
       ↳ com.neomades.maps.overlay.Polyline

Class Overview

A polyline is a list of points, where line segments are drawn between consecutive points. A polyline has the following properties:

Points

The vertices of the line. Line segments are drawn between consecutive points. A polyline is not closed by default; to form a closed polyline, the start and end points must be the same.

Width

Line segment width in screen pixels. The width is constant and independent of the camera's zoom level. The default value is 10.

Color

Line segment color in ARGB format, the same format used by Color. The default value is black (0xff000000).

Z-Index

The order in which this tile overlay is drawn with respect to other overlays (including Circles and Polygons but not Markers). An overlay with a larger z-index is drawn over overlays with smaller z-indices. The order of overlays with the same z-index is arbitrary. The default z-index is 0.

Visibility

Indicates if the polyline is visible or invisible, i.e., whether it is drawn on the map. An invisible polyline is not drawn, but retains all of its other properties. The default is true, i.e., visible.

Geodesic status

Indicates whether the segments of the polyline should be drawn as geodesics, as opposed to straight lines on the Mercator projection. A geodesic is the shortest path between two points on the Earth's surface. The geodesic curve is constructed assuming the Earth is a sphere.

Methods that modify a Polyline must be called on the main thread. If not, an IllegalStateException will be thrown at runtime.

Example
 Map map;
 // ... get a map.
 Vector points = new Vector();
 points.add(new Location(51.5, -0.1));
 points.add(new Location(40.7, -74.0));
 // Add a thin red line from London to New York.
 Polyline line = map.add(new Polyline().setPoints(points).setWidth(5).setColor(Color.RED));
 

Summary

Public Constructors
Polyline()
Public Methods
Color getColor()
Gets the color of this polyline.
Vector getPoints()
Returns a snapshot of the vertices of this polyline at this time .
int getWidth()
Gets the width of this polyline.
boolean isGeodesic()
Gets whether each segment of the line is drawn as a geodesic or not.
void setColor(Color color)
Sets the color of this polyline.
void setGeodesic(boolean geodesic)
Sets whether to draw each segment of the line as a geodesic or not.
void setPoints(Vector points)
Sets the points of this polyline.
void setVisible(boolean visible)
Sets the visibility of this polyline.
void setWidth(int width)
Sets the width of this polyline.
void setZIndex(int zIndex)
Sets the z-index of this polyline.
[Expand]
Inherited Methods
From class com.neomades.maps.overlay.Overlay
From class com.neomades.maps.overlay.BaseOverlay
From class java.lang.Object

Public Constructors

public Polyline ()

Public Methods

public Color getColor ()

Gets the color of this polyline.

Returns
  • the color in ARGB format.

public Vector getPoints ()

Returns a snapshot of the vertices of this polyline at this time .

The list returned is a copy of the list of vertices and so changes to the polyline's vertices will not be reflected by this list, nor will changes to this list be reflected by the polyline. To change the vertices of the polyline, call setPoints(List).

Returns
  • copy of the list of vertices

public int getWidth ()

Gets the width of this polyline.

Returns
  • width of this polyline.

public boolean isGeodesic ()

Gets whether each segment of the line is drawn as a geodesic or not.

Returns
  • whether each segment of the line is drawn as a geodesic or not.

public void setColor (Color color)

Sets the color of this polyline.

Parameters
color of this polyline.

public void setGeodesic (boolean geodesic)

Sets whether to draw each segment of the line as a geodesic or not.

Cross Platform considerations

Supported only on the Android platform.

Parameters
geodesic whether to draw each segment of the line as a geodesic or not.

public void setPoints (Vector points)

Sets the points of this polyline.

This method will take a copy of the points, so further mutations to points will have no effect on this polyline.

Parameters
points a list of Location that are the vertices of the polyline.

public void setVisible (boolean visible)

Sets the visibility of this polyline.

Parameters
visible if true, then the polyline is visible; if false, it is not.

public void setWidth (int width)

Sets the width of this polyline.

Parameters
width the width in screen pixels

public void setZIndex (int zIndex)

Sets the z-index of this polyline.

Parameters
zIndex the z-index of this polyline.