com.tomtom.pnd.maplib

Class Polygon

java.lang.Object

com.tomtom.pnd.maplib.Renderable

com.tomtom.pnd.maplib.Primitive

com.tomtom.pnd.maplib.Polygon

public class Polygon
extends Primitive

A polygon is an enclosed shape that can be used to highlight areas on the map.

Since:

5 (15.5 Moretti)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getBorderColor() Gets the border color of this polygon.
float	getBorderWidth() Gets the border width of this polygon.
int	getFillColor() Gets the fill color of this polygon.
int	hashCode()
boolean	isValid()
boolean	needsRebuilding() Whether or not this renderable needs to be rebuilt.
void	remove() Removes the polygon from the map.
protected void	requestRebuilding() Sets the flag that indicates that this renderable needs to be rebuilt because some property changed which does not support on the fly modification.
Renderable	selectTopMostRenderableAt(double[] touchPoint, double radius) Returns the renderable at the point provided.
void	setBorderColor(int color) Sets the border color of this polygon.
void	setBorderWidth(float width) Sets the border width of this polygon.
void	setFillColor(int color) Sets the fill color of this polygon.
void	setTexture(android.content.Context context, int resourceId) Use the given a resource id as the image to fill this polygon with; so sets a texture to fill polygon with.
void	setTextureAlpha(int textureAlpha) Sets a transparency for polygon texture.
void	setVisibility(boolean isVisible) Sets the visibility of this Renderable.
void	setZIndex(int zIndex) Sets the zIndex 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, 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

needsRebuilding

public boolean needsRebuilding()

Whether or not this renderable needs to be rebuilt. This is required because some properties of the renderable cannot change on the fly, but they require the renderable to be rebuilt. This method also resets the flag to false.

Returns:

the value of the flag.

requestRebuilding

protected void requestRebuilding()

Sets the flag that indicates that this renderable needs to be rebuilt because some property changed which does not support on the fly modification.

setBorderColor

public void setBorderColor(int color)

Sets the border color of this polygon.

Parameters:

color - The color in ARGB format

getBorderColor

public int getBorderColor()

Gets the border color of this polygon.

Returns:

the color in ARGB format.

setFillColor

public void setFillColor(int color)

Sets the fill color of this polygon.

Parameters:

color - The color in ARGB format

getFillColor

public int getFillColor()

Gets the fill color of this polygon.

Returns:

the color in ARGB format.

setBorderWidth

public void setBorderWidth(float width)

Sets the border width of this polygon.

Parameters:

width - the width in screen pixels

getBorderWidth

public float getBorderWidth()

Gets the border width of this polygon.

Returns:

the border width in ARGB format.

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 polygon from the map.

setTexture

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

Use the given a resource id as the image to fill this polygon with; so sets a texture to fill polygon with.

Parameters:

context - The Context to read the Drawable from.

resourceId - The resource ID of the Drawable to use.

setZIndex

public final 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 Primitive

Parameters:

zIndex - the zIndex of this Renderable.

setTextureAlpha

public void setTextureAlpha(int textureAlpha)

Sets a transparency for polygon texture. Texture should be set with setTexture(Context, int).

Parameters:

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

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Primitive

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Primitive