wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/KmlTour.html

1160 lines
59 KiB
HTML
Raw Normal View History

first commit
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>KmlTour - 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>
KmlTour
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="KmlTour">
<a href="#KmlTour" class="doc-link"></a>
new Cesium.KmlTour<span class="signature">(name, id, playlist)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L19">DataSources/KmlTour.js 19</a>
</div>
</h4>
</div>
<div class="description">
Describes a KmlTour, which uses KmlTourFlyTo, and KmlTourWait to
guide the camera to a specified destinations on given time intervals.
</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>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
name parsed from KML</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
id parsed from KML</td>
</tr>
<tr>
<td class="name"><code>playlist</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">
array with KmlTourFlyTos and KmlTourWaits</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/?src=KML%2520Tours.html">KML Tours</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="KmlTourFlyTo.html">KmlTourFlyTo</a></li>
<li><a href="KmlTourWait.html">KmlTourWait</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="entryEnd">
<a href="#entryEnd" class="doc-link"></a>
entryEnd<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/DataSources/KmlTour.js#L70">DataSources/KmlTour.js 70</a>
</div>
</h4>
</div>
<div class="description">
Event will be called when entry from playlist ends to play.
Event callback will be called with following parameters:
1. entry - entry
2. terminated - true if playback was terminated by calling <a href="KmlTour.html#stop"><code>KmlTour#stop</code></a>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="entryStart">
<a href="#entryStart" class="doc-link"></a>
entryStart<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/DataSources/KmlTour.js#L61">DataSources/KmlTour.js 61</a>
</div>
</h4>
</div>
<div class="description">
Event will be called when entry from playlist starts to play.
Event callback will be called with curent entry as first parameter.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="id">
<a href="#id" class="doc-link"></a>
id<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L24">DataSources/KmlTour.js 24</a>
</div>
</h4>
</div>
<div class="description">
Id of kml gx:Tour entry
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="name">
<a href="#name" class="doc-link"></a>
name<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L29">DataSources/KmlTour.js 29</a>
</div>
</h4>
</div>
<div class="description">
Tour name
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="playlist">
<a href="#playlist" class="doc-link"></a>
playlist<span class="type-signature"> : Array</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L39">DataSources/KmlTour.js 39</a>
</div>
</h4>
</div>
<div class="description">
Array of playlist entries
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="playlistIndex">
<a href="#playlistIndex" class="doc-link"></a>
playlistIndex<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L34">DataSources/KmlTour.js 34</a>
</div>
</h4>
</div>
<div class="description">
Index of current entry from playlist
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tourEnd">
<a href="#tourEnd" class="doc-link"></a>
tourEnd<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/DataSources/KmlTour.js#L54">DataSources/KmlTour.js 54</a>
</div>
</h4>
</div>
<div class="description">
Event will be called when all playlist entries are
played, or tour playback being canceled.
If tour playback was terminated, event callback will
be called with terminated=true parameter.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tourStart">
<a href="#tourStart" class="doc-link"></a>
tourStart<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/DataSources/KmlTour.js#L45">DataSources/KmlTour.js 45</a>
</div>
</h4>
</div>
<div class="description">
Event will be called when tour starts to play,
before any playlist entry starts to play.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="addPlaylistEntry">
<a href="#addPlaylistEntry" class="doc-link"></a>
addPlaylistEntry<span class="signature">(entry)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L80">DataSources/KmlTour.js 80</a>
</div>
</h4>
</div>
<div class="description">
Add entry to this tour playlist.
</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>entry</code></td>
<td class="type">
<span class="param-type"><a href="KmlTourFlyTo.html">KmlTourFlyTo</a></span>
|
<span class="param-type"><a href="KmlTourWait.html">KmlTourWait</a></span>
</td>
<td class="description last">
an entry to add to the playlist.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="play">
<a href="#play" class="doc-link"></a>
play<span class="signature">(viewer, <span class="optional">cameraOptions</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L91">DataSources/KmlTour.js 91</a>
</div>
</h4>
</div>
<div class="description">
Play this tour.
</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>viewer</code></td>
<td class="type">
<span class="param-type"><a href="Viewer.html">Viewer</a></span>
</td>
<td class="description last">
viewer widget.</td>
</tr>
<tr>
<td class="name"><code>cameraOptions</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
these options will be merged with <a href="Camera.html#flyTo"><code>Camera#flyTo</code></a>
options for FlyTo playlist entries.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="stop">
<a href="#stop" class="doc-link"></a>
stop<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/KmlTour.js#L108">DataSources/KmlTour.js 108</a>
</div>
</h4>
</div>
<div class="description">
Stop curently playing tour.
</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>