com.dingi.dingisdk.annotations

Class PolygonOptions

java.lang.Object

com.dingi.dingisdk.annotations.PolygonOptions

All Implemented Interfaces:

android.os.Parcelable

public final class PolygonOptions
extends java.lang.Object
implements android.os.Parcelable

Builder for composing Polygon objects.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<PolygonOptions>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
PolygonOptions() Defines options for a polygon.

Method Summary

Modifier and Type	Method and Description
PolygonOptions	add(LatLng... points) Adds vertices to the outline of the polygon being built.
PolygonOptions	add(LatLng point) Adds a vertex to the outline of the polygon being built.
PolygonOptions	addAll(java.lang.Iterable<LatLng> points) Adds vertices to the outline of the polygon being built.
PolygonOptions	addAllHoles(java.lang.Iterable<java.util.List<LatLng>> holes) Adds holes to the outline of the polygon being built.
PolygonOptions	addHole(java.util.List<LatLng>... holes) Adds holes to the outline of the polygon being built.
PolygonOptions	addHole(java.util.List<LatLng> hole) Adds a hole to the outline of the polygon being built.
PolygonOptions	alpha(float alpha) Set the alpha value of the polyline.
int	describeContents() Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean	equals(java.lang.Object o) Compares this PolygonOptions object with another PolygonOptions and determines if their color, alpha, stroke color, and vertices match.
PolygonOptions	fillColor(int color) Specifies the polygon's fill color, as 32-bit ARGB.
float	getAlpha() Gets the alpha set for this PolygonOptions object.
int	getFillColor() Gets the fill color set for this PolygonOptions object.
java.util.List<java.util.List<LatLng>>	getHoles() Gets the holes set for this PolygonOptions object.
java.util.List<LatLng>	getPoints() Gets the points set for this PolygonOptions object.
Polygon	getPolygon() Do not use this method.
int	getStrokeColor() Gets the stroke color set for this PolygonOptions object.
int	hashCode() Gives an integer which can be used as the bucket number for storing elements of the set/map.
PolygonOptions	strokeColor(int color) Specifies the polygon's stroke color, as 32-bit ARGB.
void	writeToParcel(android.os.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 android.os.Parcelable.Creator<PolygonOptions> CREATOR

Constructor Detail

PolygonOptions

public PolygonOptions()

Defines options for a polygon.

Method Detail

describeContents

public int describeContents()

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

Specified by:

describeContents in interface android.os.Parcelable

Returns:

integer 0.

writeToParcel

public void writeToParcel(android.os.Parcel out,
                          int flags)

Flatten this object in to a Parcel.

Specified by:

writeToParcel in interface android.os.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

@NonNull
public PolygonOptions add(LatLng point)

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

Parameters:

point - LatLng point to be added to polygon geometry.

Returns:

This PolygonOptions object with the given point added to the outline.

add

@NonNull
public PolygonOptions add(LatLng... points)

Adds vertices to the outline of the polygon being built.

Parameters:

points - LatLng points to be added to polygon geometry.

Returns:

This PolygonOptions object with the given points added to the outline.

addAll

@NonNull
public PolygonOptions addAll(java.lang.Iterable<LatLng> points)

Adds vertices to the outline of the polygon being built.

Parameters:

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

Returns:

This PolygonOptions object with the given points added to the outline.

addHole

@NonNull
public PolygonOptions addHole(java.util.List<LatLng> hole)

Adds a hole to the outline of the polygon being built.

Parameters:

hole - List list made up of LatLng points defining the hole

Returns:

This PolygonOptions object with the given hole added to the outline.

addHole

@NonNull
public PolygonOptions addHole(java.util.List<LatLng>... holes)

Adds holes to the outline of the polygon being built.

Parameters:

holes - List list made up of LatLng holes to be added to polygon geometry

Returns:

This PolygonOptions object with the given holes added to the outline.

addAllHoles

@NonNull
public PolygonOptions addAllHoles(java.lang.Iterable<java.util.List<LatLng>> holes)

Adds holes to the outline of the polygon being built.

Parameters:

holes - Iterable list made up of List list of LatLng holes defining the hole geometry

Returns:

This PolygonOptions object with the given holes added to the outline.

alpha

@NonNull
public PolygonOptions alpha(float alpha)

Set the alpha value of the polyline.

Parameters:

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

Returns:

This PolygonOptions object with the given polygon alpha value.

getAlpha

public float getAlpha()

Gets the alpha set for this PolygonOptions object.

Returns:

float value between 0 and 1 defining the alpha.

fillColor

@NonNull
public PolygonOptions fillColor(int color)

Specifies the polygon's fill color, as 32-bit ARGB. The default color is black.

Parameters:

color - 32-bit ARGB color.

Returns:

This PolylineOptions object with a new color set.

getFillColor

public int getFillColor()

Gets the fill color set for this PolygonOptions object.

Returns:

The fill color of the polygon in ARGB format.

getPolygon

public Polygon getPolygon()

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

Returns:

Polygon the Polygon to return

strokeColor

@NonNull
public PolygonOptions strokeColor(int color)

Specifies the polygon's stroke color, as 32-bit ARGB. The default color is black.

Parameters:

color - 32-bit ARGB color.

Returns:

This PolygonOptions object with a new stroke color set.

getStrokeColor

public int getStrokeColor()

Gets the stroke color set for this PolygonOptions object.

Returns:

The stroke color of the polygon in ARGB format.

getPoints

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

Gets the points set for this PolygonOptions object.

Returns:

The list made up of LatLng points defining the polygon.

getHoles

public java.util.List<java.util.List<LatLng>> getHoles()

Gets the holes set for this PolygonOptions object.

Returns:

The list made up of List of List of LatLng points defining the holes.

equals

public boolean equals(@Nullable
                      java.lang.Object o)

Compares this PolygonOptions object with another PolygonOptions and determines if their color, alpha, stroke color, and vertices match.

Overrides:

equals in class java.lang.Object

Parameters:

o - Another PolygonOptions to compare with this object.

Returns:

True if color, alpha, stroke color, vertices and holes match this PolygonOptions PolygonOptions 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 java.lang.Object

Returns:

integer value you can use for storing element.