| com.steerpath.sdk.directions.RouteStep |
A route is made up out of steps describing what actions a user needs to take to follow the route.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| @interface | RouteStep.Action | ||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ACTION_CONTINUE | "Continue with previous action" | |||||||||
| String | ACTION_DESTINATION | User has reached destination. | |||||||||
| String | ACTION_ENTER | Think "enter" as "enter an area". | |||||||||
| String | ACTION_GO | At first glance, "go" is conceptually pretty close to "enter". | |||||||||
| String | ACTION_GO_DOWN | Walk stairs down. | |||||||||
| String | ACTION_GO_UP | Walk stairs up. | |||||||||
| String | ACTION_NONE | No action needed. | |||||||||
| String | ACTION_REROUTE | Reroute helper. | |||||||||
| String | ACTION_TURN_LEFT | Circa 45 degree turn left. | |||||||||
| String | ACTION_TURN_RIGHT | Circa 45 degree turn right. | |||||||||
| String | ACTION_TURN_SHARP_LEFT | Circa 60 degree turn left. | |||||||||
| String | ACTION_TURN_SHARP_RIGHT | Circa 60 degree turn right. | |||||||||
| String | ACTION_TURN_SLIGHT_LEFT | Circa 30 degree turn left. | |||||||||
| String | ACTION_TURN_SLIGHT_RIGHT | Circa 30 degree turn right. | |||||||||
| String | ACTION_WAYPOINT | User has reached waypoint. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String |
getAction()
Retrieve Action
| ||||||||||
| abstract String |
getBuildingRef()
Retrieve building reference for this RouteStep.
| ||||||||||
| abstract List<LatLng> |
getCoordinates()
Retrieve coordinates.
| ||||||||||
| abstract String |
getDestinationName()
Retrieve the name of destination, i.e "MacDonald's" or "Floor 3"
| ||||||||||
| abstract String |
getDirection()
Retrieves information if travel direction is ascending or descending, i.e "up" or "down".
| ||||||||||
| abstract double |
getDistance()
Retrieve the distance travelled within this step.
| ||||||||||
| abstract double |
getDuration()
Retrieve the duration of this step, in seconds.
| ||||||||||
| abstract int |
getFloor()
Retrive floor index.
| ||||||||||
| abstract JSONObject |
getPolyline()
Retrieve a GeoJSON polyline geometry describing this step.
| ||||||||||
| abstract String |
getTravelType()
Retrieve travel type.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
| |||||||||||
"Continue with previous action"
User has reached destination. User of the SDK may propose user to do something special when this event is triggered.
Think "enter" as "enter an area". For example "enter Floor 3 (from elevator)".
At first glance, "go" is conceptually pretty close to "enter". "Go" refers to taking some (non-walk) vehicle, for example elevator, escalator, skytrain or whatever.
Walk stairs down.
Walk stairs up.
No action needed. In practice, this can be "waiting for something".
Reroute helper.
Circa 45 degree turn left.
Circa 45 degree turn right.
Circa 60 degree turn left.
Circa 60 degree turn right.
Circa 30 degree turn left.
Circa 30 degree turn right.
User has reached waypoint. User of the SDK may propose user to do something special when this event is triggered.
Retrieve Action
Retrieve building reference for this RouteStep.
Retrieve coordinates. Provided for convenience.
Retrieve the name of destination, i.e "MacDonald's" or "Floor 3"
Retrieves information if travel direction is ascending or descending, i.e "up" or "down".
Retrieve the distance travelled within this step.
Retrieve the duration of this step, in seconds.
Retrive floor index. Provided for convenience.
Retrieve a GeoJSON polyline geometry describing this step. The coordinate's are triplets where the third element represents the level.
Retrieve travel type. Travel type comes from the Steerpath server and may vary between different projects. For example, if your project has two buildings and transportation between buildings happens with, say, by levitation. Levitation is very specific to your project - no one else has that. We may still add that to your server configuration as one travel type and app has a chance to deal with it. Common travel types: elevator stairs escalator walk