com.mapbox.mapboxsdk.annotations

Class PolylineOptions

java.lang.Object

com.mapbox.mapboxsdk.annotations.PolylineOptions

All Implemented Interfaces:

Parcelable

public final class PolylineOptions
extends Object
implements Parcelable

Builder for composing Polyline objects.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<PolylineOptions>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
PolylineOptions() Defines options for a polyline.

Method Summary

Modifier and Type	Method and Description
PolylineOptions	add(LatLng... points) Adds vertices to the end of the polyline being built.
PolylineOptions	add(LatLng point) Adds a vertex to the end of the polyline being built.
PolylineOptions	addAll(Iterable<LatLng> points) Adds vertices to the end of the polyline being built.
PolylineOptions	alpha(float alpha) Set the alpha value of the polyline.
PolylineOptions	color(int color) Sets the color of the polyline as a 32-bit ARGB color.
int	describeContents() Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean	equals(Object o) Compares this PolylineOptions object with another PolylineOptions and determines if their color, alpha, width, and vertices match.
float	getAlpha() Gets the alpha set for this PolylineOptions object.
int	getColor() Gets the color set for this PolylineOptions object.
List<LatLng>	getPoints() Gets the points set for this PolylineOptions object.
Polyline	getPolyline() Do not use this method.
float	getWidth() Gets the width set for this PolylineOptions object.
int	hashCode() Gives an integer which can be used as the bucket number for storing elements of the set/map.
PolylineOptions	width(float width) Sets the width of the polyline in screen pixels.
void	writeToParcel(Parcel out, int flags) Flatten this object in to a Parcel.

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<PolylineOptions> CREATOR

Constructor Detail

PolylineOptions

public PolylineOptions()

Defines options for a polyline.

Method Detail

describeContents

public int describeContents()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Specified by:

describeContents in interface Parcelable

Returns:

integer 0.

writeToParcel

public void writeToParcel(Parcel out,
                          int flags)

Flatten this object in to a Parcel.

Specified by:

writeToParcel in interface Parcelable

Parameters:

out - The Parcel in which the object should be written.

flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.

add

public PolylineOptions add(LatLng point)

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

Parameters:

point - LatLng point to be added to polyline geometry.

Returns:

This PolylineOptions object with the given point on the end.

add

public PolylineOptions add(LatLng... points)

Adds vertices to the end of the polyline being built.

Parameters:

points - LatLng points defining the polyline geometry.

Returns:

This PolylineOptions object with the given point on the end.

addAll

public PolylineOptions addAll(Iterable<LatLng> points)

Adds vertices to the end of the polyline being built.

Parameters:

points - Iterable list made up of LatLng points defining the polyline geometry

Returns:

This PolylineOptions object with the given points on the end.

alpha

public PolylineOptions alpha(float alpha)

Set the alpha value of the polyline.

Parameters:

alpha - float value between 0 (not visible) and 1.

Returns:

This PolylineOptions object with the given polyline alpha value.

getAlpha

public float getAlpha()

Gets the alpha set for this PolylineOptions object.

Returns:

float value between 0 and 1 defining the alpha.

color

public PolylineOptions color(int color)

Sets the color of the polyline as a 32-bit ARGB color. The default color is black.

Parameters:

color - 32-bit ARGB color.

Returns:

This PolylineOptions object with a new color set.

getColor

public int getColor()

Gets the color set for this PolylineOptions object.

Returns:

The color of the polyline in ARGB format.

getPolyline

public Polyline getPolyline()

Do not use this method. Used internally by the SDK.

Returns:

PolyLine The polyline build by this class.

getWidth

public float getWidth()

Gets the width set for this PolylineOptions object.

Returns:

The width of the polyline in screen pixels.

width

public PolylineOptions width(float width)

Sets the width of the polyline in screen pixels. The default is 10.

Parameters:

width - float value defining width of polyline using unit pixels.

Returns:

This PolylineOptions object with a new width set.

getPoints

public List<LatLng> getPoints()

Gets the points set for this PolylineOptions object.

Returns:

a List of LatLngs specifying the vertices of the polyline.

equals

public boolean equals(Object o)

Compares this PolylineOptions object with another PolylineOptions and determines if their color, alpha, width, and vertices match.

Overrides:

equals in class Object

Parameters:

o - Another PolylineOptions to compare with this object.

Returns:

True if color, alpha, width, and vertices match this PolylineOptions object. Else, false.

hashCode

public int hashCode()

Gives an integer which can be used as the bucket number for storing elements of the set/map. This bucket number is the address of the element inside the set/map. There's no guarantee that this hash value will be consistent between different Java implementations, or even between different execution runs of the same program.

Overrides:

hashCode in class Object

Returns:

integer value you can use for storing element.