com.tomtom.pnd.maplib

Class ImageOverlay

java.lang.Object

com.tomtom.pnd.maplib.Renderable

com.tomtom.pnd.maplib.Primitive

com.tomtom.pnd.maplib.ImageOverlay

public class ImageOverlay
extends Primitive

An ImageOverlay will show an image on top of the map, which will remain fixed to two anchor points: North-West and South-East. The overlay will move with the map, keeping the anchor points fixed on their positions.

Since:

6 (16.1 Fermi)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isValid()
void	remove() Removes the image overlay from the map.
Renderable	selectTopMostRenderableAt(double[] touchPoint, double radius) Returns the renderable at the point provided.
void	setAlpha(int alpha) Sets the transparency for this image overlay.
void	setImage(android.content.Context context, int resourceId) Use the given a resource id of image data for this overlay.
void	setVisibility(boolean isVisible) Sets the visibility of this Renderable.
void	update() Prepare this Renderable for rendering might be better.

Methods inherited from class com.tomtom.pnd.maplib.Primitive

notifyDataChanged, registerDataChangeListener, release, setZIndex, unregisterDataChangeListener

Methods inherited from class com.tomtom.pnd.maplib.Renderable

getTag, getZIndex, isSelectable, isVisible, selectable, setTag

Methods inherited from class java.lang.Object

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

Method Detail

update

public void update()

Description copied from class: Renderable

Prepare this Renderable for rendering might be better.

isValid

public boolean isValid()

Returns:

true if Renderable can be rendered by CustomOverlayRenderer.

remove

public void remove()

Removes the image overlay from the map.

setImage

public void setImage(android.content.Context context,
                     int resourceId)

Use the given a resource id of image data for this overlay.

Parameters:

context - The Context to read the Drawable from.

resourceId - The resource ID of the Drawable to use.

selectTopMostRenderableAt

public Renderable selectTopMostRenderableAt(double[] touchPoint,
                                            double radius)

Description copied from class: Renderable

Returns the renderable at the point provided.

Parameters:

touchPoint - the point to check whether a renderable exists, values in world coordinates.

radius - the touchPoint, where the renderables are checked for, in world coordinates.

Returns:

the renderable at the specified world coordinates, null if no renderable exists.

setVisibility

public void setVisibility(boolean isVisible)

Description copied from class: Renderable

Sets the visibility of this Renderable.

Overrides:

setVisibility in class Renderable

Parameters:

isVisible - If true, then the primitive is visible; if false, it is not.

setAlpha

public void setAlpha(int alpha)

Sets the transparency for this image overlay.

Parameters:

alpha - The alpha/transparency value [0, 255], 0 being fully transparent and 255 being fully opaque.

hashCode

public int hashCode()

Overrides:

hashCode in class Primitive

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Primitive