com.mappedin.sdk

Class Coordinate

java.lang.Object

com.mappedin.sdk.Navigatable

com.mappedin.sdk.Coordinate

All Implemented Interfaces:

Focusable

public class Coordinate
extends Navigatable
implements Focusable

A Coordinate represents a 3-dimensional position, anchored to a specific map. If you want a position that is map-independent, consider the Vector3 class.

See Also:

Vector3, Navigatable, Focusable

Constructor Summary

Constructors

Constructor and Description
Coordinate(android.location.Location geoLocation, Map map) Take a given lat/lon pair and create a Coordinate attaching it to a specific map.
Coordinate(Vector3 vector, Map map) Create a Coordinate using a Vector3 and a Map to attach it to.

Method Summary

Modifier and Type	Method and Description
Map	getMap() The Map this Coordinate belongs to
Coordinate[]	getNavigatableCoordinates()
com.mappedin.sdk.FocusPoints	getPoints() Returns a focusable object's 3D points
Vector3	getVector() Return the 3D position this Coordinate has.
float	getX() Get the coordinate's x value
float	getY() Get the coordinate's y value
float	getZ() Get the coordinate's z value.
boolean	isInside(Polygon polygon) Check if Coordinate is inside the polygon (in 2D space).
float	metersFrom(Coordinate coordinate) Returns the 2D euclidean distance in meters from this Coordinate to another Coordinate.
float	metersFrom(Coordinate[] path) Returns the 2D euclidean distance in meters from this Coordinate to the closest point on a path represented by an array of Coordinate line segments.
float	metersFrom(Polygon polygon) Returns the 2D euclidean distance in meters from this Coordinate to the closest point on the edge of a Polygon.
java.lang.String	toString() Returns a string representation of the 3D position and map.

Methods inherited from class com.mappedin.sdk.Navigatable

directionsFrom, directionsFrom, directionsTo, directionsTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Coordinate

public Coordinate(Vector3 vector,
                  Map map)

Create a Coordinate using a Vector3 and a Map to attach it to.

Parameters:

vector - Vector3 with x, y and z value

map - The specific map this Coordinate should be attached to.

Coordinate

public Coordinate(android.location.Location geoLocation,
                  Map map)

Take a given lat/lon pair and create a Coordinate attaching it to a specific map.
code snip:

 android.location.Location geoLocation = new android.location.Location("Mappedin office");
 geoLocation.setLatitude(43.451648);
 geoLocation.setLongitude(-80.495002);
 Coordinate coordinate = new Coordinate(geoLocation, venue.getMaps()[0]);
 

Parameters:

geoLocation - The Android location object, with latitude and longitude

map - The map this geo-referenced position belongs to.

Method Detail

getMap

public Map getMap()

The Map this Coordinate belongs to

Returns:

Map of the Coordinate

getVector

public Vector3 getVector()

Return the 3D position this Coordinate has.

Returns:

Vector3

getX

public float getX()

Get the coordinate's x value

Returns:

float

getY

public float getY()

Get the coordinate's y value

Returns:

float

getZ

public float getZ()

Get the coordinate's z value. This will typically be 0.

Returns:

float

toString

public java.lang.String toString()

Returns a string representation of the 3D position and map.

Overrides:

toString in class java.lang.Object

Returns:

String with x,y,z value

metersFrom

public float metersFrom(Coordinate coordinate)
                 throws MappedInException

Returns the 2D euclidean distance in meters from this Coordinate to another Coordinate.

Parameters:

coordinate - The other coordinate in the distance calculation

Returns:

2D euclidean distance in meters

Throws:

MappedInException - when two coordinates belongs to different maps.

metersFrom

public float metersFrom(Polygon polygon)
                 throws MappedInException

Returns the 2D euclidean distance in meters from this Coordinate to the closest point on the edge of a Polygon. If negative, the Coordinate is inside the Polygon, if positive the Coordinate is outside.

Parameters:

polygon - The polygon to be used in the distance calculation

Returns:

distance in meters

Throws:

MappedInException - when the coordinate and polygon belongs to different maps.

metersFrom

public float metersFrom(Coordinate[] path)
                 throws MappedInException

Returns the 2D euclidean distance in meters from this Coordinate to the closest point on a path represented by an array of Coordinate line segments.

Parameters:

path - An array of Coordinates that make up the line segments of the path

Returns:

Distance in meters

Throws:

MappedInException - when none of the coordinate in the array is in the same map as this coordinate.

isInside

public boolean isInside(Polygon polygon)

Check if Coordinate is inside the polygon (in 2D space).

Parameters:

polygon - The polygon to be used in the bounds calculation

Returns:

true if the Coordinate is inside the polygon in 2D space. False if outside.

getNavigatableCoordinates

public Coordinate[] getNavigatableCoordinates()

Specified by:

getNavigatableCoordinates in class Navigatable

getPoints

public com.mappedin.sdk.FocusPoints getPoints()

Description copied from interface: Focusable

Returns a focusable object's 3D points

Specified by:

getPoints in interface Focusable

Returns:

FocusPoints