Package globus.glroute
Class GLRouteManeuver
java.lang.Object
globus.glmap.GLNativeObject
globus.glroute.GLRouteManeuver
GLMapRouteManeuver
holds data for a route maneuver.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic @interface
Represents the type of instruction for a maneuver.static @interface
`TurnLaneMask` is a type to represent different lane directions.static @interface
Represents the maneuver type. -
Method Summary
Modifier and TypeMethodDescriptionint
getActiveTurnAtLine
(int lane) Returns active turn directions for a lane that should be used to follow the route without requiring additional lane changes.End point of maneuverdouble
getEqualLength
(GLRouteManeuver other) Calculates equal length with other maneuvergetInstruction
(int type) Get instructionint
Number of lanesdouble
Maneuver length in metersint
The spoke to exit roundabout after entering.Short instruction for UI.Start point of maneuverdouble
getTime()
Estimated time along the maneuver in seconds.Text for use in UI.int
getTurnDirectionsAtLane
(int lane) Returns possible turn directions for a specific lane.int
getType()
Type of the maneuver see Valhalla API reference for detailsint
getValidTurnAtLine
(int lane) Returns valid turn directions for a lane that can be used to follow the route initially.Text suitable for use as a verbal message immediately after the maneuver transition.Text suitable for use as a verbal message immediately prior to the maneuver transition.Text suitable for use as a verbal alert in a navigation application.Methods inherited from class globus.glmap.GLNativeObject
dispose
-
Method Details
-
getType
public int getType()Type of the maneuver see Valhalla API reference for details- Returns:
- type of maneuver
-
getLength
public double getLength()Maneuver length in meters- Returns:
- length in meters
-
getEqualLength
Calculates equal length with other maneuver- Parameters:
other
- Other maneuver- Returns:
- length of equal part in internal coordinates
-
getTime
public double getTime()Estimated time along the maneuver in seconds.- Returns:
- time in seconds
-
getInstruction
Get instruction- Parameters:
type
- type of instruction- Returns:
- instruction
-
getShortInstruction
Short instruction for UI. For example "Exit 3A → AZ 202 Loop East"- Returns:
- short instruction
-
getTransitionInstruction
Text for use in UI. For example "Take exit 3A onto AZ 202 Loop East.".- Returns:
- transition instruction
-
getVerbalPreTransitionInstruction
Text suitable for use as a verbal message immediately prior to the maneuver transition. For example "Take exit 3A onto Arizona 2 o2 Loop East.".- Returns:
- message prior to the maneuver transition.
-
getVerbalTransitionInstruction
Text suitable for use as a verbal alert in a navigation application. The transition alert instruction will prepare the user for the forthcoming transition. For example: "Take exit 3A.".- Returns:
- instruction for the transition.
-
getVerbalPostTransitionInstruction
Text suitable for use as a verbal message immediately after the maneuver transition. For example "Continue for 1 kilometer.".- Returns:
- message after the maneuver transition.
-
getStartPoint
Start point of maneuver- Returns:
- start point of maneuver
-
getEndPoint
End point of maneuver- Returns:
- end point of maneuver
-
getRoundaboutExitCount
public int getRoundaboutExitCount()The spoke to exit roundabout after entering.- Returns:
- roundabout exit count or uint32_max if it's not set.
-
getLanesCount
public int getLanesCount()Number of lanes- Returns:
- number of lanes
-
getTurnDirectionsAtLane
public int getTurnDirectionsAtLane(int lane) Returns possible turn directions for a specific lane.- Parameters:
lane
- The index of the lane (starting from 0).- Returns:
- A mask indicating all valid turn directions for the lane.
-
getValidTurnAtLine
public int getValidTurnAtLine(int lane) Returns valid turn directions for a lane that can be used to follow the route initially. Valid turns indicate that the lane is suitable for the maneuver but may require further lane changes later.- Parameters:
lane
- The index of the lane (starting from 0).- Returns:
- A mask indicating valid turns for the lane.
-
getActiveTurnAtLine
public int getActiveTurnAtLine(int lane) Returns active turn directions for a lane that should be used to follow the route without requiring additional lane changes. Active turns indicate the optimal lane for continuing along the route as intended.- Parameters:
lane
- The index of the lane (starting from 0).- Returns:
- A mask indicating active turns for the lane.
-