com.google.maps.android.data

Class Renderer

java.lang.Object

com.google.maps.android.data.Renderer

Direct Known Subclasses:

GeoJsonRenderer, KmlRenderer

public class Renderer
extends java.lang.Object

An abstraction that shares the common properties of KmlRenderer and GeoJsonRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Renderer.ImagesCache

Constructor Summary

Constructors

Constructor and Description
Renderer(GoogleMap map, android.content.Context context, MarkerManager markerManager, PolygonManager polygonManager, PolylineManager polylineManager, GroundOverlayManager groundOverlayManager, Renderer.ImagesCache imagesCache) Creates a new Renderer object for KML features
Renderer(GoogleMap map, java.util.HashMap<? extends Feature,java.lang.Object> features, MarkerManager markerManager, PolygonManager polygonManager, PolylineManager polylineManager, GroundOverlayManager groundOverlayManager) Creates a new Renderer object for GeoJSON features

Method Summary

Modifier and Type	Method and Description
protected void	addFeature(Feature feature) Adds a new Feature to the map if its geometry property is not null.
protected java.lang.Object	addGeoJsonFeatureToMap(Feature feature, Geometry geometry) Adds a new object onto the map using the Geometry for the coordinates and the Feature for the styles.
protected java.lang.Object	addKmlPlacemarkToMap(KmlPlacemark placemark, Geometry geometry, KmlStyle style, KmlStyle inlineStyle, boolean isVisible) Adds a single geometry object to the map with its specified style (used for KML)
void	assignStyleMap(java.util.HashMap<java.lang.String,java.lang.String> styleMap, java.util.HashMap<java.lang.String,KmlStyle> styles) Iterates through a list of styles and assigns a style
protected GroundOverlay	attachGroundOverlay(GroundOverlayOptions groundOverlayOptions) Adds a ground overlay to the map
protected void	cacheBitmap(java.lang.String url, android.graphics.Bitmap bitmap) Cache loaded bitmap images
protected void	checkClearBitmapCache() Clear bitmap cache if no active image downloads remain.
protected void	clearStylesRenderer() Removes all the mappings from the mStylesRenderer hashmap
protected void	downloadFinished() Decrement active download count and check if bitmap cache should be cleared
protected void	downloadStarted() Increment active download count
protected java.util.HashMap<? extends Feature,java.lang.Object>	getAllFeatures() Gets a hashmap of all the features and objects that are on this layer
protected BitmapDescriptor	getCachedGroundOverlayImage(java.lang.String url) Gets a cached image needed for GroundOverlays images
protected BitmapDescriptor	getCachedMarkerImage(java.lang.String url, double scale) Gets a cached image at the specified scale which is needed for Marker icon images.
protected java.util.ArrayList<KmlContainer>	getContainerList() Gets the list of KmlContainers that are on the current layer
java.util.Set<Feature>	getFeatures() Gets a set containing Features
java.util.HashMap<KmlGroundOverlay,GroundOverlay>	getGroundOverlayMap() Gets the ground overlays on the current layer
GoogleMap	getMap() Gets the GoogleMap that Feature objects are being placed on
protected java.util.Set<java.lang.String>	getMarkerIconUrls() Gets the URLs stored for the Marker icons
protected KmlStyle	getPlacemarkStyle(java.lang.String styleId) Obtains the styleUrl from a placemark and finds the corresponding style in a list
protected static boolean	getPlacemarkVisibility(Feature feature) Gets the visibility of the placemark if it is specified.
protected java.util.HashMap<java.lang.String,java.lang.String>	getStyleMaps() Gets the styles for KML placemarks
protected java.util.HashMap<java.lang.String,KmlStyle>	getStylesRenderer() Gets the styles for KML placemarks
java.util.Collection<java.lang.Object>	getValues() getValues is called to retrieve the values stored in the mFeatures hashmap.
protected boolean	hasFeatures() Checks if the layer contains placemarks
boolean	isLayerOnMap() Checks if layer has been added to map
protected void	putContainerFeature(java.lang.Object mapObject, Feature placemark)
protected void	putFeatures(Feature feature, java.lang.Object object) Adds a new mapping to the mFeatures hashmap
protected void	putStyles() Adds mStyles to the mStylesRenderer
protected void	putStyles(java.util.HashMap<java.lang.String,KmlStyle> styles) Stores new mappings into the mStylesRenderer hashmap
protected void	removeFeature(Feature feature) Removes a Feature from the map if its geometry property is not null
protected void	removeFeatures(java.util.HashMap<? extends Feature,java.lang.Object> features) Removes all given Features from the map and clears all stored features.
protected void	removeFromMap(java.lang.Object mapObject) Given a Marker, Polyline, Polygon or an array of these and removes it from the map
protected void	removeGroundOverlays(java.util.HashMap<KmlGroundOverlay,GroundOverlay> groundOverlays) Removes all ground overlays in the given hashmap
protected void	setLayerVisibility(boolean layerOnMap) Sets the visibility of the layer
void	setMap(GoogleMap map) Sets the map that objects are being placed on
protected void	storeData(java.util.HashMap<java.lang.String,KmlStyle> styles, java.util.HashMap<java.lang.String,java.lang.String> styleMaps, java.util.HashMap<KmlPlacemark,java.lang.Object> features, java.util.ArrayList<KmlContainer> folders, java.util.HashMap<KmlGroundOverlay,GroundOverlay> groundOverlays) Stores all given data

