com.telenav.mapkit

Class Shape

java.lang.Object

com.telenav.mapkit.Shape

Direct Known Subclasses:

Polygon, Polyline

public class Shape
extends Object

This is the class for the Shape object. When you want to add a shape to the map view, you must create an instance of a Shape object, and add it to the Overlay object.

Created by xizhens on 2/28/14. Copyright reserved by Telenav.Inc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Shape.ShapeType The supported shape type by the map view.

Constructor Summary

Constructors

Constructor and Description
Shape(Shape.ShapeType type) This is the default constructor for the Shape object.

Method Summary

Methods

Modifier and Type	Method and Description
ShapeAttribute	getAttribute() This method is used to get the shape attribute for the current shape.
ArrayList<android.location.Location>	getPath() This method is used to get the shape path.
Shape.ShapeType	getType() This method is used to get the type of current shape.
void	setAttribute(ShapeAttribute attribute) This method is used to set the shape attribute for the current shape.
void	setPath(ArrayList<android.location.Location> path) This method is used to update the shape path.
org.json.JSONObject	toJson() This method is used to convert the Shape ojbect to a JSONObject.
int	typeValue(Shape.ShapeType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

Shape

public Shape(Shape.ShapeType type)

This is the default constructor for the Shape object.

Parameters:

type - defines the type of the shape; either polygon or polyline

Method Detail

typeValue

public int typeValue(Shape.ShapeType type)

getPath

public ArrayList<android.location.Location> getPath()

This method is used to get the shape path.

Returns:

arrayList of the location points defining the trace of the shape

setPath

public void setPath(ArrayList<android.location.Location> path)

This method is used to update the shape path.

Parameters:

path - arrayList of the location points defining the trace of the shape

getAttribute

public ShapeAttribute getAttribute()

This method is used to get the shape attribute for the current shape.

Returns:

the shapeattribute object

setAttribute

public void setAttribute(ShapeAttribute attribute)

This method is used to set the shape attribute for the current shape.

Parameters:

attribute - the attribute object you want to use for the current shape

getType

public Shape.ShapeType getType()

This method is used to get the type of current shape.

Returns:

type of the shape; either polygon or polyline

toJson

public org.json.JSONObject toJson()
                           throws org.json.JSONException

This method is used to convert the Shape ojbect to a JSONObject.

Returns:

the JSONObject for the shape

Throws:

org.json.JSONException - if anything goes wrong in the serialization process