uk.co.ordnancesurvey.android.maps

Class BitmapDescriptorFactory

java.lang.Object

uk.co.ordnancesurvey.android.maps.BitmapDescriptorFactory

public final class BitmapDescriptorFactory
extends Object

Used to create a definition of an image, used for marker icons.

Field Summary

Fields

Modifier and Type	Field and Description
static float	HUE_AZURE Constant value: 210.0
static float	HUE_BLUE Constant value: 240.0
static float	HUE_CYAN Constant value: 180.0
static float	HUE_GREEN Constant value: 120.0
static float	HUE_MAGENTA Constant value: 300.0
static float	HUE_ORANGE Constant value: 30.0
static float	HUE_RED Constant value: 0.0
static float	HUE_ROSE Constant value: 330.0
static float	HUE_VIOLET Constant value: 270.0
static float	HUE_YELLOW Constant value: 60.0

Method Summary

Methods

Modifier and Type	Method and Description
static BitmapDescriptor	defaultMarker() Creates a bitmap descriptor that refers to the default marker image.
static BitmapDescriptor	defaultMarker(float hue) Creates a bitmap descriptor that refers to a colorization of the default marker image.
static BitmapDescriptor	fromAsset(String assetName) Creates a BitmapDescriptor using the name of an image in the assets directory.
static BitmapDescriptor	fromBitmap(android.graphics.Bitmap image) Creates a bitmap descriptor from a given image.
static BitmapDescriptor	fromFile(String fileName) Creates a BitmapDescriptor using the name of an image file located in the internal storage.
static BitmapDescriptor	fromPath(String path) Creates a BitmapDescriptor from an absolute file path.
static BitmapDescriptor	fromResource(int resourceId) Creates a BitmapDescriptor using the resource id of an image.

Methods inherited from class java.lang.Object

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

Field Detail

HUE_AZURE

public static final float HUE_AZURE

Constant value: 210.0

See Also:

Constant Field Values

HUE_BLUE

public static final float HUE_BLUE

Constant value: 240.0

See Also:

Constant Field Values

HUE_CYAN

public static final float HUE_CYAN

Constant value: 180.0

See Also:

Constant Field Values

HUE_GREEN

public static final float HUE_GREEN

Constant value: 120.0

See Also:

Constant Field Values

HUE_MAGENTA

public static final float HUE_MAGENTA

Constant value: 300.0

See Also:

Constant Field Values

HUE_ORANGE

public static final float HUE_ORANGE

Constant value: 30.0

See Also:

Constant Field Values

HUE_RED

public static final float HUE_RED

Constant value: 0.0

See Also:

Constant Field Values

HUE_ROSE

public static final float HUE_ROSE

Constant value: 330.0

See Also:

Constant Field Values

HUE_VIOLET

public static final float HUE_VIOLET

Constant value: 270.0

See Also:

Constant Field Values

HUE_YELLOW

public static final float HUE_YELLOW

Constant value: 60.0

See Also:

Constant Field Values

Method Detail

defaultMarker

public static BitmapDescriptor defaultMarker()

Creates a bitmap descriptor that refers to the default marker image.

defaultMarker

public static BitmapDescriptor defaultMarker(float hue)

Creates a bitmap descriptor that refers to a colorization of the default marker image. For convenience, there is a predefined set of hue values. See example HUE_YELLOW.

Parameters:

hue - The hue of the marker which must be in the range 0 <= hue < 360

Returns:

a bitmap descriptor

fromAsset

public static BitmapDescriptor fromAsset(String assetName)

Creates a BitmapDescriptor using the name of an image in the assets directory.

Parameters:

assetName - The name of an image in the assets directory.

Returns:

the BitmapDescriptor that was loaded from the asset or null if failed to load.

fromBitmap

public static BitmapDescriptor fromBitmap(android.graphics.Bitmap image)

Creates a bitmap descriptor from a given image.

fromFile

public static BitmapDescriptor fromFile(String fileName)

Creates a BitmapDescriptor using the name of an image file located in the internal storage. In particular, this calls Context.openFileInput(String).

Parameters:

fileName - The name of the image file.

Returns:

the BitmapDescriptor that was loaded from the asset or null if failed to load.

fromPath

public static BitmapDescriptor fromPath(String path)

Creates a BitmapDescriptor from an absolute file path.

Parameters:

path - The absolute path of the image.

Returns:

the BitmapDescriptor that was loaded from the absolute path or null if failed to load.

fromResource

public static BitmapDescriptor fromResource(int resourceId)

Creates a BitmapDescriptor using the resource id of an image.

Parameters:

resourceId - The resource id of an image.

Returns:

the BitmapDescriptor that was loaded from the asset or null if failed to load.