com.mappedin.sdk

Class Map

java.lang.Object

com.mappedin.sdk.Map

All Implemented Interfaces:

Focusable

public class Map
extends java.lang.Object
implements Focusable

A Map belonging to a specific Venue. Typically represents a certain floor. Give this to a MapView to display to the user.

The elevation property can be used to determine the order of the floors (first, second, etc).

Method Summary

Modifier and Type	Method and Description
float	getAltitude() Altitude of the map, used to get map's altitude
int	getFloor() Floor of the map, used to sort floors
float	getHeading() Heading of the map in radians, used to get map's heading.
java.lang.String	getName() Name of a map (First floor, Second Floor, etc)
com.mappedin.sdk.FocusPoints	getPoints() Returns a focusable object's 3D points
Polygon[]	getPolygons() Gets an array of Polygons in this map
java.lang.String	getShortName() A shorter name to display in a drop down menu (etc.) if the actual name is too long
Venue	getVenue() Returns the Venue of this Location
java.lang.Boolean	insideMapBoundary(Coordinate coordinate) Returns true if a coordinate is within the boundaries of the map's world
boolean	mapReady() Check if all 3D Objects in this map has been loaded

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Name of a map (First floor, Second Floor, etc)

Returns:

String of map name

getShortName

public java.lang.String getShortName()

A shorter name to display in a drop down menu (etc.) if the actual name is too long

Returns:

String

getFloor

public int getFloor()

Floor of the map, used to sort floors

Returns:

int

getAltitude

public float getAltitude()

Altitude of the map, used to get map's altitude

Returns:

float

getHeading

public float getHeading()

Heading of the map in radians, used to get map's heading. (0 points to the north)

Returns:

float angle to the north

getVenue

public Venue getVenue()

Returns the Venue of this Location

mapReady

public boolean mapReady()

Check if all 3D Objects in this map has been loaded

Returns:

boolean

getPolygons

public Polygon[] getPolygons()

Gets an array of Polygons in this map

Returns:

array of Polygon

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

insideMapBoundary

public java.lang.Boolean insideMapBoundary(Coordinate coordinate)

Returns true if a coordinate is within the boundaries of the map's world