uk.co.ordnancesurvey.android.maps

Class CircleOptions

java.lang.Object

uk.co.ordnancesurvey.android.maps.CircleOptions

public final class CircleOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
CircleOptions()

Method Summary

Methods

Modifier and Type	Method and Description
CircleOptions	center(GridPoint center) Sets the center using a GridPoint.
CircleOptions	fillColor(int color) Sets the fill color.
GridPoint	getCenter() Returns the center as a GridPoint
double	getRadius() Returns the circle's radius, in meters.
float	getZIndex() Returns the zIndex.
boolean	isVisible() Checks whether the shape is visible.
CircleOptions	radius(double radius) Sets the radius in meters.
CircleOptions	strokeColor(int color) Sets the stroke color.
CircleOptions	strokeWidth(float width) Sets the stroke width.
CircleOptions	visible(boolean visible) Sets the visibility of the circle.
CircleOptions	zIndex(float zIndex) Sets the zIndex.

Methods inherited from class java.lang.Object

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

Constructor Detail

CircleOptions

public CircleOptions()

Method Detail

zIndex

public CircleOptions zIndex(float zIndex)

Sets the zIndex. Overlays (such as circles) with higher zIndices are drawn above those with lower indices.

Parameters:

zIndex -

Returns:

this CircleOptions object

visible

public CircleOptions visible(boolean visible)

Sets the visibility of the circle. If this circle is not visible then it will not be drawn. All other state is preserved. Defaults to True.

Parameters:

visible - false to make this shape invisible.

Returns:

this CircleOptions object

strokeColor

public CircleOptions strokeColor(int color)

Sets the stroke color.

The stroke color is the color of this circle's outline, in the integer format specified by android.graphics.Color. If TRANSPARENT is used then no outline is drawn.

Parameters:

color - The stroke color in the android.graphics.Color format.

Returns:

this CircleOptions object

strokeWidth

public CircleOptions strokeWidth(float width)

Sets the stroke width.

The stroke width is the width (in screen pixels) of the circle's outline. It must be zero or greater. If it is zero then no outline is drawn. The default value is 10.

Behaviour with a negative width is undefined.

Parameters:

width - The stroke width, in screen pixels.

Returns:

this CircleOptions object

fillColor

public CircleOptions fillColor(int color)

Sets the fill color.

The fill color is the color inside the circle, in the integer format specified by android.graphics.Color. If TRANSPARENT is used then no fill is drawn.

By default the fill color is transparent (0x00000000).

Parameters:

color - color in the android.graphics.Color format

Returns:

this CircleOptions object

center

public CircleOptions center(GridPoint center)

Sets the center using a GridPoint.

The center must not be null.

This method is mandatory because there is no default center.

Parameters:

center - The center of the circle.

Returns:

this CircleOptions object

radius

public CircleOptions radius(double radius)

Sets the radius in meters.

The radius must be zero or greater. The default radius is zero.

Parameters:

radius - radius in meters

Returns:

this CircleOptions object

getCenter

public GridPoint getCenter()

Returns the center as a GridPoint

Returns:

The geographic center as a GridPoint.

getRadius

public double getRadius()

Returns the circle's radius, in meters.

Returns:

The radius in meters.

getZIndex

public float getZIndex()

Returns the zIndex.

Returns:

The zIndex of this shape.

isVisible

public boolean isVisible()

Checks whether the shape is visible.

Returns:

True if the shape is visible; false if it is invisible.