Camera (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.scene.Camera

@JsType(isNative=true,
        namespace="Cesium",
        name="Camera")
public class Camera
extends Object

Author:: Serge Silaev aka iSergio

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Camera.ChangedListener`
`static interface`	`Camera.FlightCancelledCallback` A function that will execute when a flight is cancelled.
`static interface`	`Camera.FlightCompleteCallback` A function that will execute when a flight completes.
`static interface`	`Camera.MoveListener`

Field Summary

Fields
Modifier and Type	Field and Description
`Cartesian3`	`constrainedAxis` If set, the camera will not be able to rotate past this axis in either direction.
`static HeadingPitchRange`	`DEFAULT_OFFSET` The default heading/pitch/range that is used when the camera flies to a location that contains a bounding sphere.
`static double`	`DEFAULT_VIEW_FACTOR` A scalar to multiply to the camera position and add it back after setting the camera to view the rectangle.
`static Rectangle`	`DEFAULT_VIEW_RECTANGLE` The default rectangle the camera will view on creation.
`double`	`defaultLookAmount` The default amount to rotate the camera when an argument is not provided to the look methods.
`double`	`defaultMoveAmount` The default amount to move the camera when an argument is not provided to the move methods.
`double`	`defaultRotateAmount` The default amount to rotate the camera when an argument is not provided to the rotate methods.
`double`	`defaultZoomAmount` The default amount to move the camera when an argument is not provided to the zoom methods.
`Cartesian3`	`direction` The view direction of the camera.
`Frustum`	`frustum` The region of space in view.
`double`	`maximumZoomFactor` The factor multiplied by the the map size used to determine where to clamp the camera position when zooming out from the surface.
`float`	`percentageChanged` The amount the camera has to change before the changed event is raised.
`Cartesian3`	`position` The position of the camera.
`Cartesian3`	`right` The right direction of the camera.
`Cartesian3`	`up` The up direction of the camera.

Constructor Summary

Constructors
Constructor and Description

Camera(Scene scene)
The camera is defined by a position, orientation, and view frustum.

Constructors
Constructor and Description
`Camera(Scene scene)` The camera is defined by a position, orientation, and view frustum.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Cartesian4`	`cameraToWorldCoordinates(Cartesian4 cartesian)` Transform a vector or point from the camera's reference frame to world coordinates.
`Cartesian4`	`cameraToWorldCoordinates(Cartesian4 cartesian, Cartesian4 result)` Transform a vector or point from the camera's reference frame to world coordinates.
`Cartesian3`	`cameraToWorldCoordinatesPoint(Cartesian3 cartesian)` Transform a point from the camera's reference frame to world coordinates.
`Cartesian3`	`cameraToWorldCoordinatesPoint(Cartesian3 cartesian, Cartesian3 result)` Transform a point from the camera's reference frame to world coordinates.
`Cartesian3`	`cameraToWorldCoordinatesVector(Cartesian3 cartesian)` Transform a vector from the camera's reference frame to world coordinates.
`Cartesian3`	`cameraToWorldCoordinatesVector(Cartesian3 cartesian, Cartesian3 result)` Transform a vector from the camera's reference frame to world coordinates.
`void`	`cancelFlight()` Cancels the current camera flight if one is in progress.
`Event`	`changed()` Gets the event that will be raised when the camera has changed by percentageChanged.
`Rectangle`	`computeViewRectangle()` Computes the approximate visible rectangle on the ellipsoid.
`Rectangle`	`computeViewRectangle(Ellipsoid ellipsoid)` Computes the approximate visible rectangle on the ellipsoid.
`Rectangle`	`computeViewRectangle(Ellipsoid ellipsoid, Rectangle result)` Computes the approximate visible rectangle on the ellipsoid.
`Cartesian3`	`directionWC()` Gets the view direction of the camera in world coordinates.
`double`	`distanceToBoundingSphere(BoundingSphere boundingSphere)` Return the distance from the camera to the front of the bounding sphere.
`void`	`flyHome()` Fly the camera to the home view.
`void`	`flyHome(double duration)` Fly the camera to the home view.
`void`	`flyTo(CameraFlyToOptions options)` Flies the camera from its current position to a new position.
`void`	`flyToBoundingSphere(BoundingSphere boundingSphere, CameraFlyToOptions options)` Flies the camera to a location where the current view contains the provided bounding sphere.
`double`	`getMagnitude()` Gets the magnitude of the camera position.
`Ray`	`getPickRay(Cartesian2 windowPosition)` Create a ray from the camera position through the pixel at windowPosition in world coordinates.
`Ray`	`getPickRay(Cartesian2 windowPosition, Ray result)` Create a ray from the camera position through the pixel at windowPosition in world coordinates.
`double`	`getPixelSize(BoundingSphere boundingSphere, double drawingBufferWidth, double drawingBufferHeight)` Return the pixel size in meters.
`Cartesian3`	`getRectangleCameraCoordinates(Rectangle rectangle)` Get the camera position needed to view an rectangle on an ellipsoid or map
`Cartesian3`	`getRectangleCameraCoordinates(Rectangle rectangle, Cartesian3 result)` Get the camera position needed to view an rectangle on an ellipsoid or map
`double`	`heading()` Gets the camera heading in radians.
`Matrix4`	`inverseTransform()` Gets the inverse camera transform.
`Matrix4`	`inverseViewMatrix()` Gets the inverse view matrix.
`void`	`look(Cartesian3 axis)` Rotate each of the camera's orientation vectors around axis by angle
`void`	`look(Cartesian3 axis, double angle)` Rotate each of the camera's orientation vectors around axis by angle
`void`	`lookAt(Cartesian3 target, Cartesian3 offset)` Sets the camera position and orientation using a target and offset.
`void`	`lookAt(Cartesian3 target, HeadingPitchRange offset)` Sets the camera position and orientation using a target and offset.
`void`	`lookAtTransform(Matrix4 transform)` Sets the camera position and orientation using a target and transformation matrix.
`void`	`lookAtTransform(Matrix4 transform, Cartesian3 offset)` Sets the camera position and orientation using a target and transformation matrix.
`void`	`lookAtTransform(Matrix4 transform, HeadingPitchRange offset)` Sets the camera position and orientation using a target and transformation matrix.
`void`	`lookDown()` Rotates the camera around its right vector by amount, in radians, in the opposite direction of its up vector.
`void`	`lookDown(double amount)` Rotates the camera around its right vector by amount, in radians, in the opposite direction of its up vector.
`void`	`lookLeft()` Rotates the camera around its up vector by amount, in radians, in the opposite direction of its right vector.
`void`	`lookLeft(double amount)` Rotates the camera around its up vector by amount, in radians, in the opposite direction of its right vector.
`void`	`lookRight()` Rotates the camera around its up vector by amount, in radians, in the direction of its right vector.
`void`	`lookRight(double amount)` Rotates the camera around its up vector by amount, in radians, in the direction of its right vector.
`void`	`lookUp()` Rotates the camera around its right vector by amount, in radians, in the direction of its up vector.
`void`	`lookUp(double amount)` Rotates the camera around its right vector by amount, in radians, in the direction of its up vector.
`void`	`move(Cartesian3 direction)` Translates the camera's position by amount along direction.
`void`	`move(Cartesian3 direction, double amount)` Translates the camera's position by amount along direction.
`void`	`moveBackward()` Translates the camera's position by amount along the opposite direction of the camera's view vector.
`void`	`moveBackward(double amount)` Translates the camera's position by amount along the opposite direction of the camera's view vector.
`void`	`moveDown()` Translates the camera's position by amount along the opposite direction of the camera's up vector.
`void`	`moveDown(double amount)` Translates the camera's position by amount along the opposite direction of the camera's up vector.
`Event`	`moveEnd()` Gets the event that will be raised when the camera has stopped moving.
`void`	`moveForward()` Translates the camera's position by amount along the camera's view vector.
`void`	`moveForward(double amount)` Translates the camera's position by amount along the camera's view vector.
`void`	`moveLeft()` Translates the camera's position by amount along the opposite direction of the camera's right vector.
`void`	`moveLeft(double amount)` Translates the camera's position by amount along the opposite direction of the camera's right vector.
`void`	`moveRight()` Translates the camera's position by amount along the camera's right vector.
`void`	`moveRight(double amount)` Translates the camera's position by amount along the camera's right vector.
`Event`	`moveStart()` Gets the event that will be raised at when the camera starts to move.
`void`	`moveUp()` Translates the camera's position by amount along the camera's up vector.
`void`	`moveUp(double amount)` Translates the camera's position by amount along the camera's up vector.
`Cartesian3`	`pickEllipsoid(Cartesian2 windowPosition)` Pick an ellipsoid or map.
`Cartesian3`	`pickEllipsoid(Cartesian2 windowPosition, Ellipsoid ellipsoid)` Pick an ellipsoid or map.
`Cartesian3`	`pickEllipsoid(Cartesian2 windowPosition, Ellipsoid ellipsoid, Cartesian3 result)` Pick an ellipsoid or map.
`double`	`pitch()` Gets the camera pitch in radians.
`Cartographic`	`positionCartographic()` Gets the Cartographic position of the camera, with longitude and latitude expressed in radians and height in meters.
`Cartesian3`	`positionWC()` Gets the position of the camera in world coordinates.
`Cartesian3`	`rightWC()` Gets the right direction of the camera in world coordinates.
`double`	`roll()` Gets the camera roll in radians.
`void`	`rotate(Cartesian3 axis)` Rotates the camera around axis by angle.
`void`	`rotate(Cartesian3 axis, double angle)` Rotates the camera around axis by angle.
`void`	`rotateDown()` Rotates the camera around the center of the camera's reference frame by angle downwards.
`void`	`rotateDown(double angle)` Rotates the camera around the center of the camera's reference frame by angle downwards.
`void`	`rotateLeft()` Rotates the camera around the center of the camera's reference frame by angle to the left.
`void`	`rotateLeft(double angle)` Rotates the camera around the center of the camera's reference frame by angle to the left.
`void`	`rotateRight()` Rotates the camera around the center of the camera's reference frame by angle to the right.
`void`	`rotateRight(double angle)` Rotates the camera around the center of the camera's reference frame by angle to the right.
`void`	`rotateUp(double angle)` Rotates the camera around the center of the camera's reference frame by angle upwards.
`void`	`setView(ViewOptions options)` Sets the camera position, orientation and transform.
`void`	`switchToOrthographicFrustum()` Switches the frustum/projection to orthographic.
`void`	`switchToPerspectiveFrustum()` Switches the frustum/projection to perspective.
`Matrix4`	`transform()` Gets the camera's reference frame.
`void`	`twistLeft()` Rotate the camera counter-clockwise around its direction vector by amount, in radians.
`void`	`twistLeft(double amount)` Rotate the camera counter-clockwise around its direction vector by amount, in radians.
`void`	`twistRight()` Rotate the camera counter-clockwise around its direction vector by amount, in radians.
`void`	`twistRight(double amount)` Rotate the camera counter-clockwise around its direction vector by amount, in radians.
`Cartesian3`	`upWC()` Gets the up direction of the camera in world coordinates.
`void`	`viewBoundingSphere(BoundingSphere boundingSphere)` Sets the camera so that the current view contains the provided bounding sphere.
`void`	`viewBoundingSphere(BoundingSphere boundingSphere, HeadingPitchRange offset)` Sets the camera so that the current view contains the provided bounding sphere.
`Matrix4`	`viewMatrix()` Gets the view matrix.
`Cartesian4`	`worldToCameraCoordinates(Cartesian4 cartesian)` Transform a vector or point from world coordinates to the camera's reference frame.
`Cartesian4`	`worldToCameraCoordinates(Cartesian4 cartesian, Cartesian4 result)` Transform a vector or point from world coordinates to the camera's reference frame.
`Cartesian3`	`worldToCameraCoordinatesPoint(Cartesian3 cartesian)` Transform a point from world coordinates to the camera's reference frame.
`Cartesian3`	`worldToCameraCoordinatesPoint(Cartesian3 cartesian, Cartesian3 result)` Transform a point from world coordinates to the camera's reference frame.
`Cartesian3`	`worldToCameraCoordinatesVector(Cartesian3 cartesian)` Transform a vector from world coordinates to the camera's reference frame.
`Cartesian3`	`worldToCameraCoordinatesVector(Cartesian3 cartesian, Cartesian3 result)` Transform a vector from world coordinates to the camera's reference frame.
`void`	`zoomIn()` Zooms amount along the camera's view vector.
`void`	`zoomIn(double amount)` Zooms amount along the camera's view vector.
`void`	`zoomOut()` Zooms amount along the opposite direction of the camera's view vector.
`void`	`zoomOut(double amount)` Zooms amount along the opposite direction of the camera's view vector.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_OFFSET
```
@JsProperty
public static HeadingPitchRange DEFAULT_OFFSET
```
    The default heading/pitch/range that is used when the camera flies to a location that contains a bounding sphere.
  - DEFAULT_VIEW_FACTOR
```
@JsProperty
public static double DEFAULT_VIEW_FACTOR
```
    A scalar to multiply to the camera position and add it back after setting the camera to view the rectangle. A value of zero means the camera will view the entire DEFAULT_VIEW_RECTANGLE, a value greater than zero will move it further away from the extent, and a value less than zero will move it close to the extent.
  - DEFAULT_VIEW_RECTANGLE
```
@JsProperty
public static Rectangle DEFAULT_VIEW_RECTANGLE
```
    The default rectangle the camera will view on creation.
  - constrainedAxis
```
@JsProperty
public Cartesian3 constrainedAxis
```
    If set, the camera will not be able to rotate past this axis in either direction. Default Value: undefined
  - defaultLookAmount
```
@JsProperty
public double defaultLookAmount
```
    The default amount to rotate the camera when an argument is not provided to the look methods. Default Value: Math.PI / 60.0
  - defaultMoveAmount
```
@JsProperty
public double defaultMoveAmount
```
    The default amount to move the camera when an argument is not provided to the move methods. Default: 100000.0;
  - defaultRotateAmount
```
@JsProperty
public double defaultRotateAmount
```
    The default amount to rotate the camera when an argument is not provided to the rotate methods. Default: Math.PI / 3600.0
  - defaultZoomAmount
```
@JsProperty
public double defaultZoomAmount
```
    The default amount to move the camera when an argument is not provided to the zoom methods. Default: 100000.0;
  - direction
```
@JsProperty
public Cartesian3 direction
```
    The view direction of the camera.
  - frustum
```
@JsProperty
public Frustum frustum
```
    The region of space in view. Default: PerspectiveFrustum()
    
    See Also:
    
    PerspectiveFrustum, PerspectiveOffCenterFrustum, OrthographicFrustum
  - maximumZoomFactor
```
@JsProperty
public double maximumZoomFactor
```
    The factor multiplied by the the map size used to determine where to clamp the camera position when zooming out from the surface. The default is 1.5. Only valid for 2D and the map is rotatable. Default: 1.5
  - percentageChanged
```
@JsProperty
public float percentageChanged
```
    The amount the camera has to change before the changed event is raised. The value is a percentage in the [0, 1] range. Default: 0.5
  - position
```
@JsProperty
public Cartesian3 position
```
    The position of the camera.
  - right
```
@JsProperty
public Cartesian3 right
```
    The right direction of the camera.
  - up
```
@JsProperty
public Cartesian3 up
```
    The up direction of the camera.
- Constructor Detail
  - Camera
```
@JsConstructor
public Camera(Scene scene)
```
    The camera is defined by a position, orientation, and view frustum. The orientation forms an orthonormal basis with a view, up and right = view x up unit vectors. The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
    
    Parameters:
    
    scene - The scene.
- Method Detail
  - changed
```
@JsProperty(name="changed")
public Event changed()
```
    Gets the event that will be raised when the camera has changed by percentageChanged.
  - directionWC
```
@JsProperty(name="directionWC")
public Cartesian3 directionWC()
```
    Gets the view direction of the camera in world coordinates.
  - heading
```
@JsProperty(name="heading")
public double heading()
```
    Gets the camera heading in radians.
  - inverseTransform
```
@JsProperty(name="inverseTransform")
public Matrix4 inverseTransform()
```
    Gets the inverse camera transform. Default: Matrix4.IDENTITY
  - inverseViewMatrix
```
@JsProperty(name="inverseViewMatrix")
public Matrix4 inverseViewMatrix()
```
    Gets the inverse view matrix.
    
    See Also:
    
    viewMatrix()
  - moveEnd
```
@JsProperty(name="moveEnd")
public Event moveEnd()
```
    Gets the event that will be raised when the camera has stopped moving.
  - moveStart
```
@JsProperty(name="moveStart")
public Event moveStart()
```
    Gets the event that will be raised at when the camera starts to move.
  - pitch
```
@JsProperty(name="pitch")
public double pitch()
```
    Gets the camera pitch in radians.
  - positionCartographic
```
@JsProperty(name="positionCartographic")
public Cartographic positionCartographic()
```
    Gets the Cartographic position of the camera, with longitude and latitude expressed in radians and height in meters. In 2D and Columbus View, it is possible for the returned longitude and latitude to be outside the range of valid longitudes and latitudes when the camera is outside the map.
  - positionWC
```
@JsProperty(name="positionWC")
public Cartesian3 positionWC()
```
    Gets the position of the camera in world coordinates.
  - rightWC
```
@JsProperty(name="rightWC")
public Cartesian3 rightWC()
```
    Gets the right direction of the camera in world coordinates.
  - roll
```
@JsProperty(name="roll")
public double roll()
```
    Gets the camera roll in radians.
  - transform
```
@JsProperty(name="transform")
public Matrix4 transform()
```
    Gets the camera's reference frame. The inverse of this transformation is appended to the view matrix. Default: Matrix4.IDENTITY
  - upWC
```
@JsProperty(name="upWC")
public Cartesian3 upWC()
```
    Gets the up direction of the camera in world coordinates.
  - viewMatrix
```
@JsProperty(name="viewMatrix")
public Matrix4 viewMatrix()
```
    Gets the view matrix.
    
    See Also:
    
    inverseViewMatrix()
  - cameraToWorldCoordinates
```
@JsMethod
public Cartesian4 cameraToWorldCoordinates(Cartesian4 cartesian)
```
    Transform a vector or point from the camera's reference frame to world coordinates.
    
    Parameters:
    
    cartesian - The vector or point to transform.
    
    Returns:
    
    The transformed vector or point.
  - cameraToWorldCoordinates
```
@JsMethod
public Cartesian4 cameraToWorldCoordinates(Cartesian4 cartesian,
                                                     Cartesian4 result)
```
    Transform a vector or point from the camera's reference frame to world coordinates.
    
    Parameters:
    
    cartesian - The vector or point to transform.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The transformed vector or point.
  - cameraToWorldCoordinatesPoint
```
@JsMethod
public Cartesian3 cameraToWorldCoordinatesPoint(Cartesian3 cartesian)
```
    Transform a point from the camera's reference frame to world coordinates.
    
    Parameters:
    
    cartesian - The point to transform.
    
    Returns:
    
    The transformed point.
  - cameraToWorldCoordinatesPoint
```
@JsMethod
public Cartesian3 cameraToWorldCoordinatesPoint(Cartesian3 cartesian,
                                                          Cartesian3 result)
```
    Transform a point from the camera's reference frame to world coordinates.
    
    Parameters:
    
    cartesian - The point to transform.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The transformed point.
  - cameraToWorldCoordinatesVector
```
@JsMethod
public Cartesian3 cameraToWorldCoordinatesVector(Cartesian3 cartesian)
```
    Transform a vector from the camera's reference frame to world coordinates.
    
    Parameters:
    
    cartesian - The vector to transform.
    
    Returns:
    
    The transformed vector.
  - cameraToWorldCoordinatesVector
```
@JsMethod
public Cartesian3 cameraToWorldCoordinatesVector(Cartesian3 cartesian,
                                                           Cartesian3 result)
```
    Transform a vector from the camera's reference frame to world coordinates.
    
    Parameters:
    
    cartesian - The vector to transform.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The transformed vector.
  - cancelFlight
```
@JsMethod
public void cancelFlight()
```
    Cancels the current camera flight if one is in progress. The camera is left at it's current location.
  - computeViewRectangle
```
@JsMethod
public Rectangle computeViewRectangle()
```
    Computes the approximate visible rectangle on the ellipsoid.
    
    Returns:
    
    The visible rectangle or undefined if the ellipsoid isn't visible at all.
  - computeViewRectangle
```
@JsMethod
public Rectangle computeViewRectangle(Ellipsoid ellipsoid)
```
    Computes the approximate visible rectangle on the ellipsoid.
    
    Parameters:
    
    ellipsoid - The ellipsoid that you want to know the visible region. Default: Ellipsoid.WGS84()
    
    Returns:
    
    The visible rectangle or undefined if the ellipsoid isn't visible at all.
  - computeViewRectangle
```
@JsMethod
public Rectangle computeViewRectangle(Ellipsoid ellipsoid,
                                                Rectangle result)
```
    Computes the approximate visible rectangle on the ellipsoid.
    
    Parameters:
    
    ellipsoid - The ellipsoid that you want to know the visible region. Default: Ellipsoid.WGS84()
    
    result - The rectangle in which to store the result
    
    Returns:
    
    The visible rectangle or undefined if the ellipsoid isn't visible at all.
  - distanceToBoundingSphere
```
@JsMethod
public double distanceToBoundingSphere(BoundingSphere boundingSphere)
```
    Return the distance from the camera to the front of the bounding sphere.
    
    Parameters:
    
    boundingSphere - The bounding sphere in world coordinates.
    
    Returns:
    
    The distance to the bounding sphere.
  - flyHome
```
@JsMethod
public void flyHome()
```
    Fly the camera to the home view. Use DEFAULT_VIEW_RECTANGLE to set the default view for the 3D scene. The home view for 2D and columbus view shows the entire map.
  - flyHome
```
@JsMethod
public void flyHome(double duration)
```
    Fly the camera to the home view. Use DEFAULT_VIEW_RECTANGLE to set the default view for the 3D scene. The home view for 2D and columbus view shows the entire map.
    
    Parameters:
    
    duration - The number of seconds to complete the camera flight to home. @see #flyTo
  - flyTo
```
@JsMethod
public void flyTo(CameraFlyToOptions options)
```
    Flies the camera from its current position to a new position.
    
    Parameters:
    
    options - Options.
  - flyToBoundingSphere
```
@JsMethod
public void flyToBoundingSphere(BoundingSphere boundingSphere,
                                          CameraFlyToOptions options)
```
    Flies the camera to a location where the current view contains the provided bounding sphere. The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere. The heading and the pitch angles are defined in the local east-north-up reference frame. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. If the range is zero, a range will be computed such that the whole bounding sphere is visible. In 2D and Columbus View, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the range. The heading will be aligned to local north.
    
    Parameters:
    
    boundingSphere - The bounding sphere to view, in world coordinates.
    
    options - Options
  - getMagnitude
```
@JsMethod
public double getMagnitude()
```
    Gets the magnitude of the camera position. In 3D, this is the vector magnitude. In 2D and Columbus view, this is the distance to the map.
    
    Returns:
    
    The magnitude of the position.
  - getPickRay
```
@JsMethod
public Ray getPickRay(Cartesian2 windowPosition)
```
    Create a ray from the camera position through the pixel at windowPosition in world coordinates.
    
    Parameters:
    
    windowPosition - The x and y coordinates of a pixel.
    
    Returns:
    
    Returns the Cartesian3 position and direction of the ray.
  - getPickRay
```
@JsMethod
public Ray getPickRay(Cartesian2 windowPosition,
                                Ray result)
```
    Create a ray from the camera position through the pixel at windowPosition in world coordinates.
    
    Parameters:
    
    windowPosition - The x and y coordinates of a pixel.
    
    result - The object onto which to store the result.
    
    Returns:
    
    Returns the Cartesian3 position and direction of the ray.
  - getPixelSize
```
@JsMethod
public double getPixelSize(BoundingSphere boundingSphere,
                                     double drawingBufferWidth,
                                     double drawingBufferHeight)
```
    Return the pixel size in meters.
    
    Parameters:
    
    boundingSphere - The bounding sphere in world coordinates.
    
    drawingBufferWidth - The drawing buffer width.
    
    drawingBufferHeight - The drawing buffer height.
    
    Returns:
    
    The pixel size in meters.
  - getRectangleCameraCoordinates
```
@JsMethod
public Cartesian3 getRectangleCameraCoordinates(Rectangle rectangle)
```
    Get the camera position needed to view an rectangle on an ellipsoid or map
    
    Parameters:
    
    rectangle - The rectangle to view.
    
    Returns:
    
    The camera position needed to view the rectangle
  - getRectangleCameraCoordinates
```
@JsMethod
public Cartesian3 getRectangleCameraCoordinates(Rectangle rectangle,
                                                          Cartesian3 result)
```
    Get the camera position needed to view an rectangle on an ellipsoid or map
    
    Parameters:
    
    rectangle - The rectangle to view.
    
    result - The camera position needed to view the rectangle
    
    Returns:
    
    The camera position needed to view the rectangle
  - look
```
@JsMethod
public void look(Cartesian3 axis)
```
    Rotate each of the camera's orientation vectors around axis by angle
    
    Parameters:
    
    axis - The axis to rotate around.
    
    See Also:
    
    lookUp(), lookDown(), lookLeft(), lookRight()
  - look
```
@JsMethod
public void look(Cartesian3 axis,
                           double angle)
```
    Rotate each of the camera's orientation vectors around axis by angle
    
    Parameters:
    
    axis - The axis to rotate around.
    
    angle - The angle, in radians, to rotate by. Defaults to defaultLookAmount.
    
    See Also:
    
    lookUp(), lookDown(), lookLeft(), lookRight()
  - lookAt
```
@JsMethod
public void lookAt(Cartesian3 target,
                             Cartesian3 offset)
```
    Sets the camera position and orientation using a target and offset. The target must be given in world coordinates. The offset can be either a cartesian or heading/pitch/range in the local east-north-up reference frame centered at the target. If the offset is a cartesian, then it is an offset from the center of the reference frame defined by the transformation matrix. If the offset is heading/pitch/range, then the heading and the pitch angles are defined in the reference frame defined by the transformation matrix. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the magnitude of the offset. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
    
    Parameters:
    
    target - The target position in world coordinates.
    
    offset - The offset from the target in the local east-north-up reference frame centered at the target.
  - lookAt
```
@JsMethod
public void lookAt(Cartesian3 target,
                             HeadingPitchRange offset)
```
    Sets the camera position and orientation using a target and offset. The target must be given in world coordinates. The offset can be either a cartesian or heading/pitch/range in the local east-north-up reference frame centered at the target. If the offset is a cartesian, then it is an offset from the center of the reference frame defined by the transformation matrix. If the offset is heading/pitch/range, then the heading and the pitch angles are defined in the reference frame defined by the transformation matrix. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the magnitude of the offset. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
    
    Parameters:
    
    target - The target position in world coordinates.
    
    offset - The offset from the target in the local east-north-up reference frame centered at the target.
  - lookAtTransform
```
@JsMethod
public void lookAtTransform(Matrix4 transform)
```
    Sets the camera position and orientation using a target and transformation matrix. The offset can be either a cartesian or heading/pitch/range. If the offset is a cartesian, then it is an offset from the center of the reference frame defined by the transformation matrix. If the offset is heading/pitch/range, then the heading and the pitch angles are defined in the reference frame defined by the transformation matrix. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. In 2D, there must be a top down view. The camera will be placed above the center of the reference frame. The height above the target will be the magnitude of the offset. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
    
    Parameters:
    
    transform - The transformation matrix defining the reference frame.
  - lookAtTransform
```
@JsMethod
public void lookAtTransform(Matrix4 transform,
                                      Cartesian3 offset)
```
    Sets the camera position and orientation using a target and transformation matrix. The offset can be either a cartesian or heading/pitch/range. If the offset is a cartesian, then it is an offset from the center of the reference frame defined by the transformation matrix. If the offset is heading/pitch/range, then the heading and the pitch angles are defined in the reference frame defined by the transformation matrix. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. In 2D, there must be a top down view. The camera will be placed above the center of the reference frame. The height above the target will be the magnitude of the offset. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
    
    Parameters:
    
    transform - The transformation matrix defining the reference frame.
    
    offset - The offset from the target in a reference frame centered at the target.
  - lookAtTransform
```
@JsMethod
public void lookAtTransform(Matrix4 transform,
                                      HeadingPitchRange offset)
```
    Sets the camera position and orientation using a target and transformation matrix. The offset can be either a cartesian or heading/pitch/range. If the offset is a cartesian, then it is an offset from the center of the reference frame defined by the transformation matrix. If the offset is heading/pitch/range, then the heading and the pitch angles are defined in the reference frame defined by the transformation matrix. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. In 2D, there must be a top down view. The camera will be placed above the center of the reference frame. The height above the target will be the magnitude of the offset. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
    
    Parameters:
    
    transform - The transformation matrix defining the reference frame.
    
    offset - The offset from the target in a reference frame centered at the target.
  - lookDown
```
@JsMethod
public void lookDown()
```
    Rotates the camera around its right vector by amount, in radians, in the opposite direction of its up vector.
    
    See Also:
    
    lookUp()
  - lookDown
```
@JsMethod
public void lookDown(double amount)
```
    Rotates the camera around its right vector by amount, in radians, in the opposite direction of its up vector.
    
    Parameters:
    
    amount - The amount, in radians, to rotate by. Default: defaultLookAmount
    
    See Also:
    
    lookUp()
  - lookLeft
```
@JsMethod
public void lookLeft()
```
    Rotates the camera around its up vector by amount, in radians, in the opposite direction of its right vector.
    
    See Also:
    
    lookRight()
  - lookLeft
```
@JsMethod
public void lookLeft(double amount)
```
    Rotates the camera around its up vector by amount, in radians, in the opposite direction of its right vector.
    
    Parameters:
    
    amount - The amount, in radians, to rotate by. Default: defaultLookAmount
    
    See Also:
    
    lookRight()
  - lookRight
```
@JsMethod
public void lookRight()
```
    Rotates the camera around its up vector by amount, in radians, in the direction of its right vector.
    
    See Also:
    
    lookLeft()
  - lookRight
```
@JsMethod
public void lookRight(double amount)
```
    Rotates the camera around its up vector by amount, in radians, in the direction of its right vector.
    
    Parameters:
    
    amount - The amount, in radians, to rotate by. Default: defaultLookAmount
    
    See Also:
    
    lookLeft()
  - lookUp
```
@JsMethod
public void lookUp()
```
    Rotates the camera around its right vector by amount, in radians, in the direction of its up vector.
    
    See Also:
    
    lookDown()
  - lookUp
```
@JsMethod
public void lookUp(double amount)
```
    Rotates the camera around its right vector by amount, in radians, in the direction of its up vector.
    
    Parameters:
    
    amount - The amount, in radians, to rotate by. Default: defaultLookAmount.
    
    See Also:
    
    lookDown()
  - move
```
@JsMethod
public void move(Cartesian3 direction)
```
    Translates the camera's position by amount along direction.
    
    Parameters:
    
    direction - The direction to move.
  - move
```
@JsMethod
public void move(Cartesian3 direction,
                           double amount)
```
    Translates the camera's position by amount along direction.
    
    Parameters:
    
    direction - The direction to move.
    
    amount - The amount, in meters, to move. Defaults to defaultMoveAmount.
    
    See Also:
    
    moveBackward(), moveForward(), moveLeft(), moveRight(), moveUp(), moveDown()
  - moveBackward
```
@JsMethod
public void moveBackward()
```
    Translates the camera's position by amount along the opposite direction of the camera's view vector.
    
    See Also:
    
    moveForward()
  - moveBackward
```
@JsMethod
public void moveBackward(double amount)
```
    Translates the camera's position by amount along the opposite direction of the camera's view vector.
    
    Parameters:
    
    amount - The amount, in meters, to move. Defaults to defaultMoveAmount.
    
    See Also:
    
    moveForward()
  - moveDown
```
@JsMethod
public void moveDown()
```
    Translates the camera's position by amount along the opposite direction of the camera's up vector.
    
    See Also:
    
    moveUp()
  - moveDown
```
@JsMethod
public void moveDown(double amount)
```
    Translates the camera's position by amount along the opposite direction of the camera's up vector.
    
    Parameters:
    
    amount - The amount, in meters, to move. Defaults to defaultMoveAmount.
    
    See Also:
    
    moveUp()
  - moveForward
```
@JsMethod
public void moveForward()
```
    Translates the camera's position by amount along the camera's view vector.
    
    See Also:
    
    moveBackward()
  - moveForward
```
@JsMethod
public void moveForward(double amount)
```
    Translates the camera's position by amount along the camera's view vector.
    
    Parameters:
    
    amount - The amount, in meters, to move. Defaults to defaultMoveAmount.
    
    See Also:
    
    moveBackward()
  - moveLeft
```
@JsMethod
public void moveLeft()
```
    Translates the camera's position by amount along the opposite direction of the camera's right vector.
    
    See Also:
    
    moveRight()
  - moveLeft
```
@JsMethod
public void moveLeft(double amount)
```
    Translates the camera's position by amount along the opposite direction of the camera's right vector.
    
    Parameters:
    
    amount - The amount, in meters, to move. Defaults to defaultMoveAmount.
    
    See Also:
    
    moveRight()
  - moveRight
```
public void moveRight()
```
    Translates the camera's position by amount along the camera's right vector.
    
    See Also:
    
    moveLeft()
  - moveRight
```
@JsMethod
public void moveRight(double amount)
```
    Translates the camera's position by amount along the camera's right vector.
    
    Parameters:
    
    amount - The amount, in meters, to move. Defaults to defaultMoveAmount.
    
    See Also:
    
    moveLeft()
  - moveUp
```
@JsMethod
public void moveUp()
```
    Translates the camera's position by amount along the camera's up vector.
    
    See Also:
    
    moveDown()
  - moveUp
```
@JsMethod
public void moveUp(double amount)
```
    Translates the camera's position by amount along the camera's up vector.
    
    Parameters:
    
    amount - The amount, in meters, to move. Defaults to defaultMoveAmount.
    
    See Also:
    
    moveDown()
  - pickEllipsoid
```
@JsMethod
public Cartesian3 pickEllipsoid(Cartesian2 windowPosition)
```
    Pick an ellipsoid or map.
    
    Parameters:
    
    windowPosition - The x and y coordinates of a pixel.
    
    Returns:
    
    If the ellipsoid or map was picked, returns the point on the surface of the ellipsoid or map in world coordinates. If the ellipsoid or map was not picked, returns undefined.
  - pickEllipsoid
```
@JsMethod
public Cartesian3 pickEllipsoid(Cartesian2 windowPosition,
                                          Ellipsoid ellipsoid)
```
    Pick an ellipsoid or map.
    
    Parameters:
    
    windowPosition - The x and y coordinates of a pixel.
    
    ellipsoid - The ellipsoid to pick. Default: Ellipsoid.WGS84()
    
    Returns:
    
    If the ellipsoid or map was picked, returns the point on the surface of the ellipsoid or map in world coordinates. If the ellipsoid or map was not picked, returns undefined.
  - pickEllipsoid
```
@JsMethod
public Cartesian3 pickEllipsoid(Cartesian2 windowPosition,
                                          Ellipsoid ellipsoid,
                                          Cartesian3 result)
```
    Pick an ellipsoid or map.
    
    Parameters:
    
    windowPosition - The x and y coordinates of a pixel.
    
    ellipsoid - The ellipsoid to pick. Default: Ellipsoid.WGS84()
    
    result - The object onto which to store the result.
    
    Returns:
    
    If the ellipsoid or map was picked, returns the point on the surface of the ellipsoid or map in world coordinates. If the ellipsoid or map was not picked, returns undefined.
  - rotate
```
@JsMethod
public void rotate(Cartesian3 axis)
```
    Rotates the camera around axis by angle. The distance of the camera's position to the center of the camera's reference frame remains the same.
    
    Parameters:
    
    axis - The axis to rotate around given in world coordinates.
    
    See Also:
    
    rotateUp(double), rotateDown(), rotateLeft(), rotateRight()
  - rotate
```
@JsMethod
public void rotate(Cartesian3 axis,
                             double angle)
```
    Rotates the camera around axis by angle. The distance of the camera's position to the center of the camera's reference frame remains the same.
    
    Parameters:
    
    axis - The axis to rotate around given in world coordinates.
    
    angle - The angle, in radians, to rotate by. Defaults to defaultRotateAmount.
    
    See Also:
    
    rotateUp(double), rotateDown(), rotateLeft(), rotateRight()
  - rotateDown
```
@JsMethod
public void rotateDown()
```
    Rotates the camera around the center of the camera's reference frame by angle downwards.
    
    See Also:
    
    rotateUp(double), rotate(org.cesiumjs.cs.core.Cartesian3), rotate(org.cesiumjs.cs.core.Cartesian3, double)
  - rotateDown
```
@JsMethod
public void rotateDown(double angle)
```
    Rotates the camera around the center of the camera's reference frame by angle downwards.
    
    Parameters:
    
    angle - The angle, in radians, to rotate by. Defaults to defaultRotateAmount.
    
    See Also:
    
    rotateUp(double), rotate(org.cesiumjs.cs.core.Cartesian3), rotate(org.cesiumjs.cs.core.Cartesian3, double)
  - rotateLeft
```
@JsMethod
public void rotateLeft()
```
    Rotates the camera around the center of the camera's reference frame by angle to the left.
    
    See Also:
    
    rotateRight(), rotate(org.cesiumjs.cs.core.Cartesian3)
  - rotateLeft
```
@JsMethod
public void rotateLeft(double angle)
```
    Rotates the camera around the center of the camera's reference frame by angle to the left.
    
    Parameters:
    
    angle - The angle, in radians, to rotate by. Defaults to defaultRotateAmount.
    
    See Also:
    
    rotateRight(), rotate(org.cesiumjs.cs.core.Cartesian3)
  - rotateRight
```
@JsMethod
public void rotateRight()
```
    Rotates the camera around the center of the camera's reference frame by angle to the right.
    
    See Also:
    
    rotateLeft(), rotate(org.cesiumjs.cs.core.Cartesian3)
  - rotateRight
```
@JsMethod
public void rotateRight(double angle)
```
    Rotates the camera around the center of the camera's reference frame by angle to the right.
    
    Parameters:
    
    angle - The angle, in radians, to rotate by. Defaults to defaultRotateAmount.
    
    See Also:
    
    rotateLeft(), rotate(org.cesiumjs.cs.core.Cartesian3)
  - rotateUp
```
@JsMethod
public void rotateUp(double angle)
```
    Rotates the camera around the center of the camera's reference frame by angle upwards.
    
    Parameters:
    
    angle - The angle, in radians, to rotate by. Defaults to defaultRotateAmount.
    
    See Also:
    
    rotateDown(), rotate(org.cesiumjs.cs.core.Cartesian3)
  - setView
```
@JsMethod
public void setView(ViewOptions options)
```
    Sets the camera position, orientation and transform.
    
    Parameters:
    
    options - Options
  - switchToOrthographicFrustum
```
@JsMethod
public void switchToOrthographicFrustum()
```
    Switches the frustum/projection to orthographic. This function is a no-op in 2D which will always be orthographic.
  - switchToPerspectiveFrustum
```
@JsMethod
public void switchToPerspectiveFrustum()
```
    Switches the frustum/projection to perspective. This function is a no-op in 2D which must always be orthographic.
  - twistLeft
```
@JsMethod
public void twistLeft()
```
    Rotate the camera counter-clockwise around its direction vector by amount, in radians.
    
    See Also:
    
    twistRight()
  - twistLeft
```
@JsMethod
public void twistLeft(double amount)
```
    Rotate the camera counter-clockwise around its direction vector by amount, in radians.
    
    Parameters:
    
    amount - The amount, in radians, to rotate by. Defaults to defaultLookAmount.
    
    See Also:
    
    twistRight()
  - twistRight
```
@JsMethod
public void twistRight()
```
    Rotate the camera counter-clockwise around its direction vector by amount, in radians.
    
    See Also:
    
    twistLeft()
  - twistRight
```
@JsMethod
public void twistRight(double amount)
```
    Rotate the camera counter-clockwise around its direction vector by amount, in radians.
    
    Parameters:
    
    amount - The amount, in radians, to rotate by. Defaults to defaultLookAmount.
    
    See Also:
    
    twistLeft()
  - viewBoundingSphere
```
@JsMethod
public void viewBoundingSphere(BoundingSphere boundingSphere)
```
    Sets the camera so that the current view contains the provided bounding sphere. The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere. The heading and the pitch angles are defined in the local east-north-up reference frame. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. If the range is zero, a range will be computed such that the whole bounding sphere is visible. In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the range. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
    
    Parameters:
    
    boundingSphere - The bounding sphere to view, in world coordinates.
  - viewBoundingSphere
```
@JsMethod
public void viewBoundingSphere(BoundingSphere boundingSphere,
                                         HeadingPitchRange offset)
```
    Sets the camera so that the current view contains the provided bounding sphere. The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere. The heading and the pitch angles are defined in the local east-north-up reference frame. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are below the plane. Negative pitch angles are above the plane. The range is the distance from the center. If the range is zero, a range will be computed such that the whole bounding sphere is visible. In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the range. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
    
    Parameters:
    
    boundingSphere - The bounding sphere to view, in world coordinates.
    
    offset - The offset from the target in the local east-north-up reference frame centered at the target.
  - worldToCameraCoordinates
```
@JsMethod
public Cartesian4 worldToCameraCoordinates(Cartesian4 cartesian)
```
    Transform a vector or point from world coordinates to the camera's reference frame.
    
    Parameters:
    
    cartesian - The vector or point to transform.
    
    Returns:
    
    The transformed vector or point.
  - worldToCameraCoordinates
```
@JsMethod
public Cartesian4 worldToCameraCoordinates(Cartesian4 cartesian,
                                                     Cartesian4 result)
```
    Transform a vector or point from world coordinates to the camera's reference frame.
    
    Parameters:
    
    cartesian - The vector or point to transform.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The transformed vector or point.
  - worldToCameraCoordinatesPoint
```
@JsMethod
public Cartesian3 worldToCameraCoordinatesPoint(Cartesian3 cartesian)
```
    Transform a point from world coordinates to the camera's reference frame.
    
    Parameters:
    
    cartesian - The point to transform.
    
    Returns:
    
    The transformed point.
  - worldToCameraCoordinatesPoint
```
@JsMethod
public Cartesian3 worldToCameraCoordinatesPoint(Cartesian3 cartesian,
                                                          Cartesian3 result)
```
    Transform a point from world coordinates to the camera's reference frame.
    
    Parameters:
    
    cartesian - The point to transform.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The transformed point.
  - worldToCameraCoordinatesVector
```
@JsMethod
public Cartesian3 worldToCameraCoordinatesVector(Cartesian3 cartesian)
```
    Transform a vector from world coordinates to the camera's reference frame.
    
    Parameters:
    
    cartesian - The vector to transform.
    
    Returns:
    
    The transformed vector.
  - worldToCameraCoordinatesVector
```
@JsMethod
public Cartesian3 worldToCameraCoordinatesVector(Cartesian3 cartesian,
                                                           Cartesian3 result)
```
    Transform a vector from world coordinates to the camera's reference frame.
    
    Parameters:
    
    cartesian - The vector to transform.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The transformed vector.
  - zoomIn
```
@JsMethod
public void zoomIn()
```
    Zooms amount along the camera's view vector.
    
    See Also:
    
    zoomOut()
  - zoomIn
```
@JsMethod
public void zoomIn(double amount)
```
    Zooms amount along the camera's view vector.
    
    Parameters:
    
    amount - The amount to move. Defaults to defaultZoomAmount.
    
    See Also:
    
    zoomOut()
  - zoomOut
```
@JsMethod
public void zoomOut()
```
    Zooms amount along the opposite direction of the camera's view vector.
    
    See Also:
    
    zoomIn()
  - zoomOut
```
@JsMethod
public void zoomOut(double amount)
```
    Zooms amount along the opposite direction of the camera's view vector.
    
    Parameters:
    
    amount - The amount to move. Defaults to defaultZoomAmount.
    
    See Also:
    
    zoomIn()

Class Camera

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_OFFSET

DEFAULT_VIEW_FACTOR

DEFAULT_VIEW_RECTANGLE

constrainedAxis

defaultLookAmount

defaultMoveAmount

defaultRotateAmount

defaultZoomAmount

direction

frustum

maximumZoomFactor

percentageChanged

position

right

up

Constructor Detail

Camera

Method Detail

changed

directionWC

heading

inverseTransform

inverseViewMatrix

moveEnd

moveStart

pitch

positionCartographic

positionWC

rightWC

roll

transform

upWC

viewMatrix

cameraToWorldCoordinates

cameraToWorldCoordinates

cameraToWorldCoordinatesPoint

cameraToWorldCoordinatesPoint

cameraToWorldCoordinatesVector

cameraToWorldCoordinatesVector

cancelFlight

computeViewRectangle

computeViewRectangle

computeViewRectangle

distanceToBoundingSphere

flyHome

flyHome

flyTo

flyToBoundingSphere

getMagnitude

getPickRay

getPickRay

getPixelSize

getRectangleCameraCoordinates

getRectangleCameraCoordinates

look

look

lookAt

lookAt

lookAtTransform

lookAtTransform

lookAtTransform

lookDown

lookDown

lookLeft

lookLeft

lookRight

lookRight

lookUp

lookUp

move

move

moveBackward

moveBackward