jukaifeng
/
cesium-examples
mirror of https://github.com/zhangti0708/cesium-examples.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cesium-examples/map/3d/static/Cesium/Build/Documentation/Transforms.html

3156 lines
99 KiB
HTML
Raw Normal View History

删除不必要的冗余文件,上传部分示例数据
2020-06-29 11:14:44 +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>Transforms - 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>
Transforms
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L53">Core/Transforms.js 53</a>
</div>
<div class="description">Contains functions for transforming positions to various reference frames.</div>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".computeFixedToIcrfMatrix">
<a href="#.computeFixedToIcrfMatrix" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.computeFixedToIcrfMatrix<span class="signature">(date, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix3.html">Matrix3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L641">Core/Transforms.js 641</a>
</div>
</h4>
</div>
<div class="description">
Computes a rotation matrix to transform a point or vector from the Earth-Fixed frame axes (ITRF) to the International Celestial Reference Frame (GCRF/ICRF) inertial frame axes at a given time. This function may return undefined if the data necessary to do the transformation is not yet loaded.
</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>date</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time at which to compute the rotation matrix.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix3.html">Matrix3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result. If this parameter is not specified, a new instance is created and returned.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The rotation matrix, or undefined if the data necessary to do the transformation is not yet loaded.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Transform a point from the ICRF axes to the Fixed axes. var now = Cesium.JulianDate.now(); var pointInFixed = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var fixedToIcrf = Cesium.Transforms.computeIcrfToFixedMatrix(now); var pointInInertial = new Cesium.Cartesian3(); if (Cesium.defined(fixedToIcrf)) { pointInInertial = Cesium.Matrix3.multiplyByVector(fixedToIcrf, pointInFixed, pointInInertial); }</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Transforms.html#.preloadIcrfFixed">Transforms.preloadIcrfFixed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id=".computeIcrfToFixedMatrix">
<a href="#.computeIcrfToFixedMatrix" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.computeIcrfToFixedMatrix<span class="signature">(date, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix3.html">Matrix3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L593">Core/Transforms.js 593</a>
</div>
</h4>
</div>
<div class="description">
Computes a rotation matrix to transform a point or vector from the International Celestial Reference Frame (GCRF/ICRF) inertial frame axes to the Earth-Fixed frame axes (ITRF) at a given time. This function may return undefined if the data necessary to do the transformation is not yet loaded.
</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>date</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time at which to compute the rotation matrix.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix3.html">Matrix3</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result. If this parameter is not specified, a new instance is created and returned.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The rotation matrix, or undefined if the data necessary to do the transformation is not yet loaded.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">scene.postUpdate.addEventListener(function(scene, time) { // View in ICRF. var icrfToFixed = Cesium.Transforms.computeIcrfToFixedMatrix(time); if (Cesium.defined(icrfToFixed)) { var offset = Cesium.Cartesian3.clone(camera.position); var transform = Cesium.Matrix4.fromRotationTranslation(icrfToFixed); camera.lookAtTransform(transform, offset); } });</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Transforms.html#.preloadIcrfFixed">Transforms.preloadIcrfFixed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id=".computeTemeToPseudoFixedMatrix">
<a href="#.computeTemeToPseudoFixedMatrix" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.computeTemeToPseudoFixedMatrix<span class="signature">(date, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix3.html">Matrix3</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L458">Core/Transforms.js 458</a>
</div>
</h4>
</div>
<div class="description">
Computes a rotation matrix to transform a point or vector from True Equator Mean Equinox (TEME) axes to the pseudo-fixed axes at a given time. This method treats the UT1 time standard as equivalent to UTC.
</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>date</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time at which to compute the rotation matrix.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix3.html">Matrix3</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 modified result parameter or a new Matrix3 instance if none was provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">//Set the view to the inertial frame. scene.postUpdate.addEventListener(function(scene, time) { var now = Cesium.JulianDate.now(); var offset = Cesium.Matrix4.multiplyByPoint(camera.transform, camera.position, new Cesium.Cartesian3()); var transform = Cesium.Matrix4.fromRotationTranslation(Cesium.Transforms.computeTemeToPseudoFixedMatrix(now)); var inverseTransform = Cesium.Matrix4.inverseTransformation(transform, new Cesium.Matrix4()); Cesium.Matrix4.multiplyByPoint(inverseTransform, offset, offset); camera.lookAtTransform(transform, offset); });</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".eastNorthUpToFixedFrame">
<a href="#.eastNorthUpToFixedFrame" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.eastNorthUpToFixedFrame<span class="signature">(origin, <span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L237">Core/Transforms.js 237</a>
</div>
</h4>
</div>
<div class="description">
Computes a 4x4 transformation matrix from a reference frame with an east-north-up axes centered at the provided origin to the provided ellipsoid's fixed reference frame. The local axes are defined as: <ul> <li>The <code>x</code> axis points in the local east direction.</li> <li>The <code>y</code> axis points in the local north direction.</li> <li>The <code>z</code> axis points in the direction of the ellipsoid surface normal which passes through the position.</li> </ul>
</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>origin</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">
The center point of the local reference frame.</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</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">
The modified result parameter or a new Matrix4 instance if none was provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Get the transform from local east-north-up at cartographic (0.0, 0.0) to Earth's fixed frame. var center = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var transform = Cesium.Transforms.eastNorthUpToFixedFrame(center);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".fixedFrameToHeadingPitchRoll">
<a href="#.fixedFrameToHeadingPitchRoll" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.fixedFrameToHeadingPitchRoll<span class="signature">(transform, <span class="optional">ellipsoid</span>, <span class="optional">fixedFrameTransform</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="HeadingPitchRoll.html">HeadingPitchRoll</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L401">Core/Transforms.js 401</a>
</div>
</h4>
</div>
<div class="description">
Computes heading-pitch-roll angles from a transform in a particular reference frame. Heading is the rotation from the local north direction where a positive angle is increasing eastward. Pitch is the rotation from the local east-north plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. Roll is the first rotation applied about the local east axis.
</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>transform</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The transform</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>fixedFrameTransform</code></td>
<td class="type">
<span class="param-type"><a href="Transforms.html#~LocalFrameToFixedFrame">Transforms~LocalFrameToFixedFrame</a></span>
</td>
<td class="default">
<code class="language-javascript">Transforms.eastNorthUpToFixedFrame</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A 4x4 transformation matrix from a reference frame to the provided ellipsoid's fixed reference frame</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="HeadingPitchRoll.html">HeadingPitchRoll</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">
The modified result parameter or a new HeadingPitchRoll instance if none was provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".headingPitchRollQuaternion">
<a href="#.headingPitchRollQuaternion" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.headingPitchRollQuaternion<span class="signature">(origin, headingPitchRoll, <span class="optional">ellipsoid</span>, <span class="optional">fixedFrameTransform</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Quaternion.html">Quaternion</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L373">Core/Transforms.js 373</a>
</div>
</h4>
</div>
<div class="description">
Computes a quaternion from a reference frame with axes computed from the heading-pitch-roll angles centered at the provided origin. Heading is the rotation from the local north direction where a positive angle is increasing eastward. Pitch is the rotation from the local east-north plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. Roll is the first rotation applied about the local east axis.
</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>origin</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">
The center point of the local reference frame.</td>
</tr>
<tr>
<td class="name"><code>headingPitchRoll</code></td>
<td class="type">
<span class="param-type"><a href="HeadingPitchRoll.html">HeadingPitchRoll</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The heading, pitch, and roll.</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>fixedFrameTransform</code></td>
<td class="type">
<span class="param-type"><a href="Transforms.html#~LocalFrameToFixedFrame">Transforms~LocalFrameToFixedFrame</a></span>
</td>
<td class="default">
<code class="language-javascript">Transforms.eastNorthUpToFixedFrame</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A 4x4 transformation matrix from a reference frame to the provided ellipsoid's fixed reference frame</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Quaternion.html">Quaternion</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">
The modified result parameter or a new Quaternion instance if none was provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Get the quaternion from local heading-pitch-roll at cartographic (0.0, 0.0) to Earth's fixed frame. var center = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var heading = -Cesium.Math.PI_OVER_TWO; var pitch = Cesium.Math.PI_OVER_FOUR; var roll = 0.0; var hpr = new HeadingPitchRoll(heading, pitch, roll); var quaternion = Cesium.Transforms.headingPitchRollQuaternion(center, hpr);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".headingPitchRollToFixedFrame">
<a href="#.headingPitchRollToFixedFrame" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.headingPitchRollToFixedFrame<span class="signature">(origin, headingPitchRoll, <span class="optional">ellipsoid</span>, <span class="optional">fixedFrameTransform</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L335">Core/Transforms.js 335</a>
</div>
</h4>
</div>
<div class="description">
Computes a 4x4 transformation matrix from a reference frame with axes computed from the heading-pitch-roll angles centered at the provided origin to the provided ellipsoid's fixed reference frame. Heading is the rotation from the local north direction where a positive angle is increasing eastward. Pitch is the rotation from the local east-north plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. Roll is the first rotation applied about the local east axis.
</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>origin</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">
The center point of the local reference frame.</td>
</tr>
<tr>
<td class="name"><code>headingPitchRoll</code></td>
<td class="type">
<span class="param-type"><a href="HeadingPitchRoll.html">HeadingPitchRoll</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The heading, pitch, and roll.</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>fixedFrameTransform</code></td>
<td class="type">
<span class="param-type"><a href="Transforms.html#~LocalFrameToFixedFrame">Transforms~LocalFrameToFixedFrame</a></span>
</td>
<td class="default">
<code class="language-javascript">Transforms.eastNorthUpToFixedFrame</code>
</td>
<td class="description last">
<span class="optional">optional</span>
A 4x4 transformation matrix from a reference frame to the provided ellipsoid's fixed reference frame</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</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">
The modified result parameter or a new Matrix4 instance if none was provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Get the transform from local heading-pitch-roll at cartographic (0.0, 0.0) to Earth's fixed frame. var center = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var heading = -Cesium.Math.PI_OVER_TWO; var pitch = Cesium.Math.PI_OVER_FOUR; var roll = 0.0; var hpr = new Cesium.HeadingPitchRoll(heading, pitch, roll); var transform = Cesium.Transforms.headingPitchRollToFixedFrame(center, hpr);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".localFrameToFixedFrameGenerator">
<a href="#.localFrameToFixedFrameGenerator" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.localFrameToFixedFrameGenerator<span class="signature">(firstAxis, secondAxis)</span> &rarr; <span class="type-signature returnType">localFrameToFixedFrameGenerator~resultat</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L126">Core/Transforms.js 126</a>
</div>
</h4>
</div>
<div class="description">
Generates a function that computes a 4x4 transformation matrix from a reference frame centered at the provided origin to the provided ellipsoid's fixed 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>firstAxis</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
name of the first axis of the local reference frame. Must be 'east', 'north', 'up', 'west', 'south' or 'down'.</td>
</tr>
<tr>
<td class="name"><code>secondAxis</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
name of the second axis of the local reference frame. Must be 'east', 'north', 'up', 'west', 'south' or 'down'.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The function that will computes a 4x4 transformation matrix from a reference frame, with first axis and second axis compliant with the parameters,
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".northEastDownToFixedFrame">
<a href="#.northEastDownToFixedFrame" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.northEastDownToFixedFrame<span class="signature">(origin, <span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L260">Core/Transforms.js 260</a>
</div>
</h4>
</div>
<div class="description">
Computes a 4x4 transformation matrix from a reference frame with an north-east-down axes centered at the provided origin to the provided ellipsoid's fixed reference frame. The local axes are defined as: <ul> <li>The <code>x</code> axis points in the local north direction.</li> <li>The <code>y</code> axis points in the local east direction.</li> <li>The <code>z</code> axis points in the opposite direction of the ellipsoid surface normal which passes through the position.</li> </ul>
</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>origin</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">
The center point of the local reference frame.</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</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">
The modified result parameter or a new Matrix4 instance if none was provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Get the transform from local north-east-down at cartographic (0.0, 0.0) to Earth's fixed frame. var center = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var transform = Cesium.Transforms.northEastDownToFixedFrame(center);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".northUpEastToFixedFrame">
<a href="#.northUpEastToFixedFrame" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.northUpEastToFixedFrame<span class="signature">(origin, <span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L283">Core/Transforms.js 283</a>
</div>
</h4>
</div>
<div class="description">
Computes a 4x4 transformation matrix from a reference frame with an north-up-east axes centered at the provided origin to the provided ellipsoid's fixed reference frame. The local axes are defined as: <ul> <li>The <code>x</code> axis points in the local north direction.</li> <li>The <code>y</code> axis points in the direction of the ellipsoid surface normal which passes through the position.</li> <li>The <code>z</code> axis points in the local east direction.</li> </ul>
</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>origin</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">
The center point of the local reference frame.</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</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">
The modified result parameter or a new Matrix4 instance if none was provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Get the transform from local north-up-east at cartographic (0.0, 0.0) to Earth's fixed frame. var center = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var transform = Cesium.Transforms.northUpEastToFixedFrame(center);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".northWestUpToFixedFrame">
<a href="#.northWestUpToFixedFrame" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.northWestUpToFixedFrame<span class="signature">(origin, <span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L306">Core/Transforms.js 306</a>
</div>
</h4>
</div>
<div class="description">
Computes a 4x4 transformation matrix from a reference frame with an north-west-up axes centered at the provided origin to the provided ellipsoid's fixed reference frame. The local axes are defined as: <ul> <li>The <code>x</code> axis points in the local north direction.</li> <li>The <code>y</code> axis points in the local west direction.</li> <li>The <code>z</code> axis points in the direction of the ellipsoid surface normal which passes through the position.</li> </ul>
</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>origin</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">
The center point of the local reference frame.</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</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">
The modified result parameter or a new Matrix4 instance if none was provided.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Get the transform from local north-West-Up at cartographic (0.0, 0.0) to Earth's fixed frame. var center = Cesium.Cartesian3.fromDegrees(0.0, 0.0); var transform = Cesium.Transforms.northWestUpToFixedFrame(center);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".pointToWindowCoordinates">
<a href="#.pointToWindowCoordinates" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.pointToWindowCoordinates<span class="signature">(modelViewProjectionMatrix, viewportTransformation, point, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L756">Core/Transforms.js 756</a>
</div>
</h4>
</div>
<div class="description">
Transform a point from model coordinates to window 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>modelViewProjectionMatrix</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
The 4x4 model-view-projection matrix.</td>
</tr>
<tr>
<td class="name"><code>viewportTransformation</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="description last">
The 4x4 viewport transformation.</td>
</tr>
<tr>
<td class="name"><code>point</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="Cartesian2.html">Cartesian2</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 modified result parameter or a new Cartesian2 instance if none was provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".preloadIcrfFixed">
<a href="#.preloadIcrfFixed" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.Transforms.preloadIcrfFixed<span class="signature">(timeInterval)</span> &rarr; <span class="type-signature returnType">Promise</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L555">Core/Transforms.js 555</a>
</div>
</h4>
</div>
<div class="description">
Preloads the data necessary to transform between the ICRF and Fixed axes, in either direction, over a given interval. This function returns a promise that, when resolved, indicates that the preload has completed.
</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>timeInterval</code></td>
<td class="type">
<span class="param-type"><a href="TimeInterval.html">TimeInterval</a></span>
</td>
<td class="description last">
The interval to preload.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise that, when resolved, indicates that the preload has completed and evaluation of the transformation between the fixed and ICRF axes will no longer return undefined for a time inside the interval.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">var interval = new Cesium.TimeInterval(...); when(Cesium.Transforms.preloadIcrfFixed(interval), function() { // the data is now loaded });</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Transforms.html#.computeIcrfToFixedMatrix">Transforms.computeIcrfToFixedMatrix</a></li>
<li><a href="Transforms.html#.computeFixedToIcrfMatrix">Transforms.computeFixedToIcrfMatrix</a></li>
<li>when</li>
</ul>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id="~LocalFrameToFixedFrame">
<a href="#~LocalFrameToFixedFrame" class="doc-link"></a>
LocalFrameToFixedFrame<span class="signature">(origin, <span class="optional">ellipsoid</span>, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="Matrix4.html">Matrix4</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/Transforms.js#L132">Core/Transforms.js 132</a>
</div>
</h4>
</div>
<div class="description">
Computes a 4x4 transformation matrix from a reference frame centered at the provided origin to the provided ellipsoid's fixed reference frame.
</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>origin</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">
The center point of the local reference frame.</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 whose fixed frame is used in the transformation.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</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">
The modified result parameter or a new Matrix4 instance if none was provided.
</div>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</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="ArcType"><a href="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</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="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-name="Cesium3DTileFeature"><a href="Cesium3DTileFeature.html">Cesium3DTileFeature</a></li><li data-name="Cesium3DTilePointFeature"><a href="Cesium3
</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>