arcgis-maps-kotlin/com.arcgismaps.mapping.view/Camera

Camera

A camera represents an observer's location and their perspective of an com.arcgismaps.mapping.ArcGISScene within a SceneView. A Camera object can be thought of as a camera that you look through to see a viewable area of a scene. What you see depends on how you orientate the camera and how far it is above the com.arcgismaps.mapping.Surface. A camera has four main configurable properties:

Location - The 3D point in space where the camera is located.
Heading - The angle around the z-axis the camera is rotated. The angle is clockwise from north in the East, North, Up (ENU) ground reference frame. The value is between 0 to 360. 0 is looking North and 90 is looking East.
Pitch - The angle around the y-axis the camera is rotated. The value is between 0 to 180. 0 is looking straight down, 180 is looking straight up.
Roll - The angle around the x-axis the camera is rotated. The value is between 0 to 360. 0 is horizontal, 180 is upside down.

You can construct a Camera based on these values or you can obtain it from the scene view's current viewpoint using SceneView.getCurrentViewpointCamera. The Camera is immutable which means that once it is created it you cannot modify it.

You can define the user's camera interactions using the scene view's camera controller. The default camera controller (GlobeCameraController) allows users to freely move and focus the camera anywhere in the scene. Other camera controllers provide specialized behavior, such as:

The OrbitGeoElementCameraController locks the camera to maintain focus on a (possibly moving) com.arcgismaps.mapping.GeoElement.
The OrbitLocationCameraController locks the camera to orbit and to maintain focus on a fixed location.

Since

200.1.0

Constructors

Camera

constructor(latitude: Double, longitude: Double, altitude: Double, heading: Double, pitch: Double, roll: Double)

Creates a camera with the specified latitude, longitude, altitude, heading, pitch, and roll.

constructor(locationPoint: Point, heading: Double, pitch: Double, roll: Double)

Creates a camera with the specified location, heading, pitch, and roll.

constructor(lookAtPoint: Point, distance: Double, heading: Double, pitch: Double, roll: Double)

Creates a camera based on a point to look at, the distance to this point, heading, pitch, and roll. Note: the given values may mean that the point is not visible on screen. You can check its visibility using SceneView.locationToScreen.

constructor(transformationMatrix: TransformationMatrix)

Creates a camera from a transformation matrix. The TransformationMatrix describes the camera's location and direction it is looking.

Properties

heading

val heading: Double

The heading of the camera. The angle around the z-axis the camera is rotated. The angle is clockwise from north in the East, North, Up (ENU) ground reference frame. The value is between 0 to 360. 0 is looking North and 90 is looking East.

location

val location: Point

The point geometry containing the location and altitude of the camera.

pitch

val pitch: Double

The pitch of the camera. The angle around the y-axis the camera is rotated in the East, North, Up (ENU) ground reference frame. The value is between 0 to 180. 0 is looking straight down and 180 is looking straight up.

roll

val roll: Double

The roll of the camera. The angle around the x-axis the camera is rotated in the East, North, Up (ENU) ground reference frame. The value is between 0 to 360. 0 is horizontal, 180 is upside down.

transformationMatrix

val transformationMatrix: TransformationMatrix

The camera's TransformationMatrix. It does not matter if the camera was created with a TransformationMatrix, the camera's location and orientation will always be converted into a TransformationMatrix.

Functions

elevate

fun elevate(deltaAltitude: Double): Camera

Creates a copy of the camera with the change in altitude applied.

moveForward

fun moveForward(distance: Double): Camera

Creates a copy of the camera with its location moved by the specified distance in the direction the camera is facing.

moveTo

fun moveTo(location: Point): Camera

Creates a copy of the camera with a new location.

moveToward

fun moveToward(targetPoint: Point, distance: Double): Camera

Creates a copy of the camera with the camera moved in the direction of a target point by the specified distance.

rotateAround

fun rotateAround(targetPoint: Point, deltaHeading: Double, deltaPitch: Double, deltaRoll: Double): Camera

Creates a copy of the camera with the heading and pitch rotated from a specified target point by the delta angles in degrees.

rotateTo

fun rotateTo(heading: Double, pitch: Double, roll: Double): Camera

Creates a copy of the camera with the specified heading, pitch and roll values.

zoomToward

fun zoomToward(targetPoint: Point, factor: Double): Camera

Creates a copy of the camera with its location moved in the direction of a target point by the specified zoom factor.