qd-changjing/public/static/Build/Documentation/Camera.html

9896 lines
178 KiB
HTML
Raw Normal View History

2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Camera - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
Camera
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Camera">
<a href="#Camera" class="doc-link"></a>
new Cesium.Camera<span class="signature">(scene)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L63">Scene/Camera.js 63</a>
</div>
</h4>
</div>
<div class="description">
The camera is defined by a position, orientation, and view frustum.
<br /><br />
The orientation forms an orthonormal basis with a view, up and right = view x up unit vectors.
<br /><br />
The viewing frustum is defined by 6 planes.
Each plane is represented by a <a href="Cartesian4.html"><code>Cartesian4</code></a> 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.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type"><a href="Scene.html">Scene</a></span>
</td>
<td class="description last">
The scene.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Create a camera looking down the negative z-axis, positioned at the origin,
// with a field of view of 60 degrees, and 1:1 aspect ratio.
const camera = new Cesium.Camera(scene);
camera.position = new Cesium.Cartesian3();
camera.direction = Cesium.Cartesian3.negate(Cesium.Cartesian3.UNIT_Z, new Cesium.Cartesian3());
camera.up = Cesium.Cartesian3.clone(Cesium.Cartesian3.UNIT_Y);
camera.frustum.fov = Cesium.Math.PI_OVER_THREE;
camera.frustum.near = 1.0;
camera.frustum.far = 2.0;</code></pre>
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Camera.html">Cesium Sandcastle Camera Demo</a></li>
<li><a href="https://sandcastle.cesium.com/index.html?src=Camera%2520Tutorial.html">Cesium Sandcastle Camera Tutorial Example</a></li>
<li><a href="https://cesium.com/learn/cesiumjs-learn/cesiumjs-camera">Camera Tutorial</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".DEFAULT_OFFSET">
<a href="#.DEFAULT_OFFSET" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Camera.DEFAULT_OFFSET<span class="type-signature"> : <a href="HeadingPitchRange.html">HeadingPitchRange</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L290">Scene/Camera.js 290</a>
</div>
</h4>
</div>
<div class="description">
The default heading/pitch/range that is used when the camera flies to a location that contains a bounding sphere.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".DEFAULT_VIEW_FACTOR">
<a href="#.DEFAULT_VIEW_FACTOR" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Camera.DEFAULT_VIEW_FACTOR<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L284">Scene/Camera.js 284</a>
</div>
</h4>
</div>
<div class="description">
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 <code>Camera#DEFAULT_VIEW_RECTANGLE</code>, 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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".DEFAULT_VIEW_RECTANGLE">
<a href="#.DEFAULT_VIEW_RECTANGLE" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Camera.DEFAULT_VIEW_RECTANGLE<span class="type-signature"> : <a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L271">Scene/Camera.js 271</a>
</div>
</h4>
</div>
<div class="description">
The default rectangle the camera will view on creation.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="changed">
<a href="#changed" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> changed<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1059">Scene/Camera.js 1059</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that will be raised when the camera has changed by <code>percentageChanged</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="constrainedAxis">
<a href="#constrainedAxis" class="doc-link"></a>
constrainedAxis<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L185">Scene/Camera.js 185</a>
</div>
</h4>
</div>
<div class="description">
If set, the camera will not be able to rotate past this axis in either direction.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultLookAmount">
<a href="#defaultLookAmount" class="doc-link"></a>
defaultLookAmount<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L165">Scene/Camera.js 165</a>
</div>
</h4>
</div>
<div class="description">
The default amount to rotate the camera when an argument is not
provided to the look methods.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Math.PI / 60.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultMoveAmount">
<a href="#defaultMoveAmount" class="doc-link"></a>
defaultMoveAmount<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L158">Scene/Camera.js 158</a>
</div>
</h4>
</div>
<div class="description">
The default amount to move the camera when an argument is not
provided to the move methods.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">100000.0;</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultRotateAmount">
<a href="#defaultRotateAmount" class="doc-link"></a>
defaultRotateAmount<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L172">Scene/Camera.js 172</a>
</div>
</h4>
</div>
<div class="description">
The default amount to rotate the camera when an argument is not
provided to the rotate methods.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">Math.PI / 3600.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultZoomAmount">
<a href="#defaultZoomAmount" class="doc-link"></a>
defaultZoomAmount<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L179">Scene/Camera.js 179</a>
</div>
</h4>
</div>
<div class="description">
The default amount to move the camera when an argument is not
provided to the zoom methods.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">100000.0;</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="direction">
<a href="#direction" class="doc-link"></a>
direction<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L115">Scene/Camera.js 115</a>
</div>
</h4>
</div>
<div class="description">
The view direction of the camera.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="directionWC">
<a href="#directionWC" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> directionWC<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L901">Scene/Camera.js 901</a>
</div>
</h4>
</div>
<div class="description">
Gets the view direction of the camera in world coordinates.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="frustum">
<a href="#frustum" class="doc-link"></a>
frustum<span class="type-signature"> : <a href="PerspectiveFrustum.html">PerspectiveFrustum</a>|<a href="PerspectiveOffCenterFrustum.html">PerspectiveOffCenterFrustum</a>|<a href="OrthographicFrustum.html">OrthographicFrustum</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L147">Scene/Camera.js 147</a>
</div>
</h4>
</div>
<div class="description">
The region of space in view.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">PerspectiveFrustum()</code>
<h5>See:</h5>
<ul class="see-list">
<li><a href="PerspectiveFrustum.html">PerspectiveFrustum</a></li>
<li><a href="PerspectiveOffCenterFrustum.html">PerspectiveOffCenterFrustum</a></li>
<li><a href="OrthographicFrustum.html">OrthographicFrustum</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="heading">
<a href="#heading" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> heading<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L943">Scene/Camera.js 943</a>
</div>
</h4>
</div>
<div class="description">
Gets the camera heading in radians.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="inverseTransform">
<a href="#inverseTransform" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> inverseTransform<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L824">Scene/Camera.js 824</a>
</div>
</h4>
</div>
<div class="description">
Gets the inverse camera transform.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="Matrix4.html#.IDENTITY"><code>Matrix4.IDENTITY</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="inverseViewMatrix">
<a href="#inverseViewMatrix" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> inverseViewMatrix<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L856">Scene/Camera.js 856</a>
</div>
</h4>
</div>
<div class="description">
Gets the inverse view matrix.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#viewMatrix">Camera#viewMatrix</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumZoomFactor">
<a href="#maximumZoomFactor" class="doc-link"></a>
maximumZoomFactor<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L192">Scene/Camera.js 192</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.5</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="moveEnd">
<a href="#moveEnd" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> moveEnd<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1047">Scene/Camera.js 1047</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that will be raised when the camera has stopped moving.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="moveStart">
<a href="#moveStart" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> moveStart<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1035">Scene/Camera.js 1035</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that will be raised at when the camera starts to move.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="percentageChanged">
<a href="#percentageChanged" class="doc-link"></a>
percentageChanged<span class="type-signature"> : number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L208">Scene/Camera.js 208</a>
</div>
</h4>
</div>
<div class="description">
The amount the camera has to change before the <code>changed</code> event is raised. The value is a percentage in the [0, 1] range.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.5</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="pitch">
<a href="#pitch" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> pitch<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L974">Scene/Camera.js 974</a>
</div>
</h4>
</div>
<div class="description">
Gets the camera pitch in radians.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="position">
<a href="#position" class="doc-link"></a>
position<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L82">Scene/Camera.js 82</a>
</div>
</h4>
</div>
<div class="description">
The position of the camera.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="positionCartographic">
<a href="#positionCartographic" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> positionCartographic<span class="type-signature"> : <a href="Cartographic.html">Cartographic</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L873">Scene/Camera.js 873</a>
</div>
</h4>
</div>
<div class="description">
Gets the <a href="Cartographic.html"><code>Cartographic</code></a> 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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="positionWC">
<a href="#positionWC" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> positionWC<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L887">Scene/Camera.js 887</a>
</div>
</h4>
</div>
<div class="description">
Gets the position of the camera in world coordinates.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="right">
<a href="#right" class="doc-link"></a>
right<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L133">Scene/Camera.js 133</a>
</div>
</h4>
</div>
<div class="description">
The right direction of the camera.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="rightWC">
<a href="#rightWC" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> rightWC<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L929">Scene/Camera.js 929</a>
</div>
</h4>
</div>
<div class="description">
Gets the right direction of the camera in world coordinates.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="roll">
<a href="#roll" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> roll<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1005">Scene/Camera.js 1005</a>
</div>
</h4>
</div>
<div class="description">
Gets the camera roll in radians.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="transform">
<a href="#transform" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> transform<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L809">Scene/Camera.js 809</a>
</div>
</h4>
</div>
<div class="description">
Gets the camera's reference frame. The inverse of this transformation is appended to the view matrix.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="Matrix4.html#.IDENTITY"><code>Matrix4.IDENTITY</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="up">
<a href="#up" class="doc-link"></a>
up<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L124">Scene/Camera.js 124</a>
</div>
</h4>
</div>
<div class="description">
The up direction of the camera.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="upWC">
<a href="#upWC" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> upWC<span class="type-signature"> : <a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L915">Scene/Camera.js 915</a>
</div>
</h4>
</div>
<div class="description">
Gets the up direction of the camera in world coordinates.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="viewMatrix">
<a href="#viewMatrix" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> viewMatrix<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L840">Scene/Camera.js 840</a>
</div>
</h4>
</div>
<div class="description">
Gets the view matrix.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#inverseViewMatrix">Camera#inverseViewMatrix</a></li>
</ul>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="cameraToWorldCoordinates">
<a href="#cameraToWorldCoordinates" class="doc-link"></a>
cameraToWorldCoordinates<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian4.html">Cartesian4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1615">Scene/Camera.js 1615</a>
</div>
</h4>
</div>
<div class="description">
Transform a vector or point from the camera's reference frame to world coordinates.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cartesian</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian4.html">Cartesian4</a></span>
</td>
<td class="description last">
The vector or point to transform.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian4.html">Cartesian4</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The transformed vector or point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="cameraToWorldCoordinatesPoint">
<a href="#cameraToWorldCoordinatesPoint" class="doc-link"></a>
cameraToWorldCoordinatesPoint<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1636">Scene/Camera.js 1636</a>
</div>
</h4>
</div>
<div class="description">
Transform a point from the camera's reference frame to world coordinates.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cartesian</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The point to transform.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The transformed point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="cameraToWorldCoordinatesVector">
<a href="#cameraToWorldCoordinatesVector" class="doc-link"></a>
cameraToWorldCoordinatesVector<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1657">Scene/Camera.js 1657</a>
</div>
</h4>
</div>
<div class="description">
Transform a vector from the camera's reference frame to world coordinates.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cartesian</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The vector to transform.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The transformed vector.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="cancelFlight">
<a href="#cancelFlight" class="doc-link"></a>
cancelFlight<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3216">Scene/Camera.js 3216</a>
</div>
</h4>
</div>
<div class="description">
Cancels the current camera flight and leaves the camera at its current location.
If no flight is in progress, this this function does nothing.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="completeFlight">
<a href="#completeFlight" class="doc-link"></a>
completeFlight<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3227">Scene/Camera.js 3227</a>
</div>
</h4>
</div>
<div class="description">
Completes the current camera flight and moves the camera immediately to its final destination.
If no flight is in progress, this this function does nothing.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="computeViewRectangle">
<a href="#computeViewRectangle" class="doc-link"></a>
computeViewRectangle<span class="signature">(<span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Rectangle.html">Rectangle</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3761">Scene/Camera.js 3761</a>
</div>
</h4>
</div>
<div class="description">
Computes the approximate visible rectangle on the ellipsoid.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<span class="param-type"><a href="Ellipsoid.html">Ellipsoid</a></span>
</td>
<td class="default">
<code class="language-javascript">Ellipsoid.WGS84</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The ellipsoid that you want to know the visible region.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The rectangle in which to store the result</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The visible rectangle or undefined if the ellipsoid isn't visible at all.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceToBoundingSphere">
<a href="#distanceToBoundingSphere" class="doc-link"></a>
distanceToBoundingSphere<span class="signature">(boundingSphere)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3013">Scene/Camera.js 3013</a>
</div>
</h4>
</div>
<div class="description">
Return the distance from the camera to the front of the bounding sphere.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>boundingSphere</code></td>
<td class="type">
<span class="param-type"><a href="BoundingSphere.html">BoundingSphere</a></span>
</td>
<td class="description last">
The bounding sphere in world coordinates.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The distance to the bounding sphere.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="flyHome">
<a href="#flyHome" class="doc-link"></a>
flyHome<span class="signature">(<span class="optional">duration</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1491">Scene/Camera.js 1491</a>
</div>
</h4>
</div>
<div class="description">
Fly the camera to the home view. Use <code>Camera#.DEFAULT_VIEW_RECTANGLE</code> to set
the default view for the 3D scene. The home view for 2D and columbus view shows the
entire map.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
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. See <a href="Camera.html#flyTo"><code>Camera#flyTo</code></a></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="flyTo">
<a href="#flyTo" class="doc-link"></a>
flyTo<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3306">Scene/Camera.js 3306</a>
</div>
</h4>
</div>
<div class="description">
Flies the camera from its current position to a new position.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>destination</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
|
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="description last">
The final position of the camera in WGS84 (world) coordinates or a rectangle that would be visible from a top-down view.</td>
</tr>
<tr>
<td class="name"><code>orientation</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
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.</td>
</tr>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
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.</td>
</tr>
<tr>
<td class="name"><code>complete</code></td>
<td class="type">
<span class="param-type"><a href="Camera.html#.FlightCompleteCallback">Camera.FlightCompleteCallback</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The function to execute when the flight is complete.</td>
</tr>
<tr>
<td class="name"><code>cancel</code></td>
<td class="type">
<span class="param-type"><a href="Camera.html#.FlightCancelledCallback">Camera.FlightCancelledCallback</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The function to execute if the flight is cancelled.</td>
</tr>
<tr>
<td class="name"><code>endTransform</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Transform matrix representing the reference frame the camera will be in when the flight is completed.</td>
</tr>
<tr>
<td class="name"><code>maximumHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum height at the peak of the flight.</td>
</tr>
<tr>
<td class="name"><code>pitchAdjustHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
If camera flyes higher than that value, adjust pitch duiring the flight to look down, and keep Earth in viewport.</td>
</tr>
<tr>
<td class="name"><code>flyOverLongitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
There are always two ways between 2 points on globe. This option force camera to choose fight direction to fly over that longitude.</td>
</tr>
<tr>
<td class="name"><code>flyOverLongitudeWeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Fly over the lon specifyed via flyOverLongitude only if that way is not longer than short way times flyOverLongitudeWeight.</td>
</tr>
<tr>
<td class="name"><code>convert</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether to convert the destination from world coordinates to scene coordinates (only relevant when not using 3D). Defaults to <code>true</code>.</td>
</tr>
<tr>
<td class="name"><code>easingFunction</code></td>
<td class="type">
<span class="param-type"><a href="EasingFunction.html#.Callback">EasingFunction.Callback</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Controls how the time is interpolated over the duration of the flight.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: If either direction or up is given, then both are required.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// 1. Fly to a position with a top-down view
viewer.camera.flyTo({
destination : Cesium.Cartesian3.fromDegrees(-117.16, 32.71, 15000.0)
});
// 2. Fly to a Rectangle with a top-down view
viewer.camera.flyTo({
destination : Cesium.Rectangle.fromDegrees(west, south, east, north)
});
// 3. Fly to a position with an orientation using unit vectors.
viewer.camera.flyTo({
destination : Cesium.Cartesian3.fromDegrees(-122.19, 46.25, 5000.0),
orientation : {
direction : new Cesium.Cartesian3(-0.04231243104240401, -0.20123236049443421, -0.97862924300734),
up : new Cesium.Cartesian3(-0.47934589305293746, -0.8553216253114552, 0.1966022179118339)
}
});
// 4. Fly to a position with an orientation using heading, pitch and roll.
viewer.camera.flyTo({
destination : Cesium.Cartesian3.fromDegrees(-122.19, 46.25, 5000.0),
orientation : {
heading : Cesium.Math.toRadians(175.0),
pitch : Cesium.Math.toRadians(-35.0),
roll : 0.0
}
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="flyToBoundingSphere">
<a href="#flyToBoundingSphere" class="doc-link"></a>
flyToBoundingSphere<span class="signature">(boundingSphere, <span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3542">Scene/Camera.js 3542</a>
</div>
</h4>
</div>
<div class="description">
Flies the camera to a location where the current view contains the provided bounding sphere.
<p> 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.</p>
<p>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.</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>boundingSphere</code></td>
<td class="type">
<span class="param-type"><a href="BoundingSphere.html">BoundingSphere</a></span>
</td>
<td class="description last">
The bounding sphere to view, in world coordinates.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
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.</td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type"><a href="HeadingPitchRange.html">HeadingPitchRange</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The offset from the target in the local east-north-up reference frame centered at the target.</td>
</tr>
<tr>
<td class="name"><code>complete</code></td>
<td class="type">
<span class="param-type"><a href="Camera.html#.FlightCompleteCallback">Camera.FlightCompleteCallback</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The function to execute when the flight is complete.</td>
</tr>
<tr>
<td class="name"><code>cancel</code></td>
<td class="type">
<span class="param-type"><a href="Camera.html#.FlightCancelledCallback">Camera.FlightCancelledCallback</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The function to execute if the flight is cancelled.</td>
</tr>
<tr>
<td class="name"><code>endTransform</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Transform matrix representing the reference frame the camera will be in when the flight is completed.</td>
</tr>
<tr>
<td class="name"><code>maximumHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum height at the peak of the flight.</td>
</tr>
<tr>
<td class="name"><code>pitchAdjustHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
If camera flyes higher than that value, adjust pitch duiring the flight to look down, and keep Earth in viewport.</td>
</tr>
<tr>
<td class="name"><code>flyOverLongitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
There are always two ways between 2 points on globe. This option force camera to choose fight direction to fly over that longitude.</td>
</tr>
<tr>
<td class="name"><code>flyOverLongitudeWeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Fly over the lon specifyed via flyOverLongitude only if that way is not longer than short way times flyOverLongitudeWeight.</td>
</tr>
<tr>
<td class="name"><code>easingFunction</code></td>
<td class="type">
<span class="param-type"><a href="EasingFunction.html#.Callback">EasingFunction.Callback</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Controls how the time is interpolated over the duration of the flight.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getMagnitude">
<a href="#getMagnitude" class="doc-link"></a>
getMagnitude<span class="signature">()</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2229">Scene/Camera.js 2229</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<h5>Returns:</h5>
<div class="param-desc">
The magnitude of the position.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getPickRay">
<a href="#getPickRay" class="doc-link"></a>
getPickRay<span class="signature">(windowPosition, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Ray.html">Ray</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2976">Scene/Camera.js 2976</a>
</div>
</h4>
</div>
<div class="description">
Create a ray from the camera position through the pixel at <code>windowPosition</code>
in world coordinates.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>windowPosition</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="description last">
The x and y coordinates of a pixel.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Ray.html">Ray</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
Returns the <a href="Cartesian3.html"><code>Cartesian3</code></a> position and direction of the ray, or undefined if the pick ray cannot be determined.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getPixelSize">
<a href="#getPixelSize" class="doc-link"></a>
getPixelSize<span class="signature">(boundingSphere, drawingBufferWidth, drawingBufferHeight)</span> &rarr; <span class="type-signature returnType">Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3043">Scene/Camera.js 3043</a>
</div>
</h4>
</div>
<div class="description">
Return the pixel size in meters.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>boundingSphere</code></td>
<td class="type">
<span class="param-type"><a href="BoundingSphere.html">BoundingSphere</a></span>
</td>
<td class="description last">
The bounding sphere in world coordinates.</td>
</tr>
<tr>
<td class="name"><code>drawingBufferWidth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The drawing buffer width.</td>
</tr>
<tr>
<td class="name"><code>drawingBufferHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The drawing buffer height.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The pixel size in meters.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getRectangleCameraCoordinates">
<a href="#getRectangleCameraCoordinates" class="doc-link"></a>
getRectangleCameraCoordinates<span class="signature">(rectangle, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2760">Scene/Camera.js 2760</a>
</div>
</h4>
</div>
<div class="description">
Get the camera position needed to view a rectangle on an ellipsoid or map
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rectangle</code></td>
<td class="type">
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="description last">
The rectangle to view.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The camera position needed to view the rectangle</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The camera position needed to view the rectangle
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="look">
<a href="#look" class="doc-link"></a>
look<span class="signature">(axis, <span class="optional">angle</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1908">Scene/Camera.js 1908</a>
</div>
</h4>
</div>
<div class="description">
Rotate each of the camera's orientation vectors around <code>axis</code> by <code>angle</code>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>axis</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The axis to rotate around.</td>
</tr>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The angle, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#lookUp">Camera#lookUp</a></li>
<li><a href="Camera.html#lookDown">Camera#lookDown</a></li>
<li><a href="Camera.html#lookLeft">Camera#lookLeft</a></li>
<li><a href="Camera.html#lookRight">Camera#lookRight</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="lookAt">
<a href="#lookAt" class="doc-link"></a>
lookAt<span class="signature">(target, offset)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2273">Scene/Camera.js 2273</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The target position in world coordinates.</td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
|
<span class="param-type"><a href="HeadingPitchRange.html">HeadingPitchRange</a></span>
</td>
<td class="description last">
The offset from the target in the local east-north-up reference frame centered at the target.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: lookAt is not supported while morphing.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// 1. Using a cartesian offset
const center = Cesium.Cartesian3.fromDegrees(-98.0, 40.0);
viewer.camera.lookAt(center, new Cesium.Cartesian3(0.0, -4790000.0, 3930000.0));
// 2. Using a HeadingPitchRange offset
const center = Cesium.Cartesian3.fromDegrees(-72.0, 40.0);
const heading = Cesium.Math.toRadians(50.0);
const pitch = Cesium.Math.toRadians(-20.0);
const range = 5000.0;
viewer.camera.lookAt(center, new Cesium.HeadingPitchRange(heading, pitch, range));</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="lookAtTransform">
<a href="#lookAtTransform" class="doc-link"></a>
lookAtTransform<span class="signature">(transform, <span class="optional">offset</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2361">Scene/Camera.js 2361</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>transform</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
The transformation matrix defining the reference frame.</td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
|
<span class="param-type"><a href="HeadingPitchRange.html">HeadingPitchRange</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The offset from the target in a reference frame centered at the target.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: lookAtTransform is not supported while morphing.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// 1. Using a cartesian offset
const transform = Cesium.Transforms.eastNorthUpToFixedFrame(Cesium.Cartesian3.fromDegrees(-98.0, 40.0));
viewer.camera.lookAtTransform(transform, new Cesium.Cartesian3(0.0, -4790000.0, 3930000.0));
// 2. Using a HeadingPitchRange offset
const transform = Cesium.Transforms.eastNorthUpToFixedFrame(Cesium.Cartesian3.fromDegrees(-72.0, 40.0));
const heading = Cesium.Math.toRadians(50.0);
const pitch = Cesium.Math.toRadians(-20.0);
const range = 5000.0;
viewer.camera.lookAtTransform(transform, new Cesium.HeadingPitchRange(heading, pitch, range));</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="lookDown">
<a href="#lookDown" class="doc-link"></a>
lookDown<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1886">Scene/Camera.js 1886</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around its right vector by amount, in radians, in the opposite direction
of its up vector if not in 2D mode.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#lookUp">Camera#lookUp</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="lookLeft">
<a href="#lookLeft" class="doc-link"></a>
lookLeft<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1835">Scene/Camera.js 1835</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around its up vector by amount, in radians, in the opposite direction
of its right vector if not in 2D mode.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#lookRight">Camera#lookRight</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="lookRight">
<a href="#lookRight" class="doc-link"></a>
lookRight<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1852">Scene/Camera.js 1852</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around its up vector by amount, in radians, in the direction
of its right vector if not in 2D mode.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#lookLeft">Camera#lookLeft</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="lookUp">
<a href="#lookUp" class="doc-link"></a>
lookUp<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1869">Scene/Camera.js 1869</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around its right vector by amount, in radians, in the direction
of its up vector if not in 2D mode.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#lookDown">Camera#lookDown</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="move">
<a href="#move" class="doc-link"></a>
move<span class="signature">(direction, <span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1719">Scene/Camera.js 1719</a>
</div>
</h4>
</div>
<div class="description">
Translates the camera's position by <code>amount</code> along <code>direction</code>.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>direction</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The direction to move.</td>
</tr>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#moveBackward">Camera#moveBackward</a></li>
<li><a href="Camera.html#moveForward">Camera#moveForward</a></li>
<li><a href="Camera.html#moveLeft">Camera#moveLeft</a></li>
<li><a href="Camera.html#moveRight">Camera#moveRight</a></li>
<li><a href="Camera.html#moveUp">Camera#moveUp</a></li>
<li><a href="Camera.html#moveDown">Camera#moveDown</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="moveBackward">
<a href="#moveBackward" class="doc-link"></a>
moveBackward<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1765">Scene/Camera.js 1765</a>
</div>
</h4>
</div>
<div class="description">
Translates the camera's position by <code>amount</code> along the opposite direction
of the camera's view vector.
When in 2D mode, this will zoom out the camera instead of translating the camera's position.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#moveForward">Camera#moveForward</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="moveDown">
<a href="#moveDown" class="doc-link"></a>
moveDown<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1797">Scene/Camera.js 1797</a>
</div>
</h4>
</div>
<div class="description">
Translates the camera's position by <code>amount</code> along the opposite direction
of the camera's up vector.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#moveUp">Camera#moveUp</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="moveForward">
<a href="#moveForward" class="doc-link"></a>
moveForward<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1744">Scene/Camera.js 1744</a>
</div>
</h4>
</div>
<div class="description">
Translates the camera's position by <code>amount</code> along the camera's view vector.
When in 2D mode, this will zoom in the camera instead of translating the camera's position.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#moveBackward">Camera#moveBackward</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="moveLeft">
<a href="#moveLeft" class="doc-link"></a>
moveLeft<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1822">Scene/Camera.js 1822</a>
</div>
</h4>
</div>
<div class="description">
Translates the camera's position by <code>amount</code> along the opposite direction
of the camera's right vector.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#moveRight">Camera#moveRight</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="moveRight">
<a href="#moveRight" class="doc-link"></a>
moveRight<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1809">Scene/Camera.js 1809</a>
</div>
</h4>
</div>
<div class="description">
Translates the camera's position by <code>amount</code> along the camera's right vector.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#moveLeft">Camera#moveLeft</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="moveUp">
<a href="#moveUp" class="doc-link"></a>
moveUp<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1784">Scene/Camera.js 1784</a>
</div>
</h4>
</div>
<div class="description">
Translates the camera's position by <code>amount</code> along the camera's up vector.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in meters, to move. Defaults to <code>defaultMoveAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#moveDown">Camera#moveDown</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="pickEllipsoid">
<a href="#pickEllipsoid" class="doc-link"></a>
pickEllipsoid<span class="signature">(windowPosition, <span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2849">Scene/Camera.js 2849</a>
</div>
</h4>
</div>
<div class="description">
Pick an ellipsoid or map.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>windowPosition</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The x and y coordinates of a pixel.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<span class="param-type"><a href="Ellipsoid.html">Ellipsoid</a></span>
</td>
<td class="default">
<code class="language-javascript">Ellipsoid.WGS84</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The ellipsoid to pick.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
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.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const canvas = viewer.scene.canvas;
const center = new Cesium.Cartesian2(canvas.clientWidth / 2.0, canvas.clientHeight / 2.0);
const ellipsoid = viewer.scene.globe.ellipsoid;
const result = viewer.camera.pickEllipsoid(center, ellipsoid);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="rotate">
<a href="#rotate" class="doc-link"></a>
rotate<span class="signature">(axis, <span class="optional">angle</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1970">Scene/Camera.js 1970</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around <code>axis</code> by <code>angle</code>. The distance
of the camera's position to the center of the camera's reference frame remains the same.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>axis</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The axis to rotate around given in world coordinates.</td>
</tr>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#rotateUp">Camera#rotateUp</a></li>
<li><a href="Camera.html#rotateDown">Camera#rotateDown</a></li>
<li><a href="Camera.html#rotateLeft">Camera#rotateLeft</a></li>
<li><a href="Camera.html#rotateRight">Camera#rotateRight</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="rotateDown">
<a href="#rotateDown" class="doc-link"></a>
rotateDown<span class="signature">(<span class="optional">angle</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2001">Scene/Camera.js 2001</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around the center of the camera's reference frame by angle downwards.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#rotateUp">Camera#rotateUp</a></li>
<li><a href="Camera.html#rotate">Camera#rotate</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="rotateLeft">
<a href="#rotateLeft" class="doc-link"></a>
rotateLeft<span class="signature">(<span class="optional">angle</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2100">Scene/Camera.js 2100</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around the center of the camera's reference frame by angle to the left.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#rotateRight">Camera#rotateRight</a></li>
<li><a href="Camera.html#rotate">Camera#rotate</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="rotateRight">
<a href="#rotateRight" class="doc-link"></a>
rotateRight<span class="signature">(<span class="optional">angle</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2087">Scene/Camera.js 2087</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around the center of the camera's reference frame by angle to the right.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#rotateLeft">Camera#rotateLeft</a></li>
<li><a href="Camera.html#rotate">Camera#rotate</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="rotateUp">
<a href="#rotateUp" class="doc-link"></a>
rotateUp<span class="signature">(<span class="optional">angle</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2014">Scene/Camera.js 2014</a>
</div>
</h4>
</div>
<div class="description">
Rotates the camera around the center of the camera's reference frame by angle upwards.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The angle, in radians, to rotate by. Defaults to <code>defaultRotateAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#rotateDown">Camera#rotateDown</a></li>
<li><a href="Camera.html#rotate">Camera#rotate</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="setView">
<a href="#setView" class="doc-link"></a>
setView<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1432">Scene/Camera.js 1432</a>
</div>
</h4>
</div>
<div class="description">
Sets the camera position, orientation and transform.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>destination</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
|
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The final position of the camera in WGS84 (world) coordinates or a rectangle that would be visible from a top-down view.</td>
</tr>
<tr>
<td class="name"><code>orientation</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
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.</td>
</tr>
<tr>
<td class="name"><code>endTransform</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Transform matrix representing the reference frame of the camera.</td>
</tr>
<tr>
<td class="name"><code>convert</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether to convert the destination from world coordinates to scene coordinates (only relevant when not using 3D). Defaults to <code>true</code>.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// 1. Set position with a top-down view
viewer.camera.setView({
destination : Cesium.Cartesian3.fromDegrees(-117.16, 32.71, 15000.0)
});
// 2 Set view with heading, pitch and roll
viewer.camera.setView({
destination : cartesianPosition,
orientation: {
heading : Cesium.Math.toRadians(90.0), // east, default value is 0.0 (north)
pitch : Cesium.Math.toRadians(-90), // default value (looking down)
roll : 0.0 // default value
}
});
// 3. Change heading, pitch and roll with the camera position remaining the same.
viewer.camera.setView({
orientation: {
heading : Cesium.Math.toRadians(90.0), // east, default value is 0.0 (north)
pitch : Cesium.Math.toRadians(-90), // default value (looking down)
roll : 0.0 // default value
}
});
// 4. View rectangle with a top-down view
viewer.camera.setView({
destination : Cesium.Rectangle.fromDegrees(west, south, east, north)
});
// 5. Set position with an orientation using unit vectors.
viewer.camera.setView({
destination : Cesium.Cartesian3.fromDegrees(-122.19, 46.25, 5000.0),
orientation : {
direction : new Cesium.Cartesian3(-0.04231243104240401, -0.20123236049443421, -0.97862924300734),
up : new Cesium.Cartesian3(-0.47934589305293746, -0.8553216253114552, 0.1966022179118339)
}
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="switchToOrthographicFrustum">
<a href="#switchToOrthographicFrustum" class="doc-link"></a>
switchToOrthographicFrustum<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3886">Scene/Camera.js 3886</a>
</div>
</h4>
</div>
<div class="description">
Switches the frustum/projection to orthographic.
This function is a no-op in 2D which will always be orthographic.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="switchToPerspectiveFrustum">
<a href="#switchToPerspectiveFrustum" class="doc-link"></a>
switchToPerspectiveFrustum<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3866">Scene/Camera.js 3866</a>
</div>
</h4>
</div>
<div class="description">
Switches the frustum/projection to perspective.
This function is a no-op in 2D which must always be orthographic.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="twistLeft">
<a href="#twistLeft" class="doc-link"></a>
twistLeft<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1939">Scene/Camera.js 1939</a>
</div>
</h4>
</div>
<div class="description">
Rotate the camera counter-clockwise around its direction vector by amount, in radians.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#twistRight">Camera#twistRight</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="twistRight">
<a href="#twistRight" class="doc-link"></a>
twistRight<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1951">Scene/Camera.js 1951</a>
</div>
</h4>
</div>
<div class="description">
Rotate the camera clockwise around its direction vector by amount, in radians.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount, in radians, to rotate by. Defaults to <code>defaultLookAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#twistLeft">Camera#twistLeft</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="viewBoundingSphere">
<a href="#viewBoundingSphere" class="doc-link"></a>
viewBoundingSphere<span class="signature">(boundingSphere, <span class="optional">offset</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3491">Scene/Camera.js 3491</a>
</div>
</h4>
</div>
<div class="description">
Sets the camera so that the current view contains the provided bounding sphere.
<p>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.</p>
<p>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.</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>boundingSphere</code></td>
<td class="type">
<span class="param-type"><a href="BoundingSphere.html">BoundingSphere</a></span>
</td>
<td class="description last">
The bounding sphere to view, in world coordinates.</td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type"><a href="HeadingPitchRange.html">HeadingPitchRange</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The offset from the target in the local east-north-up reference frame centered at the target.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: viewBoundingSphere is not supported while morphing.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="worldToCameraCoordinates">
<a href="#worldToCameraCoordinates" class="doc-link"></a>
worldToCameraCoordinates<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian4.html">Cartesian4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1548">Scene/Camera.js 1548</a>
</div>
</h4>
</div>
<div class="description">
Transform a vector or point from world coordinates to the camera's reference frame.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cartesian</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian4.html">Cartesian4</a></span>
</td>
<td class="description last">
The vector or point to transform.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian4.html">Cartesian4</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The transformed vector or point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="worldToCameraCoordinatesPoint">
<a href="#worldToCameraCoordinatesPoint" class="doc-link"></a>
worldToCameraCoordinatesPoint<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1569">Scene/Camera.js 1569</a>
</div>
</h4>
</div>
<div class="description">
Transform a point from world coordinates to the camera's reference frame.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cartesian</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The point to transform.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The transformed point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="worldToCameraCoordinatesVector">
<a href="#worldToCameraCoordinatesVector" class="doc-link"></a>
worldToCameraCoordinatesVector<span class="signature">(cartesian, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian3.html">Cartesian3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L1590">Scene/Camera.js 1590</a>
</div>
</h4>
</div>
<div class="description">
Transform a vector from world coordinates to the camera's reference frame.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cartesian</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The vector to transform.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The transformed vector.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="zoomIn">
<a href="#zoomIn" class="doc-link"></a>
zoomIn<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2197">Scene/Camera.js 2197</a>
</div>
</h4>
</div>
<div class="description">
Zooms <code>amount</code> along the camera's view vector.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount to move. Defaults to <code>defaultZoomAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#zoomOut">Camera#zoomOut</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="zoomOut">
<a href="#zoomOut" class="doc-link"></a>
zoomOut<span class="signature">(<span class="optional">amount</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L2214">Scene/Camera.js 2214</a>
</div>
</h4>
</div>
<div class="description">
Zooms <code>amount</code> along the opposite direction of
the camera's view vector.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The amount to move. Defaults to <code>defaultZoomAmount</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Camera.html#zoomIn">Camera#zoomIn</a></li>
</ul>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".FlightCancelledCallback">
<a href="#.FlightCancelledCallback" class="doc-link"></a>
Cesium.Camera.FlightCancelledCallback<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3929">Scene/Camera.js 3929</a>
</div>
</h4>
</div>
<div class="description">
A function that will execute when a flight is cancelled.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".FlightCompleteCallback">
<a href="#.FlightCompleteCallback" class="doc-link"></a>
Cesium.Camera.FlightCompleteCallback<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Camera.js#L3924">Scene/Camera.js 3924</a>
</div>
</h4>
</div>
<div class="description">
A function that will execute when a flight completes.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>