com.tomtom.pnd.maplib

Class PolygonBuilder

java.lang.Object

com.tomtom.pnd.maplib.PolygonBuilder

public class PolygonBuilder
extends java.lang.Object

Builder class for Polygon objects.

Since:

5 (15.5 Moretti)

Field Summary

Fields

Modifier and Type	Field and Description
static float	MAX_BORDER_WIDTH
static float	MIN_BORDER_WIDTH

Constructor Summary

Constructors

Constructor and Description
PolygonBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
PolygonBuilder	add(double latitude, double longitude) Adds a vertex to the end of the polygon being built.
PolygonBuilder	add(GeoPoint point) Adds a vertex to the end of the polygon being built.
PolygonBuilder	add(android.location.Location location) Adds a vertex to the end of the polygon being built.
PolygonBuilder	addAll(java.util.Collection<? extends GeoPoint> points) Adds multiple vertices to the end of the polygon being built.
PolygonBuilder	addAll(double[] points) Adds multiple vertices to the end of the polygon being built.
PolygonBuilder	borderColor(int color) Sets the border color of the polygon as a 32-bit ARGB color.
PolygonBuilder	borderWidth(float width) Sets the border width of the polygon.
Polygon	build() Combines all the properties that have been set and returns a new Polygon object.
PolygonBuilder	fillColor(int color) Sets the fill color of the polygon as a 32-bit ARGB color.
int	getBorderColor() Gets the border color for this object.
float	getBorderWidth() Gets the border width for this object.
int	getFillColor() Gets the border color for this object.
java.util.List<GeoPoint>	getPoints() Gets the point set of geocoordinates for this object.
int	getTextureAlpha() Gets the texture alpha of this object.
int	getTextureId() Gets the texture resource ID of 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.
PolygonBuilder	selectable(boolean isSelectable) Specifies the selectability for the polygon.
PolygonBuilder	texture(android.content.Context context, int resId) Specifies a texture to fill polygon with.
PolygonBuilder	textureAlpha(int textureAlpha) Specifies a transparency for polygon texture.
PolygonBuilder	visibility(boolean isVisible) Specifies the visibility for the polygon.
PolygonBuilder	zIndex(int zIndex) Specifies the zIndex of the polygon.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_BORDER_WIDTH

public static final float MIN_BORDER_WIDTH

See Also:

Constant Field Values

MAX_BORDER_WIDTH

public static final float MAX_BORDER_WIDTH

See Also:

Constant Field Values

Constructor Detail

PolygonBuilder

public PolygonBuilder()

Method Detail

add

public PolygonBuilder add(android.location.Location location)

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

Parameters:

location - A geographic location.

Returns:

this PolygonBuilder object with the given point at the end.

add

public PolygonBuilder add(double latitude,
                 double longitude)

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

Parameters:

latitude - Latitude, in degrees.

longitude - Longitude, in degrees.

Returns:

this PolygonBuilder object with the given point at the end.

add

public PolygonBuilder add(GeoPoint point)

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

Parameters:

point - A pair of latitude and longitude in degrees.

Returns:

this PolygonBuilder object with the given point at the end.

addAll

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

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

Parameters:

points - Collections of GeoPoints.

Returns:

this PolygonBuilder object with the given points at the end.

addAll

public PolygonBuilder addAll(double[] points)
                      throws java.lang.IllegalArgumentException

Adds multiple vertices to the end of the polygon 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 PolygonBuilder object with the given points at the end.

Throws:

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

java.lang.IllegalArgumentException

borderColor

public PolygonBuilder borderColor(int color)

Sets the border color of the polygon as a 32-bit ARGB color.

Parameters:

color - The ARGB color.

Returns:

this PolygonBuilder object with the given border point at the end.

fillColor

public PolygonBuilder fillColor(int color)

Sets the fill color of the polygon as a 32-bit ARGB color.

Parameters:

color - The ARGB color.

Returns:

this PolygonBuilder object with the given fill color at the end.

borderWidth

public PolygonBuilder borderWidth(float width)
                           throws java.lang.IllegalArgumentException

Sets the border width of the polygon. The default is 0.0f px. The max is 7.0f px.

Parameters:

width - The line width in pixels.

Returns:

this PolygonBuilder object with the given width at the end.

Throws:

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

visibility

public PolygonBuilder visibility(boolean isVisible)

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

Parameters:

isVisible - The visibility of polygon.

Returns:

this PolygonBuilder object with the given visibility on the end.

selectable

public PolygonBuilder selectable(boolean isSelectable)

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

Parameters:

isSelectable - Whether the polygon is selectable.

Returns:

this PolygonBuilder object with the given selectability value on the end.

Since:

6 (16.1 Fermi)

zIndex

public PolygonBuilder zIndex(int zIndex)

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

Parameters:

zIndex - the zIndex of the polygon.

Returns:

this PolygonBuilder object with the given zIndex on the end.

texture

public PolygonBuilder texture(android.content.Context context,
                     int resId)
                       throws java.lang.IllegalArgumentException

Specifies a texture to fill polygon with.

Parameters:

context - a Context of the application.

resId - a drawable's resource id.

Returns:

this PolygonBuilder object with the given texture on the end.

Throws:

java.lang.IllegalArgumentException - when context is null.

textureAlpha

public PolygonBuilder textureAlpha(int textureAlpha)

Specifies a transparency for polygon texture. Texture should be set with texture(Context, int).

Parameters:

textureAlpha - The transparency value in the range [0, 255]. Values out of range will be clamped.

Returns:

this PolygonBuilder object with the given texture alpha value on the end.

getPoints

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

Gets the point set of geocoordinates for this object.

Returns:

the list of GeoPoints specifying the vertices of the polygon.

getBorderColor

public int getBorderColor()

Gets the border color for this object.

Returns:

the color of the polygon in ARGB format.

getFillColor

public int getFillColor()

Gets the border color for this object.

Returns:

the color of the polygon in ARGB format.

getBorderWidth

public float getBorderWidth()

Gets the border width for this object.

Returns:

the width of the polygon in range from 0.0f till 7.0f.

isVisible

public boolean isVisible()

Gets the visibility setting for this object.

Returns:

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

isSelectable

public boolean isSelectable()

Gets the selectability setting for this object.

Returns:

true if the polygon 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 polygon.

getTextureId

public int getTextureId()

Gets the texture resource ID of this object.

Returns:

the the texture resource ID of the polygon.

getTextureAlpha

public int getTextureAlpha()

Gets the texture alpha of this object.

Returns:

the texture alpha of the polygon.

build

public Polygon build()

Combines all the properties that have been set and returns a new Polygon object.

Returns:

a new Polygon object.