qd-changjing/public/static/Build/Documentation/SelectionIndicatorViewModel...

1121 lines
60 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>SelectionIndicatorViewModel - 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>
SelectionIndicatorViewModel
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="SelectionIndicatorViewModel">
<a href="#SelectionIndicatorViewModel" class="doc-link"></a>
new Cesium.SelectionIndicatorViewModel<span class="signature">(scene, selectionIndicatorElement, container)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L21">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 21</a>
</div>
</h4>
</div>
<div class="description">
The view model for <a href="SelectionIndicator.html"><code>SelectionIndicator</code></a>.
</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 instance to use for screen-space coordinate conversion.</td>
</tr>
<tr>
<td class="name"><code>selectionIndicatorElement</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last">
The element containing all elements that make up the selection indicator.</td>
</tr>
<tr>
<td class="name"><code>container</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last">
The DOM element that contains the widget.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="computeScreenSpacePosition">
<a href="#computeScreenSpacePosition" class="doc-link"></a>
computeScreenSpacePosition<span class="type-signature"> : <a href="SelectionIndicatorViewModel.html#.ComputeScreenSpacePosition">SelectionIndicatorViewModel.ComputeScreenSpacePosition</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L98">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 98</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the function for converting the world position of the object to the screen space position.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">SceneTransforms.wgs84ToWindowCoordinates</code>
<h5>Example:</h5>
<pre><code class="language-javascript">selectionIndicatorViewModel.computeScreenSpacePosition = function(position, result) {
return Cesium.SceneTransforms.wgs84ToWindowCoordinates(scene, position, result);
};</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="container">
<a href="#container" class="doc-link"></a>
container<span class="type-signature"> : Element</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L175">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 175</a>
</div>
</h4>
</div>
<div class="description">
Gets the HTML element containing the selection indicator.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isVisible">
<a href="#isVisible" class="doc-link"></a>
isVisible<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L73">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 73</a>
</div>
</h4>
</div>
<div class="description">
Gets the visibility of the position indicator. This can be false even if an
object is selected, when the selected object has no position.
</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/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L52">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 52</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the world position of the object for which to display the selection indicator.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="scene">
<a href="#scene" class="doc-link"></a>
scene<span class="type-signature"> : <a href="Scene.html">Scene</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L199">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 199</a>
</div>
</h4>
</div>
<div class="description">
Gets the scene being used.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="selectionIndicatorElement">
<a href="#selectionIndicatorElement" class="doc-link"></a>
selectionIndicatorElement<span class="type-signature"> : Element</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L187">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 187</a>
</div>
</h4>
</div>
<div class="description">
Gets the HTML element that holds the selection indicator.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="showSelection">
<a href="#showSelection" class="doc-link"></a>
showSelection<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L58">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 58</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the visibility of the selection indicator.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="animateAppear">
<a href="#animateAppear" class="doc-link"></a>
animateAppear<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L143">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 143</a>
</div>
</h4>
</div>
<div class="description">
Animate the indicator to draw attention to the selection.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="animateDepart">
<a href="#animateDepart" class="doc-link"></a>
animateDepart<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L157">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 157</a>
</div>
</h4>
</div>
<div class="description">
Animate the indicator to release the selection.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="update">
<a href="#update" class="doc-link"></a>
update<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L107">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 107</a>
</div>
</h4>
</div>
<div class="description">
Updates the view of the selection indicator to match the position and content properties of the view model.
This function should be called as part of the render loop.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".ComputeScreenSpacePosition">
<a href="#.ComputeScreenSpacePosition" class="doc-link"></a>
Cesium.SelectionIndicatorViewModel.ComputeScreenSpacePosition<span class="signature">(position, result)</span> &rarr; <span class="type-signature returnType"><a href="Cartesian2.html">Cartesian2</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/SelectionIndicator/SelectionIndicatorViewModel.js#L206">Widgets/SelectionIndicator/SelectionIndicatorViewModel.js 206</a>
</div>
</h4>
</div>
<div class="description">
A function that converts the world position of an object to a screen space 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>position</code></td>
<td class="type">
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
</td>
<td class="description last">
The position in WGS84 (world) coordinates.</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">
An object to return the input position transformed to window coordinates.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter.
</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>