RoutePointInstruction

class RoutePointInstruction(engine: RoutePointInstruction, metadataRepository: MetadataRepository)

Represents a navigation instruction at a specific point along the route.

This class interprets native route point data into localized instructions, icons, and landmark references using the provided context and metadata.

Constructors

Link copied to clipboard
constructor(engine: RoutePointInstruction, metadataRepository: MetadataRepository)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

List of alert IDs triggered upon entering this instruction point.

Link copied to clipboard

List of alert IDs triggered upon exiting this instruction point.

Link copied to clipboard

List of landmark entity IDs associated with this instruction point.

Link copied to clipboard
val point: MercatorZone

The MercatorZone location of the instruction.

Functions

Link copied to clipboard
Link copied to clipboard

Builds a localized instruction object with text and an icon based on this point's InstructionType.

Link copied to clipboard
fun getInstructionType(): InstructionType

The type of instruction (e.g., Turn Left, Go Straight).

Link copied to clipboard

Returns the map rotation (in radians) when leaving this point

Link copied to clipboard

Returns the map rotation (in radians) when approaching this point

Link copied to clipboard

Returns the distance and estimated time to the next instruction point. If unavailable, returns a default of 0 distance and 0 time.

Link copied to clipboard
fun getTransitionZone(): Zone?

Returns the transition zone if this point transitions between levels.

Link copied to clipboard

Indicates whether this instruction is on an accessible route.

Link copied to clipboard

Determines whether the instruction involves entering or exiting a building, or continuing through a transition that results in a building change.

Link copied to clipboard

Represents an unstyled icon (no background color).

Link copied to clipboard

Determines whether the instruction involves a transition between floors, such as using stairs, an elevator, or escalator.

Link copied to clipboard
fun pointIdx(): Int

The index of the point within the route.

Link copied to clipboard
open override fun toString(): String