FollowController

A class that allows you to control the position of the camera and the geopositioning marker. All its methods implementations must be thread-safe. Most methods have trivial default implementations (so FollowController, which is responsible for scale, doesn't have to override coordinates() methods and others).

Extends: Hashable

public static func == (lhs: FollowController, rhs: FollowController) -> Bool

Returns a Boolean value indicating whether two values are equal.

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public func requestValues(
    values: FollowValueOptionSet
)

This method tells the FollowController which of the values it provides are being used. This frees up resources associated with calculating unused values. The method can be called multiple times with different values, in which case the most recent value is relevant.

Parameters

values

FollowValueOptionSet

public func setClock(
    clock: FollowControllerClock?
)

With this method, the time source is passed to the FollowController. The time values that are returned from next_timestamp() must be calculated relative to the values obtained from clock. This method is not called repeatedly to replace the non-zero value previously set with it with a different non-zero value.

Parameters

clock

FollowControllerClock?

public func setThresholds(
    shiftMeters: Double,
    rotation: Double
)

Thresholds for position and rotation angle offsets. Shorter offsets and smaller angle rotations are considered visually indistinguishable.

Parameters

shiftMeters

Double

rotation

Double

public func updateValues()

Query to calculate all provided values. Immediately after calling this method, all values (coordinates(), satellite_bearing(), etc.) are considered relevant.

Properties

var availableValues

FollowValueOptionSet

A set of value types that this FollowController can control. For example, one FollowController can only control coordinates, while another can only control map tilt.

var nextTimestampChannel

StatefulChannel<Date?>

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

var nextTimestamp

Date?

var coordinates

GeoPoint?

Geographic coordinates.

var satelliteBearing

Bearing?

Direction of travel.

var magneticBearing

Bearing?

Direction to magnetic north.

var tilt