uk.co.ordnancesurvey.android.maps

Class MarkerOptions

java.lang.Object

uk.co.ordnancesurvey.android.maps.MarkerOptions

public final class MarkerOptions
extends Object

Defines MarkerOptions for a marker.

Constructor Summary

Constructors

Constructor and Description
MarkerOptions() Creates a new set of marker options.

Method Summary

Methods

Modifier and Type	Method and Description
MarkerOptions	anchor(float u, float v) Specifies the anchor to be at a particular point in the marker image.
MarkerOptions	draggable(boolean draggable) Sets the draggability for the marker.
float	getAnchorU() Horizontal distance, normalized to [0, 1], of the anchor from the left edge.
float	getAnchorV() Vertical distance, normalized to [0, 1], of the anchor from the left edge.
GridPoint	getGridPoint()
BitmapDescriptor	getIcon() Gets the custom icon set for this MarkerOptions object.
String	getSnippet() Gets the snippet set for this MarkerOptions object.
String	getTitle() Gets the title set for this MarkerOptions object.
MarkerOptions	gridPoint(GridPoint gp) Sets the location for the marker.
MarkerOptions	icon(BitmapDescriptor icon) Sets the icon for the marker.
boolean	isDraggable() Gets the draggability setting for this MarkerOptions object.
boolean	isVisible() Gets the visibility setting for this MarkerOptions object.
MarkerOptions	snippet(String snippet) Sets the snippet for the marker.
MarkerOptions	title(String title) Sets the title for the marker.
MarkerOptions	visible(boolean visible) Sets the visibility for the marker.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerOptions

public MarkerOptions()

Creates a new set of marker options.

Method Detail

anchor

public MarkerOptions anchor(float u,
                   float v)

Specifies the anchor to be at a particular point in the marker image.

The anchor specifies the point in the icon image that is anchored to the marker's position on the Earth's surface. The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0], where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner. The anchoring point in a W x H image is the nearest discrete grid point in a (W + 1) x (H + 1) grid, obtained by scaling the then rounding. For example, in a 4 x 2 image, the anchor point (0.7, 0.6) resolves to the grid point at (3, 1).

 *-----+-----+-----+-----*
 |     |     |     |     |
 |     |     |     |     |
 +-----+-----+-----+-----+
 |     |     |   X |     |   (U, V) = (0.7, 0.6)
 |     |     |     |     |
 *-----+-----+-----+-----*

 *-----+-----+-----+-----*
 |     |     |     |     |
 |     |     |     |     |
 +-----+-----+-----X-----+   (X, Y) = (3, 1)
 |     |     |     |     |
 |     |     |     |     |
 *-----+-----+-----+-----*
 

Parameters:

u - u-coordinate of the anchor, as a ratio of the image width (in the range [0, 1])

v - v-coordinate of the anchor, as a ratio of the image height (in the range [0, 1])

Returns:

the object for which the method was called, with the new anchor set.

getAnchorU

public float getAnchorU()

Horizontal distance, normalized to [0, 1], of the anchor from the left edge.

Returns:

the u value of the anchor.

getAnchorV

public float getAnchorV()

Vertical distance, normalized to [0, 1], of the anchor from the left edge.

Returns:

the v value of the anchor.

gridPoint

public MarkerOptions gridPoint(GridPoint gp)

Sets the location for the marker.

Returns:

the object for which the method was called, with the new position set.

getGridPoint

public GridPoint getGridPoint()

icon

public MarkerOptions icon(BitmapDescriptor icon)

Sets the icon for the marker.

Parameters:

icon - if null, the default marker is used.

Returns:

the object for which the method was called, with the new icon set.

title

public MarkerOptions title(String title)

Sets the title for the marker.

Parameters:

title -

Returns:

the object for which the method was called, with the new title set.

snippet

public MarkerOptions snippet(String snippet)

Sets the snippet for the marker.

Returns:

the object for which the method was called, with the new snippet set.

visible

public MarkerOptions visible(boolean visible)

Sets the visibility for the marker.

Returns:

the object for which the method was called, with the new visibility state set.

draggable

public MarkerOptions draggable(boolean draggable)

Sets the draggability for the marker.

Returns:

the object for which the method was called, with the new draggable state set.

getIcon

public BitmapDescriptor getIcon()

Gets the custom icon set for this MarkerOptions object.

Returns:

A BitmapDescriptor representing the custom icon, or null if no custom icon is set.

getTitle

public String getTitle()

Gets the title set for this MarkerOptions object.

Returns:

A string containing the marker's title.

getSnippet

public String getSnippet()

Gets the snippet set for this MarkerOptions object.

Returns:

A string containing the marker's snippet.

isVisible

public boolean isVisible()

Gets the visibility setting for this MarkerOptions object.

Returns:

true if the marker is visible; otherwise, returns false.

isDraggable

public boolean isDraggable()

Gets the draggability setting for this MarkerOptions object.

Returns:

true if the marker is draggable; otherwise, returns false.