com.mappedin.sdk

Class Navigatable

java.lang.Object

com.mappedin.sdk.Navigatable

Direct Known Subclasses:

Coordinate, Location, Polygon

public abstract class Navigatable
extends java.lang.Object

All classes that implement the Navigatable protocol can be navigated to and from any other Navigatable object.

For example, you can navigate from a Coordinate to a Location and you will get a path from that Coordinate to the closest entrance node belonging to that Location. Beyond just pathing to a store, this might also be used for a "take me to the closest washroom" function. You can also navigate from an array of Navigatables to an Array of other Navigatables, and you will get the shortest path between an item in the first group to the second. This allows the ability to do advanced, high level things like "find a place to park that takes you closest to any restaurant".

Constructor Summary

Constructors

Constructor and Description
Navigatable()

Method Summary

Modifier and Type	Method and Description
Directions	directionsFrom(Venue activeVenue, Navigatable origin, Location departFrom, Location arriveAt) Find the shortest path TO this Navigatable FROM another one (accessible defaults to false).
Directions	directionsFrom(Venue activeVenue, Navigatable origin, Location departFrom, Location arriveAt, boolean accessible) Find the shortest path TO this Navigatable FROM another one.
Directions	directionsTo(Venue activeVenue, Navigatable destination, Location departFrom, Location arriveAt) Find the shortest path FROM this Navigable TO another one (accessible defaults to false).
Directions	directionsTo(Venue activeVenue, Navigatable destination, Location departFrom, Location arriveAt, boolean accessible) Find the shortest path FROM this Navigable TO another one.
abstract Coordinate[]	getNavigatableCoordinates()

Methods inherited from class java.lang.Object

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

Constructor Detail

Navigatable

public Navigatable()

Method Detail

getNavigatableCoordinates

public abstract Coordinate[] getNavigatableCoordinates()

directionsTo

public Directions directionsTo(Venue activeVenue,
                               Navigatable destination,
                               Location departFrom,
                               Location arriveAt)

Find the shortest path FROM this Navigable TO another one (accessible defaults to false).

Parameters:

activeVenue - The Venue where this Coordinate belong to.

destination - Where the path should go (Could be Coordinate, Location or Polygon)

departFrom - An optional Location used to help with the direction instructions

arriveAt - An optional Location used to help with the direction instructions

Returns:

Directions

directionsTo

public Directions directionsTo(Venue activeVenue,
                               Navigatable destination,
                               Location departFrom,
                               Location arriveAt,
                               boolean accessible)

Find the shortest path FROM this Navigable TO another one.

Parameters:

activeVenue - The Venue where this Coordinate belong to.

destination - Where the path should go (Could be Coordinate, Location or Polygon)

departFrom - An optional Location used to help with the direction instructions

arriveAt - An optional Location used to help with the direction instructions

accessible - boolean flag shows if the path needs to be accessible or not

Returns:

Directions

directionsFrom

public Directions directionsFrom(Venue activeVenue,
                                 Navigatable origin,
                                 Location departFrom,
                                 Location arriveAt)

Find the shortest path TO this Navigatable FROM another one (accessible defaults to false).

Parameters:

activeVenue - The Venue where this Coordinate belong to.

origin - Where the path should start from

departFrom - An optional Location used to help with direction instructions

arriveAt - An optional Location used to help with direction instructions

Returns:

Directions

directionsFrom

public Directions directionsFrom(Venue activeVenue,
                                 Navigatable origin,
                                 Location departFrom,
                                 Location arriveAt,
                                 boolean accessible)

Find the shortest path TO this Navigatable FROM another one.

Parameters:

activeVenue - The Venue where this Coordinate belong to.

origin - Where the path should start from

departFrom - An optional Location used to help with direction instructions

arriveAt - An optional Location used to help with direction instructions

accessible - boolean flag shows if the path needs to be accessible or not

Returns:

Directions