Methods inherited from class java.lang.Object

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

Constructor Detail

Renderer

public Renderer(GoogleMap map,
                android.content.Context context,
                MarkerManager markerManager,
                PolygonManager polygonManager,
                PolylineManager polylineManager,
                GroundOverlayManager groundOverlayManager,
                Renderer.ImagesCache imagesCache)

Creates a new Renderer object for KML features

Parameters:

map - map to place objects on

context - the Context

markerManager - marker manager to create marker collection from

polygonManager - polygon manager to create polygon collection from

polylineManager - polyline manager to create polyline collection from

groundOverlayManager - ground overlay manager to create ground overlay collection from

imagesCache - an optional ImagesCache to be used for caching images fetched

Renderer

public Renderer(GoogleMap map,
                java.util.HashMap<? extends Feature,java.lang.Object> features,
                MarkerManager markerManager,
                PolygonManager polygonManager,
                PolylineManager polylineManager,
                GroundOverlayManager groundOverlayManager)

Creates a new Renderer object for GeoJSON features

Parameters:

map - map to place objects on

features - contains a hashmap of features and objects that will go on the map

markerManager - marker manager to create marker collection from

polygonManager - polygon manager to create polygon collection from

polylineManager - polyline manager to create polyline collection from

groundOverlayManager - ground overlay manager to create ground overlay collection from

Method Detail

isLayerOnMap

public boolean isLayerOnMap()

Checks if layer has been added to map

Returns:

true if layer is on map, false otherwise

setLayerVisibility

protected void setLayerVisibility(boolean layerOnMap)

Sets the visibility of the layer

Parameters:

layerOnMap - contains true if the layer should be set to visible and false otherwise

getMap

public GoogleMap getMap()

Gets the GoogleMap that Feature objects are being placed on

Returns:

GoogleMap

setMap

public void setMap(GoogleMap map)

Sets the map that objects are being placed on

Parameters:

map - map to place all objects on

putContainerFeature

protected void putContainerFeature(java.lang.Object mapObject,
                                   Feature placemark)

getFeatures

public java.util.Set<Feature> getFeatures()

Gets a set containing Features

Returns:

set containing Features

getValues

public java.util.Collection<java.lang.Object> getValues()

getValues is called to retrieve the values stored in the mFeatures hashmap.

Returns:

mFeatures.values() collection of values stored in mFeatures

getAllFeatures

protected java.util.HashMap<? extends Feature,java.lang.Object> getAllFeatures()

Gets a hashmap of all the features and objects that are on this layer

Returns:

mFeatures hashmap

getMarkerIconUrls

protected java.util.Set<java.lang.String> getMarkerIconUrls()

Gets the URLs stored for the Marker icons

Returns:

mMarkerIconUrls Set of URLs

getStylesRenderer

protected java.util.HashMap<java.lang.String,KmlStyle> getStylesRenderer()

Gets the styles for KML placemarks

Returns:

mStylesRenderer hashmap containing styles for KML placemarks (String, KmlStyle)

getStyleMaps

protected java.util.HashMap<java.lang.String,java.lang.String> getStyleMaps()

Gets the styles for KML placemarks

Returns:

mStyleMaps hashmap containing styles for KML placemarks (String, String)

getCachedMarkerImage

protected BitmapDescriptor getCachedMarkerImage(java.lang.String url,
                                                double scale)

Gets a cached image at the specified scale which is needed for Marker icon images. If a BitmapDescriptor doesn't exist in the cache, the Bitmap for the URL from the bitmap cache is scaled and cached as a BitmapDescriptor.

Parameters:

url - URL to get cached image for

scale - scale to get image at

Returns:

scaled BitmapDescriptor

getCachedGroundOverlayImage

protected BitmapDescriptor getCachedGroundOverlayImage(java.lang.String url)

Gets a cached image needed for GroundOverlays images

Parameters:

url - URL to get cached image for

Returns:

BitmapDescriptor

getGroundOverlayMap

public java.util.HashMap<KmlGroundOverlay,GroundOverlay> getGroundOverlayMap()

Gets the ground overlays on the current layer

Returns:

mGroundOverlayMap hashmap contains the ground overlays

getContainerList

protected java.util.ArrayList<KmlContainer> getContainerList()

Gets the list of KmlContainers that are on the current layer

Returns:

mContainers list of KmlContainers

getPlacemarkStyle

protected KmlStyle getPlacemarkStyle(java.lang.String styleId)

