com.tomtom.pnd.maplib

Class RenderableLayer

java.lang.Object

com.tomtom.pnd.maplib.Renderable

com.tomtom.pnd.maplib.RenderableLayer

public class RenderableLayer
extends Renderable

A RenderableLayer is set of Renderable's.

Since:

5 (15.5 Moretti)

Constructor Summary

Constructors

Constructor and Description
RenderableLayer()

Method Summary

Modifier and Type	Method and Description
void	add(Renderable renderable) Adds the specified object at the end of this RenderableLayer.
void	clear() Removes all elements from this RenderableLayer, leaving it empty.
boolean	contains(Renderable renderable) Tests whether this RenderableLayer contains the specified object.
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isEmpty() Returns whether this RenderableLayer contains no elements.
boolean	isValid()
void	onDataChanged(Renderable renderable) This method is called when the entire data set has changed.
void	registerDataChangeListener(com.tomtom.pnd.maplib.DataChangeListener changeListener) Adds new DataChangeListener to Renderable.
void	release() Releases any resources this Renderable acquired, which may include GPU memory.
boolean	remove(Renderable renderable) Removes the first occurrence of the specified object from this RenderableLayer.
Renderable	selectTopMostRenderableAt(double[] touchPoint, double radius) Returns the renderable at the point provided.
void	setZIndex(int zIndex) Sets the zIndex of this Renderable.
int	size() Returns the number of elements in this RenderableLayer.
void	unregisterDataChangeListener(com.tomtom.pnd.maplib.DataChangeListener changeListener) removes DataChangeListener from Renderable.
void	update() Prepare this Renderable for rendering might be better.

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

getTag, getZIndex, isSelectable, isVisible, selectable, setTag, setVisibility

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderableLayer

public RenderableLayer()

Method Detail

add

public void add(Renderable renderable)

Adds the specified object at the end of this RenderableLayer.

Parameters:

renderable - the object to add.

remove

public boolean remove(Renderable renderable)

Removes the first occurrence of the specified object from this RenderableLayer.

Parameters:

renderable - the object to remove.

Returns:

true if this List was modified by this operation, false otherwise.

Throws:

java.lang.UnsupportedOperationException - if removing from this List is not supported.

contains

public boolean contains(Renderable renderable)

Tests whether this RenderableLayer contains the specified object.

Parameters:

renderable - the renderable to search for.

Returns:

true if renderable is an element of this RenderableLayer, false otherwise.

clear

public void clear()

Removes all elements from this RenderableLayer, leaving it empty.

Throws:

java.lang.UnsupportedOperationException - if removing from this RenderableLayer is not supported.

isEmpty

public boolean isEmpty()

Returns whether this RenderableLayer contains no elements.

Returns:

true if this RenderableLayer has no elements, false otherwise.

size

public int size()

Returns the number of elements in this RenderableLayer.

Returns:

the number of elements in this RenderableLayer.

setZIndex

public void setZIndex(int zIndex)

Description copied from class: Renderable

Sets the zIndex of this Renderable. Renderable with higher zIndices are drawn above those with lower indices.

Overrides:

setZIndex in class Renderable

Parameters:

zIndex - the zIndex of this Renderable.

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.

release

public void release()

Description copied from class: Renderable

Releases any resources this Renderable acquired, which may include GPU memory.

registerDataChangeListener

public void registerDataChangeListener(com.tomtom.pnd.maplib.DataChangeListener changeListener)

Description copied from class: Renderable

Adds new DataChangeListener to Renderable.

Parameters:

changeListener - DataChangeListener instance

unregisterDataChangeListener

public void unregisterDataChangeListener(com.tomtom.pnd.maplib.DataChangeListener changeListener)

Description copied from class: Renderable

removes DataChangeListener from Renderable.

Parameters:

changeListener - DataChangeListener instance

onDataChanged

public void onDataChanged(Renderable renderable)

This method is called when the entire data set has changed.

Parameters:

renderable - the renderable that has changed.

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Renderable

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Renderable