Package com.arubanetworks.meridian.maps

Class OverlayMarkerOptions

java.lang.Object

com.arubanetworks.meridian.maps.OverlayMarkerOptions

All Implemented Interfaces:

Serializable

public class OverlayMarkerOptions
extends Object
implements Serializable

A serializable options object for use with OverlayMarker

Contains all of the values that control how a OverlayMarker will be drawn

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OverlayMarkerOptions.OverlayMarkerCoordinateType

Constructor Summary

Constructors

Constructor	Description
OverlayMarkerOptions(int overlayType, float x, float y, OverlayMarkerOptions.OverlayMarkerCoordinateType coordinateType, float[] points)
OverlayMarkerOptions(OverlayMarkerOptions source)

Method Summary

Modifier and Type	Method	Description
static OverlayMarkerOptions	fromCircle(float x, float y, float radius)	Construct an OverlayMarker for a circle
static OverlayMarkerOptions	fromPlacemark(Placemark placemark)	Construct an OverlayMarker using data from a placemark
MapInfo.ZoomLevel	getMaxZoomLevel()
MapInfo.ZoomLevel	getMinZoomLevel()
int	getOverlayColor()	Overlay Stroke Color (ARGB)
int	getOverlayFillColor()	Overlay Fill Color (ARGB)
int	getOverlayType()	Type for OverlayMarker
float	getOverlayWidth()	Stroke width for the OverlayMarker
Placemark	getPlacemark()	The placemark that was used to initialize the OverlayMarkerOptions
float[]	getPoints()	Return an array of 2D point data.
float	getX()
float	getY()
void	setOverlayColor(int newOverlayColor)	Set Overlay Stoke Color (ARGB) Hint: Color.parseColor() can be used to convert an ARGB string color to an int
void	setOverlayFillColor(int newOverlayFillColor)	Set Overlay Fill Color (ARGB) Hint: Color.parseColor() can be used to convert an ARGB string color to an int
void	setOverlayType(int type)	Type for the OverlayMarker
void	setOverlayWidth(float width)	Set the stroke width for the OverlayMarker
void	setPoints(float[] points, OverlayMarkerOptions.OverlayMarkerCoordinateType type)	Set the point data: The first value in the points array is the number of points in the array.
void	setX(float newX)
void	setY(float newY)
void	updateFromPlacemark(Placemark placemark)	Update OverlayMarker with the current point data from a placemark

Methods inherited from class java.lang.Object

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

Constructor Details

OverlayMarkerOptions

public OverlayMarkerOptions(int overlayType,
 float x,
 float y,
 OverlayMarkerOptions.OverlayMarkerCoordinateType coordinateType,
 float[] points)

OverlayMarkerOptions

public OverlayMarkerOptions(OverlayMarkerOptions source)

Method Details

fromPlacemark

public static OverlayMarkerOptions fromPlacemark(Placemark placemark)

Construct an OverlayMarker using data from a placemark

Parameters:

placemark - The placemark containing the point data

fromCircle

public static OverlayMarkerOptions fromCircle(float x,
 float y,
 float radius)

Construct an OverlayMarker for a circle

Parameters:

x - Center of circle X coordinate

y - Center of circle Y coordinate

radius - Radius of circle

updateFromPlacemark

public void updateFromPlacemark(Placemark placemark)

Update OverlayMarker with the current point data from a placemark

Parameters:

placemark - The placemark

getPlacemark

public Placemark getPlacemark()

The placemark that was used to initialize the OverlayMarkerOptions

getOverlayType

public int getOverlayType()

Type for OverlayMarker

Returns:

TextureProvider.OverlayType

setOverlayType

public void setOverlayType(int type)

Type for the OverlayMarker

Parameters:

type - TextureProvider.OverlayType

getOverlayWidth

public float getOverlayWidth()

Stroke width for the OverlayMarker

setOverlayWidth

public void setOverlayWidth(float width)

Set the stroke width for the OverlayMarker

getOverlayColor

public int getOverlayColor()

Overlay Stroke Color (ARGB)

setOverlayColor

public void setOverlayColor(int newOverlayColor)

Set Overlay Stoke Color (ARGB)

Hint: Color.parseColor() can be used to convert an ARGB string color to an int

getOverlayFillColor

public int getOverlayFillColor()

Overlay Fill Color (ARGB)

setOverlayFillColor

public void setOverlayFillColor(int newOverlayFillColor)

Set Overlay Fill Color (ARGB)

Hint: Color.parseColor() can be used to convert an ARGB string color to an int

getX

public float getX()

getY

public float getY()

setX

public void setX(float newX)

setY

public void setY(float newY)

getMinZoomLevel

public MapInfo.ZoomLevel getMinZoomLevel()

getMaxZoomLevel

public MapInfo.ZoomLevel getMaxZoomLevel()

getPoints

public float[] getPoints()

Return an array of 2D point data.

The first value in the points array is the number of points in the array. Point values are OverlayMarkerCoordinateType.ABSOLUTE map coordinates.

Returns:

Array of point data [num, x1, y1, x2, y2,…]

setPoints

public void setPoints(float[] points,
 OverlayMarkerOptions.OverlayMarkerCoordinateType type)

Set the point data: The first value in the points array is the number of points in the array.

Parameters:

points - Array of point data [num, x1, y1, x2, y2, …]

type - The OverlayMarkerCoordinateType of the incoming points