Obtains the styleUrl from a placemark and finds the corresponding style in a list

Parameters:

styleId - StyleUrl from a placemark

Returns:

Style which corresponds to an ID

putFeatures

protected void putFeatures(Feature feature,
                           java.lang.Object object)

Adds a new mapping to the mFeatures hashmap

Parameters:

feature - Feature to be added onto the map

object - Corresponding map object to this feature

putStyles

protected void putStyles()

Adds mStyles to the mStylesRenderer

putStyles

protected void putStyles(java.util.HashMap<java.lang.String,KmlStyle> styles)

Stores new mappings into the mStylesRenderer hashmap

Parameters:

styles - hashmap of strings and KmlStyles to be added to mStylesRenderer

cacheBitmap

protected void cacheBitmap(java.lang.String url,
                           android.graphics.Bitmap bitmap)

Cache loaded bitmap images

Parameters:

url - image URL

bitmap - image bitmap

downloadStarted

protected void downloadStarted()

Increment active download count

downloadFinished

protected void downloadFinished()

Decrement active download count and check if bitmap cache should be cleared

checkClearBitmapCache

protected void checkClearBitmapCache()

Clear bitmap cache if no active image downloads remain. All images should be loaded, scaled, and cached as BitmapDescriptors at this point.

hasFeatures

protected boolean hasFeatures()

Checks if the layer contains placemarks

Returns:

true if there are placemarks, false otherwise

removeFeatures

protected void removeFeatures(java.util.HashMap<? extends Feature,java.lang.Object> features)

Removes all given Features from the map and clears all stored features.

Parameters:

features - features to remove

removeGroundOverlays

protected void removeGroundOverlays(java.util.HashMap<KmlGroundOverlay,GroundOverlay> groundOverlays)

Removes all ground overlays in the given hashmap

Parameters:

groundOverlays - hashmap of ground overlays to remove

removeFeature

protected void removeFeature(Feature feature)

Removes a Feature from the map if its geometry property is not null

Parameters:

feature - feature to remove from map

clearStylesRenderer

protected void clearStylesRenderer()

Removes all the mappings from the mStylesRenderer hashmap

storeData

protected void storeData(java.util.HashMap<java.lang.String,KmlStyle> styles,
                         java.util.HashMap<java.lang.String,java.lang.String> styleMaps,
                         java.util.HashMap<KmlPlacemark,java.lang.Object> features,
                         java.util.ArrayList<KmlContainer> folders,
                         java.util.HashMap<KmlGroundOverlay,GroundOverlay> groundOverlays)

Stores all given data

Parameters:

styles - hashmap of styles

styleMaps - hashmap of style maps

features - hashmap of features

folders - array of containers

groundOverlays - hashmap of ground overlays

addFeature

protected void addFeature(Feature feature)

Adds a new Feature to the map if its geometry property is not null.

Parameters:

feature - feature to add to the map

removeFromMap

protected void removeFromMap(java.lang.Object mapObject)

Given a Marker, Polyline, Polygon or an array of these and removes it from the map

Parameters:

mapObject - map object or array of map objects to remove from the map

addGeoJsonFeatureToMap

protected java.lang.Object addGeoJsonFeatureToMap(Feature feature,
                                                  Geometry geometry)

Adds a new object onto the map using the Geometry for the coordinates and the Feature for the styles. (used for GeoJson)

Parameters:

feature - feature to get geometry style

geometry - geometry to add to the map

addKmlPlacemarkToMap

protected java.lang.Object addKmlPlacemarkToMap(KmlPlacemark placemark,
                                                Geometry geometry,
                                                KmlStyle style,
                                                KmlStyle inlineStyle,
                                                boolean isVisible)

Adds a single geometry object to the map with its specified style (used for KML)

Parameters:

geometry - defines the type of object to add to the map

style - defines styling properties to add to the object when added to the map

Returns:

the object that was added to the map, this is a Marker, Polyline, Polygon or an array of either objects

getPlacemarkVisibility

protected static boolean getPlacemarkVisibility(Feature feature)

Gets the visibility of the placemark if it is specified. A visibility value of "1" corresponds as "true", a visibility value of "0" corresponds as false. If the visibility is not set, the method returns "true".

Parameters:

feature - Feature to obtain visibility from.

Returns:

False if a Feature has a visibility value of "1", true otherwise.

assignStyleMap

public void assignStyleMap(java.util.HashMap<java.lang.String,java.lang.String> styleMap,
                           java.util.HashMap<java.lang.String,KmlStyle> styles)

Iterates through a list of styles and assigns a style

Parameters:

styleMap -

styles -

attachGroundOverlay

protected GroundOverlay attachGroundOverlay(GroundOverlayOptions groundOverlayOptions)

Adds a ground overlay to the map

Parameters:

groundOverlayOptions - GroundOverlay style options to be added to the map

Returns:

new GroundOverlay object created from the given GroundOverlayOptions