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

2034 lines
71 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>GeometryUpdater - 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>
GeometryUpdater
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="GeometryUpdater">
<a href="#GeometryUpdater" class="doc-link"></a>
new Cesium.GeometryUpdater<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L41">DataSources/GeometryUpdater.js 41</a>
</div>
</h4>
</div>
<div class="description">
An abstract class for updating geometry entities.
</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">
An 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>entity</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html">Entity</a></span>
</td>
<td class="description last">
The entity containing the geometry to be visualized.</td>
</tr>
<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 where visualization is taking place.</td>
</tr>
<tr>
<td class="name"><code>geometryOptions</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Options for the geometry</td>
</tr>
<tr>
<td class="name"><code>geometryPropertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
The geometry property name</td>
</tr>
<tr>
<td class="name"><code>observedPropertyNames</code></td>
<td class="type">
<span class="param-type">Array.&lt;String></span>
</td>
<td class="description last">
The entity properties this geometry cares about</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="classificationTypeProperty">
<a href="#classificationTypeProperty" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> classificationTypeProperty<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L229">DataSources/GeometryUpdater.js 229</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="global.html#ClassificationType"><code>ClassificationType</code></a> Property specifying if this geometry will classify terrain, 3D Tiles, or both when on the ground.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayConditionProperty">
<a href="#distanceDisplayConditionProperty" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> distanceDisplayConditionProperty<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L217">DataSources/GeometryUpdater.js 217</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="DistanceDisplayCondition.html"><code>DistanceDisplayCondition</code></a> Property specifying at what distance from the camera that this geometry will be displayed.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="entity">
<a href="#entity" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> entity<span class="type-signature"> : <a href="Entity.html">Entity</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L97">DataSources/GeometryUpdater.js 97</a>
</div>
</h4>
</div>
<div class="description">
Gets the entity associated with this geometry.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="fillEnabled">
<a href="#fillEnabled" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> fillEnabled<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L109">DataSources/GeometryUpdater.js 109</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if the geometry has a fill component.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="fillMaterialProperty">
<a href="#fillMaterialProperty" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> fillMaterialProperty<span class="type-signature"> : <a href="MaterialProperty.html">MaterialProperty</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L138">DataSources/GeometryUpdater.js 138</a>
</div>
</h4>
</div>
<div class="description">
Gets the material property used to fill the geometry.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="geometryChanged">
<a href="#geometryChanged" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> geometryChanged<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L281">DataSources/GeometryUpdater.js 281</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that is raised whenever the public properties
of this updater change.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="hasConstantFill">
<a href="#hasConstantFill" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> hasConstantFill<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L121">DataSources/GeometryUpdater.js 121</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if fill visibility varies with simulation time.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="hasConstantOutline">
<a href="#hasConstantOutline" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> hasConstantOutline<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L162">DataSources/GeometryUpdater.js 162</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if the geometry has an outline component.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="id">
<a href="#id" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> id<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L85">DataSources/GeometryUpdater.js 85</a>
</div>
</h4>
</div>
<div class="description">
Gets the unique ID associated with this updater
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isClosed">
<a href="#isClosed" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> isClosed<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L256">DataSources/GeometryUpdater.js 256</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if the geometry is closed.
This property is only valid for static geometry.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isDynamic">
<a href="#isDynamic" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> isDynamic<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L243">DataSources/GeometryUpdater.js 243</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if the geometry is time-varying.
If true, all visualization is delegated to a DynamicGeometryUpdater
returned by GeometryUpdater#createDynamicUpdater.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineColorProperty">
<a href="#outlineColorProperty" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> outlineColorProperty<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L179">DataSources/GeometryUpdater.js 179</a>
</div>
</h4>
</div>
<div class="description">
Gets the <a href="Color.html"><code>Color</code></a> property for the geometry outline.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineEnabled">
<a href="#outlineEnabled" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> outlineEnabled<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L150">DataSources/GeometryUpdater.js 150</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating if the geometry has an outline component.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineWidth">
<a href="#outlineWidth" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> outlineWidth<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L192">DataSources/GeometryUpdater.js 192</a>
</div>
</h4>
</div>
<div class="description">
Gets the constant with of the geometry outline, in pixels.
This value is only valid if isDynamic is false.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="shadowsProperty">
<a href="#shadowsProperty" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> shadowsProperty<span class="type-signature"> : <a href="Property.html">Property</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L205">DataSources/GeometryUpdater.js 205</a>
</div>
</h4>
</div>
<div class="description">
Gets the property specifying whether the geometry
casts or receives shadows from light sources.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="createFillGeometryInstance">
<a href="#createFillGeometryInstance" class="doc-link"></a>
createFillGeometryInstance<span class="signature">(time)</span> &rarr; <span class="type-signature returnType"><a href="GeometryInstance.html">GeometryInstance</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L329">DataSources/GeometryUpdater.js 329</a>
</div>
</h4>
</div>
<div class="description">
Creates the geometry instance which represents the fill of the geometry.
</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>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time to use when retrieving initial attribute values.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The geometry instance representing the filled portion of the geometry.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This instance does not represent a filled geometry.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="createOutlineGeometryInstance">
<a href="#createOutlineGeometryInstance" class="doc-link"></a>
createOutlineGeometryInstance<span class="signature">(time)</span> &rarr; <span class="type-signature returnType"><a href="GeometryInstance.html">GeometryInstance</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/GeometryUpdater.js#L341">DataSources/GeometryUpdater.js 341</a>
</div>
</h4>
</div>
<div class="description">
Creates the geometry instance which represents the outline of the geometry.
</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>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time to use when retrieving initial attribute values.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The geometry instance representing the outline portion of the geometry.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This instance does not represent an outlined geometry.
</div>
</li>
</ul>
<dl class="details">
</dl>
<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/DataSources/GeometryUpdater.js#L358">DataSources/GeometryUpdater.js 358</a>
</div>
</h4>
</div>
<div class="description">
Destroys and resources used by the object. Once an object is destroyed, it should not be used.
</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">
</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/DataSources/GeometryUpdater.js#L349">DataSources/GeometryUpdater.js 349</a>
</div>
</h4>
</div>
<div class="description">
Returns true if this object was destroyed; otherwise, false.
</div>
<h5>Returns:</h5>
<div class="param-desc">
True if this object was destroyed; otherwise, false.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isFilled">
<a href="#isFilled" class="doc-link"></a>
isFilled<span class="signature">(time)</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/DataSources/GeometryUpdater.js#L310">DataSources/GeometryUpdater.js 310</a>
</div>
</h4>
</div>
<div class="description">
Checks if the geometry is filled at the provided time.
</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>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time for which to retrieve visibility.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
true if geometry is filled at the provided time, false otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isOutlineVisible">
<a href="#isOutlineVisible" class="doc-link"></a>
isOutlineVisible<span class="signature">(time)</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/DataSources/GeometryUpdater.js#L294">DataSources/GeometryUpdater.js 294</a>
</div>
</h4>
</div>
<div class="description">
Checks if the geometry is outlined at the provided time.
</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>time</code></td>
<td class="type">
<span class="param-type"><a href="JulianDate.html">JulianDate</a></span>
</td>
<td class="description last">
The time for which to retrieve visibility.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
true if geometry is outlined at the provided time, false otherwise.
</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>