com.tomtom.sdk.maps:map-display-api/com.tomtom.sdk.map.display.camera/CameraOptions

CameraOptions

class CameraOptions : Parcelable

Determines options for the new configuration of the camera. For example the location, zoom level, tilt angle.

All the options are optional. Setting any of these to null keeps the current camera property unmodified.

See also

to check convenient factory methods that can create various CameraOptions.

Constructors

Link copied to clipboard
constructor(position: GeoPoint? = null, @FloatRange(from = 0.0, to = 22.0) zoom: Double? = null, @FloatRange(from = 0.0, to = 90.0) tilt: Double? = null, @FloatRange(from = 0.0, to = 360.0) rotation: Double? = null, @FloatRange(from = 1.0, to = 150.0) fieldOfView: Double? = null)

Properties

Link copied to clipboard
val fieldOfView: Double? = null

New camera field of view (in degrees). Valid range is 1.0, 150.0

Link copied to clipboard
val position: GeoPoint? = null

GeoPoint of the new camera position.

Link copied to clipboard
val rotation: Double? = null

Sets the camera heading. Heading is measured starting at due north and continues clockwise around the compass. Thus, north is 0 degrees, east is 90 degrees, south is 180 degrees, and so on.

Link copied to clipboard
val tilt: Double? = null

Sets the tilt to the specified angle. The tilt is measured from the nadir, meaning that a value of 0 indicates the camera looking straight down, and 90 means straight ahead towards the horizon.

Link copied to clipboard
val zoom: Double? = null

Zoom value for the camera. The value shall be clamped by the CameraController.minZoom and the CameraController.maxZoom values. Values go from 0 (no zoom) to 22 (fully zoomed in). Zoom level categories are as following:

Functions

Link copied to clipboard
fun deepCopy(position: GeoPoint? = null, @FloatRange(from = 0.0, to = 22.0) zoom: Double? = null, @FloatRange(from = 0.0, to = 90.0) tilt: Double? = null, @FloatRange(from = 0.0, to = 360.0) rotation: Double? = null, @FloatRange(from = 1.0, to = 150.0) fieldOfView: Double? = null): CameraOptions

Performs a deep copy of the current CameraOptions including all the properties which are not accessible via the constructor parameters.

Inherited functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)