HudManoeuvreItem
Item to be displayed on the HUD within a specific geographic location
type: object
Properties
Section titled “Properties”| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | HUD item ID |
instruction | string | yes | Text instruction to the user |
nature | MANOEUVRE:TURN:LEFT MANOEUVRE:TURN:LEFT:SLIGHT MANOEUVRE:TURN:LEFT:HARD MANOEUVRE:TURN:RIGHT MANOEUVRE:TURN:RIGHT:SLIGHT MANOEUVRE:TURN:RIGHT:HARD MANOEUVRE:ROUNDABOUT:RIGHT:HARD MANOEUVRE:ROUNDABOUT:RIGHT MANOEUVRE:ROUNDABOUT:RIGHT:SLIGHT MANOEUVRE:ROUNDABOUT:STRAIGHT MANOEUVRE:ROUNDABOUT:LEFT:SLIGHT MANOEUVRE:ROUNDABOUT:LEFT MANOEUVRE:ROUNDABOUT:LEFT:HARD MANOEUVRE:ROUNDABOUT:UTURN MANOEUVRE:RAMP:LEFT MANOEUVRE:RAMP:RIGHT MANOEUVRE:FORK:LEFT MANOEUVRE:FORK:RIGHT MANOEUVRE:STRAIGHT MANOEUVRE:MERGE MANOEUVRE:UTURN MANOEUVRE:OTHER | yes | Manoeuvre nature |
trigger | object | yes | GeoJSON LineString or Polygon representing the area within which this HUD display should be active. If geometry is a LineString, HUD item should be active while user is near the line AND has a similar bearing to the line. If geometry is a Polygon, HUD item should be active while user is within the polygon. |
subjectLocation | object | yes | Lat/lng location of the subject of the item (typically the manoeuvre being instructed) |