ru.dgis.sdk.map.FollowController | Android SDK | 2GIS Documentation
Android SDK
Maps
Search
Navigation
On-Premise
Urbi Pro
CityLens

FollowController

A class that allows you to manage the camera position and the geolocation marker. All of its methods' implementations must be thread-safe. Most methods have trivial default implementations available (thus the FollowController responsible for scaling is not required to override coordinates() and similar methods).

Extends: ru.dgis.sdk.NativeObject
Methods
fun requestValues(values: EnumSet<FollowValue>): Unit

This method tells the FollowController which values it provides are in use. This frees resources associated with calculating unused values. The method can be called multiple times with different values, in which case the last one is the actual one.

Parameters
values
Returns
fun setClock(clock: FollowControllerClock?): Unit

This method passes a time source to the FollowController. The times that are returned from next_timestamp() must be computed relative to the values obtained from clock. This method is not called again to replace a previously non-zero value with a non-zero value other than it.

Parameters
clock
Returns
fun setThresholds(shiftMeters: Double, rotation: Double): Unit

Threshold values for position offset and rotation angle. Smaller offsets and smaller rotations are assumed not to be visually distinguishable.

Parameters
shiftMeters
rotation
Returns
fun updateValues(): Unit

A request to calculate all provided values. Immediately after calling this method, all values (coordinates(), satellite_bearing(), etc.) are considered up-to-date.

Returns
Properties
val availableValues

A set of kinds of values that this FollowController can manage. For example, one FollowController can manage only coordinates, while another can only manage map tilt.

val nextTimestampChannel

A channel that informs subscribers about the time of the next visible change of values. The change time of values not among those requested using request_values() may not be reported. Time values are interpreted relative to the source passed to set_clock().

val nextTimestamp

A channel that informs subscribers about the time of the next visible change of values. The change time of values not among those requested using request_values() may not be reported. Time values are interpreted relative to the source passed to set_clock().

val coordinates

Geographical coordinates.

val satelliteBearing

Direction of movement.

val magneticBearing

Direction to magnetic north.

val tilt

Map tilt.

val zoom

Zoom-level of the map.

val accuracy

Precision circle radius (meters).