Circle

Class Overview

A circle on the earth's surface (spherical cap).

A circle has the following properties.

Center

The center of the Circle is specified as a Location.

Radius

The radius of the circle, specified in meters. It should be zero or greater.

Stroke Width

The width of the circle's outline in screen pixels. The width is constant and independent of the camera's zoom level. The default value is 10.

Stroke Color

The color of the circle outline in ARGB format, the same format used by Color. The default value is black (0xff000000).

Fill Color

The color of the circle fill in ARGB format, the same format used by Color. The default value is transparent (0x00000000).

Z-Index

The order in which this tile overlay is drawn with respect to other overlays. An overlay with a larger z-index is drawn over overlays with smaller z-indices. The order of overlays with the same z-index is arbitrary. The default z-index is 0.

Visibility

Indicates if the circle is visible or invisible, i.e., whether it is drawn on the map. An invisible circle is not drawn, but retains all of its other properties. The default is true, i.e., visible.

Methods that modify a Circle must be called on the main thread. If not, an IllegalStateException will be thrown at runtime.

Example

 Map map;
 // ... get a map.
 // Add a circle in Sydney
 Circle circle = new Circle()
      .setCenter(new Location(-33.87365, 151.20689))
      .setRadius(10000)
      .setStrokeColor(Color.RED)
      .setFillColor(Color.BLUE));
 map.add(circle);
 

Note that the current map renderer is unable to draw the circle fill if the circle encompasses either the North or South pole. However, the outline will still be drawn correctly.

Summary

Public Constructors
	Circle() Creates a new Circle.

Public Methods
Location	getCenter() Returns the center as a Location.
Color	getFillColor() Returns the fill color.
double	getRadius() Returns the circle's radius, in meters.
Color	getStrokeColor() Returns the stroke color.
int	getStrokeWidth() Returns the stroke width.
int	getZIndex() Returns the z-index.
boolean	isVisible() Checks whether the circle is visible.
Circle	setCenter(Location center) Sets the center using a Location.
Circle	setFillColor(Color color) Sets the fill color.
Circle	setRadius(double radius) Sets the radius in meters.
Circle	setStrokeColor(Color color) Sets the stroke color.
Circle	setStrokeWidth(int width) Sets the stroke width.
Circle	setVisible(boolean visible) Sets the visibility.
Circle	setZIndex(int zIndex) Sets the z-index.

[Expand] Inherited Methods
From class com.neomades.maps.overlay.Overlay int getZIndex() Returns the z-index.
From class com.neomades.maps.overlay.BaseOverlay String getId() Returns the overlay ID. boolean isVisible() Checks whether the overlay is visible. void remove() Removes this overlay from Map.
From class java.lang.Object boolean equals(Object obj) Indicates whether some other object is "equal to" this one. final Class<?> getClass() Returns the runtime class of an object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.