FlyToOptions

sealed interface FlyToOptions(source)

Properties

Link copied to clipboard

The function to execute if the flight is cancelled.

Link copied to clipboard

The function to execute when the flight is complete.

Link copied to clipboard
abstract var convert: Boolean?

Whether to convert the destination from world coordinates to scene coordinates (only relevant when not using 3D). Defaults to true.

Link copied to clipboard
abstract var destination: Any

The final position of the camera in world coordinates or a rectangle that would be visible from a top-down view.

Link copied to clipboard
abstract var duration: Double?

The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight.

Link copied to clipboard

Controls how the time is interpolated over the duration of the flight.

Link copied to clipboard
abstract var endTransform: Matrix4?

Transform matrix representing the reference frame the camera will be in when the flight is completed.

Link copied to clipboard
abstract var flyOverLongitude: Double?

There are always two ways between 2 points on globe. This option force camera to choose fight direction to fly over that longitude.

Link copied to clipboard

Fly over the lon specifyed via flyOverLongitude only if that way is not longer than short way times flyOverLongitudeWeight.

Link copied to clipboard
abstract var maximumHeight: Double?

The maximum height at the peak of the flight.

Link copied to clipboard

An object that contains either direction and up properties or heading, pitch and roll properties. By default, the direction will point towards the center of the frame in 3D and in the negative z direction in Columbus view. The up direction will point towards local north in 3D and in the positive y direction in Columbus view. Orientation is not used in 2D when in infinite scrolling mode.

Link copied to clipboard
abstract var pitchAdjustHeight: Double?

If camera flyes higher than that value, adjust pitch duiring the flight to look down, and keep Earth in viewport.