BitmapDescriptorFactory

AI-generated Key Takeaways

• BitmapDescriptorFactory is used to create Bitmap image definitions for marker icons and ground overlays in Google Maps for Android.

• Before using this class, ensure it's initialized by either obtaining a GoogleMap instance or calling MapsInitializer.initialize().

• Provides methods to create BitmapDescriptor objects from various sources such as assets, files, resources, and bitmaps.

• Includes predefined hue values for colorizing the default marker image (e.g., HUE_YELLOW, HUE_RED).

• BitmapDescriptor objects are used to visually represent markers and ground overlays on the map.

public final class BitmapDescriptorFactory extends Object

Used to create a definition of a Bitmap image, used for marker icons and ground overlays.

Prior to using any methods from this class, you must do one of the following to ensure that this class is initialized:

• Wait for a GoogleMap to become available from a MapFragment or MapView that you have added to your application. You can obtain the GoogleMap instance by calling getMapAsync() and waiting for the onMapReady(GoogleMap map) callback.
• Call MapsInitializer.initialize(Context). As long as a GooglePlayServicesNotAvailableException isn't thrown, this class will be correctly initialized.

Constant Summary

float	HUE_AZURE
float	HUE_BLUE
float	HUE_CYAN
float	HUE_GREEN
float	HUE_MAGENTA
float	HUE_ORANGE
float	HUE_RED
float	HUE_ROSE
float	HUE_VIOLET
float	HUE_YELLOW

Public Method Summary

static BitmapDescriptor	defaultMarker(float hue) Creates a BitmapDescriptor that refers to a colorization of the default marker image.
static BitmapDescriptor	defaultMarker() Creates a BitmapDescriptor that refers to the default marker image.
static BitmapDescriptor	fromAsset(String assetName) Creates a BitmapDescriptor using the name of a Bitmap image in the assets directory.
static BitmapDescriptor	fromBitmap(Bitmap image) Creates a BitmapDescriptor from a given Bitmap image.
static BitmapDescriptor	fromFile(String fileName) Creates a BitmapDescriptor using the name of a Bitmap image file located in the internal storage.
static BitmapDescriptor	fromPath(String absolutePath) Creates a BitmapDescriptor from the absolute file path of a Bitmap image.
static BitmapDescriptor	fromResource(int resourceId) Creates a BitmapDescriptor using the resource ID of a Bitmap image.

Inherited Method Summary

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Constants

public static final float HUE_AZURE

Constant Value: 210.0

public static final float HUE_BLUE

Constant Value: 240.0

public static final float HUE_CYAN

Constant Value: 180.0

public static final float HUE_GREEN

Constant Value: 120.0

public static final float HUE_MAGENTA

Constant Value: 300.0

public static final float HUE_ORANGE

Constant Value: 30.0

public static final float HUE_RED

Constant Value: 0.0

public static final float HUE_ROSE

Constant Value: 330.0

public static final float HUE_VIOLET

Constant Value: 270.0

public static final float HUE_YELLOW

Constant Value: 60.0

Public Methods

public static BitmapDescriptor defaultMarker (float hue)

Creates a BitmapDescriptor 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. Value must be greater or equal to 0 and less than 360.

public static BitmapDescriptor defaultMarker ()

Creates a BitmapDescriptor that refers to the default marker image.

public static BitmapDescriptor fromAsset (String assetName)

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

Parameters

assetName	The name of a Bitmap image in the assets directory.

Returns

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

public static BitmapDescriptor fromBitmap (Bitmap image)

Creates a BitmapDescriptor from a given Bitmap image.

Parameters

image

public static BitmapDescriptor fromFile (String fileName)

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

Parameters

fileName	The name of the Bitmap image file.

Returns

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

See Also

• Using the Internal Storage

public static BitmapDescriptor fromPath (String absolutePath)

Creates a BitmapDescriptor from the absolute file path of a Bitmap image.

Parameters

absolutePath	The absolute path of the Bitmap image.

Returns

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

public static BitmapDescriptor fromResource (int resourceId)

Creates a BitmapDescriptor using the resource ID of a Bitmap image.

Parameters

resourceId	The resource ID of a Bitmap image.

Returns

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