com.tomtom.pnd.maplib

Class RenderableLayer

java.lang.Object

com.tomtom.pnd.maplib.RenderableLayer

All Implemented Interfaces:

Renderable

public class RenderableLayer
extends java.lang.Object
implements Renderable

A RenderableLayer is set of Renderable's.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
RenderableLayer()

Method Summary

Methods

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.
int	getZIndex() Gets the zIndex of this Renderable.
boolean	isEmpty() Returns whether this RenderableLayer contains no elements.
boolean	isValid()
boolean	isVisible() Returns the visibility of this Renderable.
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.
void	render(com.tomtom.pnd.maplib.Renderer renderer) Renders this Renderable, using whatever state the OpenGL context is in.
void	setVisibility(boolean isVisible) Sets the visibility of this Renderable.
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 java.lang.Object

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

Field Detail

TAG

protected static final java.lang.String TAG

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 interface: Renderable

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

Specified by:

setZIndex in interface Renderable

Parameters:

zIndex - the zIndex of this Renderable.

getZIndex

public int getZIndex()

Description copied from interface: Renderable

Gets the zIndex of this Renderable.

Specified by:

getZIndex in interface Renderable

Returns:

the zIndex of the Renderable.

setVisibility

public void setVisibility(boolean isVisible)

Description copied from interface: Renderable

Sets the visibility of this Renderable.

Specified by:

setVisibility in interface Renderable

Parameters:

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

isVisible

public boolean isVisible()

Description copied from interface: Renderable

Returns the visibility of this Renderable.

Specified by:

isVisible in interface Renderable

Returns:

true if the primitive is to be visible; false if it is not.

update

public void update()

Description copied from interface: Renderable

Prepare this Renderable for rendering might be better.

Specified by:

update in interface Renderable

isValid

public boolean isValid()

Specified by:

isValid in interface Renderable

Returns:

true if Renderable can be rendered by CustomOverlayRenderer.

render

public void render(com.tomtom.pnd.maplib.Renderer renderer)

Description copied from interface: Renderable

Renders this Renderable, using whatever state the OpenGL context is in.

Specified by:

render in interface Renderable

Parameters:

renderer - The Renderer's instance that renders this Renderable.

release

public void release()

Description copied from interface: Renderable

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

Specified by:

release in interface Renderable

registerDataChangeListener

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

Description copied from interface: Renderable

Adds new DataChangeListener to Renderable.

Specified by:

registerDataChangeListener in interface Renderable

Parameters:

changeListener - DataChangeListener instance

unregisterDataChangeListener

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

Description copied from interface: Renderable

removes DataChangeListener from Renderable.

Specified by:

unregisterDataChangeListener in interface 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.