GeoWaypoint

A class that defines a Waypoint. A Waypoint is similar to a via-point plus a radius which defines the distance under which the routing algorithm considers that the via-point is reached. Waypoints with a large radius (E.g 20 km) are also known as Soft-Waypoints. Note that waypoints with a radius >0 are also known as "soft waypoints". If this location is an intermediate point passed to the route planner, avoidUturn defines if route planner must avoid (if possible) a U-turn after reaching waypoint's location. If this location is not the last point passed to the route planner, ignoreTrafficDirections defines if route planner can ignore traffic directions to reach following point passed to the planner (allowing going against traffic directions).

Constructors

Link copied to clipboard
constructor(roadLocation: GeoRoadLocation, radius: Long)
Constructs a new GeoWaypoint from an existing GeoRoadLocation instance.
constructor(roadLocation: GeoRoadLocation, radius: Long, ignorePoint: Boolean, ignoreTrafficDirections: Boolean, ignoreRoadBlocks: Boolean, ignoreRestrictions: Boolean, avoidUTurn: WaypointStatus, useStartAngle: WaypointStatus, useStopRoadSide: WaypointStatus)
Constructs a new GeoWaypoint from an existing GeoRoadLocation instance.

Properties

Link copied to clipboard
open var address: Long
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val radius: Long
Link copied to clipboard
Defines the Left side of a road segment
Link copied to clipboard
Defines the Right side of a road segment
Link copied to clipboard
Defines an undefined side of a road segment
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open fun dispose()
Call this method if you want to dispose immediately all underlying native resources.
Link copied to clipboard
open fun getAngle(): Int
Returns angle of the road segment.
Link copied to clipboard
open fun getClassId(): Long
Returns the class ID of the road segment.
Link copied to clipboard
open fun getGeoPoint(): GeoPoint
Returns the geographical position of this road location.
Link copied to clipboard
open fun getObjectId(): ObjectId
Return the internal identifier of the segment of road.
Link copied to clipboard
open fun getRoadSide(): Int
Returns the side of the road the location is.
Link copied to clipboard
Returns true if this waypoint is ignored by the planner for its route calculation, false otherwise.
Link copied to clipboard
Returns true if forbidden manoeuvres &blocked passages are ignored, false otherwise.
Link copied to clipboard
Returns true if road blocks are ignored, false otherwise.
Link copied to clipboard
Returns true if traffic directions are ignored, false otherwise.
Link copied to clipboard
open fun isWaypoint(): Boolean
Returns true if this Road Location is a waypoint.
Link copied to clipboard
open fun rotate()
Rotates the angle by 180°
Link copied to clipboard
Link copied to clipboard
open fun toString(): String
Returns coordinates of this Road Location as a string.
Link copied to clipboard
open fun x(): Double
Returns x-coordinate in double precision.
Link copied to clipboard
open fun y(): Double
Returns y-coordinate in double precision.