com.tomtom.pnd.maplib

Class PolylineBuilder

java.lang.Object

com.tomtom.pnd.maplib.PolylineBuilder

public class PolylineBuilder
extends java.lang.Object

Builder class for Polyline objects.

Since:

5 (15.5 Moretti)

Field Summary

Fields

Modifier and Type	Field and Description
static float	MAX_WIDTH
static float	MIN_WIDTH

Constructor Summary

Constructors

Constructor and Description
PolylineBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
PolylineBuilder	add(double latitude, double longitude) Adds a vertex to the end of the polyline being built.
PolylineBuilder	add(GeoPoint point) Adds a vertex to the end of the polyline being built.
PolylineBuilder	add(android.location.Location location) Adds a vertex to the end of the polyline being built.
PolylineBuilder	addAll(java.util.Collection<? extends GeoPoint> points) Adds multiple vertices to the end of the polyline being built.
PolylineBuilder	addAll(double[] points) Adds multiple vertices to the end of the polyline being built.
Polyline	build() Builds the new Polyline object with the provided properties and returns it.
PolylineBuilder	color(int color) Sets the color of the polyline as a 32-bit ARGB color.
int	getColor() Gets the color for this object.
java.util.List<GeoPoint>	getPoints() Gets the set of points for this object.
float	getWidth() Gets the width for this object.
int	getZIndex() Gets the zIndex of this object.
boolean	isSelectable() Gets the selectability setting for this object.
boolean	isVisible() Gets the visibility setting for this object.
PolylineBuilder	selectable(boolean isSelectable) Specifies the selectability for the polyline.
PolylineBuilder	visibility(boolean isVisible) Specifies the visibility for the polyline.
PolylineBuilder	width(float width) Sets the width of the polyline.
PolylineBuilder	zIndex(int zIndex) Specifies the zIndex of the polyline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_WIDTH

public static final float MIN_WIDTH

See Also:

Constant Field Values

MAX_WIDTH

public static final float MAX_WIDTH

See Also:

Constant Field Values

Constructor Detail

PolylineBuilder

public PolylineBuilder()

Method Detail

add

public PolylineBuilder add(android.location.Location location)

Adds a vertex to the end of the polyline being built.

Parameters:

location - A geographic location.

Returns:

this PolylineBuilder object with the given point at the end.

add

public PolylineBuilder add(double latitude,
                  double longitude)

Adds a vertex to the end of the polyline being built.

Parameters:

latitude - Latitude, in degrees.

longitude - Longitude, in degrees.

Returns:

this PolylineBuilder object with the given point at the end.

add

public PolylineBuilder add(GeoPoint point)

Adds a vertex to the end of the polyline being built.

Parameters:

point - A pair of latitude and longitude in degrees.

Returns:

this PolylineBuilder object with the given point at the end.

addAll

public PolylineBuilder addAll(java.util.Collection<? extends GeoPoint> points)

Adds multiple vertices to the end of the polyline being built.

Parameters:

points - Collections of GeoPoints.

Returns:

this PolylineBuilder object with the given points at the end.

addAll

public PolylineBuilder addAll(double[] points)

Adds multiple vertices to the end of the polyline being built.

Parameters:

points - the array of geocoordinates. Lat1, lon1, lat2, lon2, etc. For example, new double[]{ 52.375426f, 4.908740f, 52.375292f, 4.909346f}.

Returns:

this PolylineBuilder object with the given points at the end.

Throws:

{@link - IllegalArgumentException} when invalid coordinates are encountered.

color

public PolylineBuilder color(int color)

Sets the color of the polyline as a 32-bit ARGB color.

Parameters:

color - The ARGB color.

Returns:

this PolylineBuilder object with the given point at the end.

width

public PolylineBuilder width(float width)
                      throws java.lang.IllegalArgumentException

Sets the width of the polyline. The default is 1.0f px. The max is 7.0f px.

Parameters:

width - The line width in pixels.

Returns:

this PolylineBuilder object with the given point at the end.

Throws:

java.lang.IllegalArgumentException - when line width does not match the range [1.0f, 7.0f].

visibility

public PolylineBuilder visibility(boolean isVisible)

Specifies the visibility for the polyline. It is visible by default.

Parameters:

isVisible - The visibility of line.

Returns:

this PolylineBuilder object with the given point on the end.

selectable

public PolylineBuilder selectable(boolean isSelectable)

Specifies the selectability for the polyline. It is not selectable by default.

Parameters:

isSelectable - Whether the line is selectable.

Returns:

this PolylineBuilder object with the given point on the end.

Since:

6 (16.1 Fermi)

zIndex

public PolylineBuilder zIndex(int zIndex)

Specifies the zIndex of the polyline. A polyline with higher zIndices are drawn above those with lower indices.

Parameters:

zIndex - the zIndex of the polyline.

Returns:

this PolylineBuilder object with the given point on the end.

getPoints

public java.util.List<GeoPoint> getPoints()

Gets the set of points for this object.

Returns:

the list of GeoPoints specifying the vertices of the polyline.

getColor

public int getColor()

Gets the color for this object.

Returns:

the color of the polyline in ARGB format.

getWidth

public float getWidth()

Gets the width for this object.

Returns:

the width of the polyline in range from 1 till 7.

isVisible

public boolean isVisible()

Gets the visibility setting for this object.

Returns:

true if the polyline is to be visible; false if it is not.

isSelectable

public boolean isSelectable()

Gets the selectability setting for this object.

Returns:

true if the polyline is selectable; false if it is not.

Since:

6 (16.1 Fermi)

getZIndex

public int getZIndex()

Gets the zIndex of this object.

Returns:

the zIndex of the polyline.

build

public Polyline build()

Builds the new Polyline object with the provided properties and returns it.

Returns:

a new Polyline object.