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

1133 lines
62 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>ScreenSpaceEventHandler - 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>
ScreenSpaceEventHandler
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ScreenSpaceEventHandler">
<a href="#ScreenSpaceEventHandler" class="doc-link"></a>
new Cesium.ScreenSpaceEventHandler<span class="signature">(<span class="optional">element</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L905">Core/ScreenSpaceEventHandler.js 905</a>
</div>
</h4>
</div>
<div class="description">
Handles user input events. Custom functions can be added to be executed on
when the user enters input.
</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>element</code></td>
<td class="type">
<span class="param-type">HTMLCanvasElement</span>
</td>
<td class="default">
<code class="language-javascript">document</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The element to add events to.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".mouseEmulationIgnoreMilliseconds">
<a href="#.mouseEmulationIgnoreMilliseconds" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ScreenSpaceEventHandler.mouseEmulationIgnoreMilliseconds<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L1054">Core/ScreenSpaceEventHandler.js 1054</a>
</div>
</h4>
</div>
<div class="description">
The amount of time, in milliseconds, that mouse events will be disabled after
receiving any touch events, such that any emulated mouse events will be ignored.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">800</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".touchHoldDelayMilliseconds">
<a href="#.touchHoldDelayMilliseconds" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ScreenSpaceEventHandler.touchHoldDelayMilliseconds<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L1062">Core/ScreenSpaceEventHandler.js 1062</a>
</div>
</h4>
</div>
<div class="description">
The amount of time, in milliseconds, before a touch on the screen becomes a
touch and hold.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1500</code>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L1042">Core/ScreenSpaceEventHandler.js 1042</a>
</div>
</h4>
</div>
<div class="description">
Removes listeners held by this object.
<br /><br />
Once an object is destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore,
assign the return value (<code>undefined</code>) to the object as done in the example.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">handler = handler &amp;&amp; handler.destroy();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="ScreenSpaceEventHandler.html#isDestroyed">ScreenSpaceEventHandler#isDestroyed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="getInputAction">
<a href="#getInputAction" class="doc-link"></a>
getInputAction<span class="signature">(type, <span class="optional">modifier</span>)</span> &rarr; <span class="type-signature returnType">function</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L978">Core/ScreenSpaceEventHandler.js 978</a>
</div>
</h4>
</div>
<div class="description">
Returns the function to be executed on an input event.
</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>type</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The ScreenSpaceEventType of input event.</td>
</tr>
<tr>
<td class="name"><code>modifier</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
A KeyboardEventModifier key that is held when a <code>type</code>
event occurs.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The function to be executed on an input event.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="ScreenSpaceEventHandler.html#setInputAction">ScreenSpaceEventHandler#setInputAction</a></li>
<li><a href="ScreenSpaceEventHandler.html#removeInputAction">ScreenSpaceEventHandler#removeInputAction</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="isDestroyed">
<a href="#isDestroyed" class="doc-link"></a>
isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L1023">Core/ScreenSpaceEventHandler.js 1023</a>
</div>
</h4>
</div>
<div class="description">
Returns true if this object was destroyed; otherwise, false.
<br /><br />
If this object was destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if this object was destroyed; otherwise, <code>false</code>.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="ScreenSpaceEventHandler.html#destroy">ScreenSpaceEventHandler#destroy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="removeInputAction">
<a href="#removeInputAction" class="doc-link"></a>
removeInputAction<span class="signature">(type, <span class="optional">modifier</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L999">Core/ScreenSpaceEventHandler.js 999</a>
</div>
</h4>
</div>
<div class="description">
Removes the function to be executed on an input event.
</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>type</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The ScreenSpaceEventType of input event.</td>
</tr>
<tr>
<td class="name"><code>modifier</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
A KeyboardEventModifier key that is held when a <code>type</code>
event occurs.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="ScreenSpaceEventHandler.html#getInputAction">ScreenSpaceEventHandler#getInputAction</a></li>
<li><a href="ScreenSpaceEventHandler.html#setInputAction">ScreenSpaceEventHandler#setInputAction</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="setInputAction">
<a href="#setInputAction" class="doc-link"></a>
setInputAction<span class="signature">(action, type, <span class="optional">modifier</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/ScreenSpaceEventHandler.js#L948">Core/ScreenSpaceEventHandler.js 948</a>
</div>
</h4>
</div>
<div class="description">
Set a function to be executed on an input event.
</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>action</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last">
Function to be executed when the input event occurs.</td>
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The ScreenSpaceEventType of input event.</td>
</tr>
<tr>
<td class="name"><code>modifier</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
<span class="optional">optional</span>
A KeyboardEventModifier key that is held when a <code>type</code>
event occurs.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="ScreenSpaceEventHandler.html#getInputAction">ScreenSpaceEventHandler#getInputAction</a></li>
<li><a href="ScreenSpaceEventHandler.html#removeInputAction">ScreenSpaceEventHandler#removeInputAction</a></li>
</ul>
</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>