Interface PolylineIndex

Package world.mappable.mapkit.geometry.geo

interface PolylineIndex

Provides methods for binding locations to a polyline

Nested Class Summary

Modifier and Type

Interface

Description

static final

Priority

Summary

Methods

Type and modifiers

Method and Description

PolylinePosition

closestPolylinePosition(@NonNull Point point,
                        @NonNull Priority priority,
                        double maxLocationBias)

Finds closest polyline position.

PolylinePosition

closestPolylinePosition(@NonNull Point point,
                        @NonNull PolylinePosition positionFrom,
                        @NonNull PolylinePosition positionTo,
                        double maxLocationBias)

Finds the closest polyline position between the two positions.

Methods

closestPolylinePosition

@Nullable
PolylinePosition closestPolylinePosition(@NonNull Point point,
                                         @NonNull Priority priority,
                                         double maxLocationBias)

Finds closest polyline position.

Returns null if there is no position that satisfies the condition distance(point, position) maxLocationBias.

Two modes are available: 1. Find the closest polyline position to a raw point mapkit.geometry.geo.PolylineIndex.Priority#CLOSEST_TO_RAW_POINT 2. Find the closest polyline position to the polyline start mapkit.geometry.geo.PolylineIndex.Priority#CLOSEST_TO_START.


closestPolylinePosition

@Nullable
PolylinePosition closestPolylinePosition(@NonNull Point point,
                                         @NonNull PolylinePosition positionFrom,
                                         @NonNull PolylinePosition positionTo,
                                         double maxLocationBias)

Finds the closest polyline position between the two positions.

Returns null if there is no position that satisfies the condition distance(point, position) maxLocationBias.