com.here.android.mpa.mapping

Class MapCircle

java.lang.Object

com.here.android.mpa.common.ViewObject

com.here.android.mpa.mapping.MapObject

com.here.android.mpa.mapping.MapCircle

public final class MapCircle
extends MapObject

Represents a MapObject in the shape of a circle.

Note, in order to use this class, library 'org.locationtech.jts:jts-core:1.15.0' must be available at runtime. Check build.gradle file if it is included there.

Nested Class Summary

Nested classes/interfaces inherited from class com.here.android.mpa.mapping.MapObject

MapObject.Type

Constructor Summary

Constructors

Constructor and Description
MapCircle(double radius, GeoCoordinate center) Constructs a MapCircle, which is a MapObject in the shape of a circle.

Method Summary

Modifier and Type	Method and Description
GeoCoordinate	getCenter() Returns the GeoCoordinate representing the current center of the MapCircle.
int	getFillColor() Returns the current fill color for this MapCircle, returning an ARGB (Alpha/Red/Green/Blue) integer color value.
int	getLineColor() Returns the current border line color for this MapCircle, as an ARGB (Alpha/Red/Green/Blue) integer color value.
int	getLineWidth() Returns the current border line width for this MapCircle, in pixels.
double	getRadius() Returns the current radius of the MapCircle, in meters.
MapObject.Type	getType() Returns the type of object that this MapObject represents.
MapCircle	setCenter(GeoCoordinate center) Sets the center for this MapCircle to a specified GeoCoordinate.
MapCircle	setFillColor(int argbColor) Sets a fill color for this MapCircle using an ARGB (Alpha/Red/Green/Blue) integer color value.
MapCircle	setLineColor(int argbColor) Sets a border line color for this MapCircle, using an ARGB (Alpha/Red/Green/Blue) integer color value.
MapCircle	setLineWidth(int width) Sets a border line width, in pixels, for this MapCircle, an int value within the [0..100] range.
MapCircle	setRadius(double radius) Sets a radius for this MapCircle, in meters.
MapObject	setVisible(boolean isVisible) Sets whether this MapObject is visible.

Methods inherited from class com.here.android.mpa.mapping.MapObject

equals, getBaseType, getParent, getVisibleMask, getZIndex, hashCode, isVisible, resetVisibleMask, setVisible, setVisible, setVisibleMask, setVisibleMask, setZIndex, unsetVisibleMask, unsetVisibleMask

Methods inherited from class java.lang.Object

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

Constructor Detail

MapCircle

public MapCircle(double radius,
                 GeoCoordinate center)

Constructs a MapCircle, which is a MapObject in the shape of a circle.

Parameters:

radius - Desired radius of the MapCircle, in meters

center - A GeoCoordinate representing the center of the MapCircle.

Throws:

java.lang.IllegalArgumentException - If center is invalid.

Method Detail

setCenter

public MapCircle setCenter(GeoCoordinate center)

Sets the center for this MapCircle to a specified GeoCoordinate.

Parameters:

center - Desired GeoCoordinate for this MapCircle center.

Returns:

The updated MapCircle itself.

Throws:

java.lang.IllegalArgumentException - If center is invalid.

getCenter

public GeoCoordinate getCenter()

Returns the GeoCoordinate representing the current center of the MapCircle.

Returns:

The current MapCircle center

setRadius

public MapCircle setRadius(double radius)

Sets a radius for this MapCircle, in meters.

Parameters:

radius - Desired radius of the MapCircle.

Returns:

The updated MapCircle itself.

Throws:

java.lang.IllegalArgumentException - If the supplied radius is less than or equal to zero.

getRadius

public double getRadius()

Returns the current radius of the MapCircle, in meters. The default radius of a MapCircle instance is 1.

Returns:

The current radius of this MapCircle.

setFillColor

public MapCircle setFillColor(int argbColor)

Sets a fill color for this MapCircle using an ARGB (Alpha/Red/Green/Blue) integer color value.

Parameters:

argbColor - Desired ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each color component has a value range from [0..255] with 0 meaning no contribution for that component, and 255 meaning 100% contribution

Returns:

The updated MapCircle itself.

See Also:

android.graphics.Color

getFillColor

public int getFillColor()

Returns the current fill color for this MapCircle, returning an ARGB (Alpha/Red/Green/Blue) integer color value. Default fill color is solid blue or in ARGB color, 0xFF0000FF.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each color component has a value range from [0..255] with 0 meaning no contribution for that component, and 255 meaning 100% contribution

See Also:

android.graphics.Color

setLineColor

public MapCircle setLineColor(int argbColor)

Sets a border line color for this MapCircle, using an ARGB (Alpha/Red/Green/Blue) integer color value.

Parameters:

argbColor - Desired ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each color component has a value range from [0..255] with 0 meaning no contribution for that component, and 255 meaning 100% contribution

Returns:

The updated MapCircle itself.

See Also:

android.graphics.Color

getLineColor

public int getLineColor()

Returns the current border line color for this MapCircle, as an ARGB (Alpha/Red/Green/Blue) integer color value. Default line color is solid blue, or in ARGB color, 0xFF0000FF.

Returns:

The current ARGB integer color value. The packed integer is made up of 4 bytes: alpha, red, green, blue. Each color component has a value range from [0..255] with 0 meaning no contribution for that component, and 255 meaning 100% contribution

See Also:

android.graphics.Color

setLineWidth

public MapCircle setLineWidth(int width)

Sets a border line width, in pixels, for this MapCircle, an int value within the [0..100] range.

Parameters:

width - Desired width of the line defining the border of the MapCircle

Returns:

The updated MapCircle itself.

getLineWidth

public int getLineWidth()

Returns the current border line width for this MapCircle, in pixels. The default width is 0 pixels.

Returns:

The current width of the line defining the border of the MapCircle.

setVisible

public MapObject setVisible(boolean isVisible)

Sets whether this MapObject is visible.

Overrides:

setVisible in class MapObject

Parameters:

isVisible - A boolean variable specifying whether this MapObject is visible

Returns:

The updated MapObject itself.

See Also:

setVisible(boolean)

getType

public MapObject.Type getType()

Description copied from class: MapObject

Returns the type of object that this MapObject represents.

Specified by:

getType in class MapObject

Returns:

One of the MapObject.Type values