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

1296 lines
65 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>PointPrimitive - 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>
PointPrimitive
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="PointPrimitive">
<a href="#PointPrimitive" class="doc-link"></a>
new Cesium.PointPrimitive<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L41">Scene/PointPrimitive.js 41</a>
</div>
</h4>
</div>
<div class="description">
A graphical point positioned in the 3D scene, that is created
and rendered using a <a href="PointPrimitiveCollection.html"><code>PointPrimitiveCollection</code></a>. A point is created and its initial
properties are set by calling <a href="PointPrimitiveCollection.html#add"><code>PointPrimitiveCollection#add</code></a>.
</div>
<h5>Performance:</h5>
<p class="description">Reading a property, e.g., <a href="PointPrimitive.html#show"><code>PointPrimitive#show</code></a>, is constant time.
Assigning to a property is constant time but results in
CPU to GPU traffic when <code>PointPrimitiveCollection#update</code> is called. The per-pointPrimitive traffic is
the same regardless of how many properties were updated. If most pointPrimitives in a collection need to be
updated, it may be more efficient to clear the collection with <a href="PointPrimitiveCollection.html#removeAll"><code>PointPrimitiveCollection#removeAll</code></a>
and add new pointPrimitives instead of modifying each one.</p>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: scaleByDistance.far must be greater than scaleByDistance.near
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: translucencyByDistance.far must be greater than translucencyByDistance.near
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: distanceDisplayCondition.far must be greater than distanceDisplayCondition.near
</div>
</li>
</ul>
<dl class="details">
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Points.html">Cesium Sandcastle Points Demo</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="PointPrimitiveCollection.html">PointPrimitiveCollection</a></li>
<li><a href="PointPrimitiveCollection.html#add">PointPrimitiveCollection#add</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="color">
<a href="#color" class="doc-link"></a>
color<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L323">Scene/PointPrimitive.js 323</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the inner color of the point.
The red, green, blue, and alpha values are indicated by <code>value</code>'s <code>red</code>, <code>green</code>,
<code>blue</code>, and <code>alpha</code> properties as shown in Example 1. These components range from <code>0.0</code>
(no intensity) to <code>1.0</code> (full intensity).
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">// Example 1. Assign yellow.
p.color = Cesium.Color.YELLOW;</code></pre>
<pre><code class="language-javascript">// Example 2. Make a pointPrimitive 50% translucent.
p.color = new Cesium.Color(1.0, 1.0, 1.0, 0.5);</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="disableDepthTestDistance">
<a href="#disableDepthTestDistance" class="doc-link"></a>
disableDepthTestDistance<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L425">Scene/PointPrimitive.js 425</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<span class="type-signature"> : <a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L396">Scene/PointPrimitive.js 396</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the condition specifying at what distance from the camera that this point will be displayed.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="id">
<a href="#id" class="doc-link"></a>
id<span class="type-signature"> : *</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L449">Scene/PointPrimitive.js 449</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the user-defined value returned when the point is picked.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineColor">
<a href="#outlineColor" class="doc-link"></a>
outlineColor<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L347">Scene/PointPrimitive.js 347</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the outline color of the point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="outlineWidth">
<a href="#outlineWidth" class="doc-link"></a>
outlineWidth<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L372">Scene/PointPrimitive.js 372</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the outline width in pixels. This width adds to pixelSize,
increasing the total size of the point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pixelSize">
<a href="#pixelSize" class="doc-link"></a>
pixelSize<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L289">Scene/PointPrimitive.js 289</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the inner size of the point in pixels.
</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/Scene/PointPrimitive.js#L173">Scene/PointPrimitive.js 173</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Cartesian position of this point.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="scaleByDistance">
<a href="#scaleByDistance" class="doc-link"></a>
scaleByDistance<span class="type-signature"> : <a href="NearFarScalar.html">NearFarScalar</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L217">Scene/PointPrimitive.js 217</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets near and far scaling properties of a point based on the point's distance from the camera.
A point's scale will interpolate between the <a href="NearFarScalar.html#nearValue"><code>NearFarScalar#nearValue</code></a> and
<a href="NearFarScalar.html#farValue"><code>NearFarScalar#farValue</code></a> while the camera distance falls within the lower and upper bounds
of the specified <a href="NearFarScalar.html#near"><code>NearFarScalar#near</code></a> and <a href="NearFarScalar.html#far"><code>NearFarScalar#far</code></a>.
Outside of these ranges the point's scale remains clamped to the nearest bound. This scale
multiplies the pixelSize and outlineWidth to affect the total size of the point. If undefined,
scaleByDistance will be disabled.
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">// Example 1.
// Set a pointPrimitive's scaleByDistance to scale to 15 when the
// camera is 1500 meters from the pointPrimitive and disappear as
// the camera distance approaches 8.0e6 meters.
p.scaleByDistance = new Cesium.NearFarScalar(1.5e2, 15, 8.0e6, 0.0);</code></pre>
<pre><code class="language-javascript">// Example 2.
// disable scaling by distance
p.scaleByDistance = undefined;</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L150">Scene/PointPrimitive.js 150</a>
</div>
</h4>
</div>
<div class="description">
Determines if this point will be shown. Use this to hide or show a point, instead
of removing it and re-adding it to the collection.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="translucencyByDistance">
<a href="#translucencyByDistance" class="doc-link"></a>
translucencyByDistance<span class="type-signature"> : <a href="NearFarScalar.html">NearFarScalar</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L260">Scene/PointPrimitive.js 260</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets near and far translucency properties of a point based on the point's distance from the camera.
A point's translucency will interpolate between the <a href="NearFarScalar.html#nearValue"><code>NearFarScalar#nearValue</code></a> and
<a href="NearFarScalar.html#farValue"><code>NearFarScalar#farValue</code></a> while the camera distance falls within the lower and upper bounds
of the specified <a href="NearFarScalar.html#near"><code>NearFarScalar#near</code></a> and <a href="NearFarScalar.html#far"><code>NearFarScalar#far</code></a>.
Outside of these ranges the point's translucency remains clamped to the nearest bound. If undefined,
translucencyByDistance will be disabled.
</div>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">// Example 1.
// Set a point's translucency to 1.0 when the
// camera is 1500 meters from the point and disappear as
// the camera distance approaches 8.0e6 meters.
p.translucencyByDistance = new Cesium.NearFarScalar(1.5e2, 1.0, 8.0e6, 0.0);</code></pre>
<pre><code class="language-javascript">// Example 2.
// disable translucency by distance
p.translucencyByDistance = undefined;</code></pre>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="computeScreenSpacePosition">
<a href="#computeScreenSpacePosition" class="doc-link"></a>
computeScreenSpacePosition<span class="signature">(scene, <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/CesiumGS/cesium/blob/1.91/Source/Scene/PointPrimitive.js#L567">Scene/PointPrimitive.js 567</a>
</div>
</h4>
</div>
<div class="description">
Computes the screen-space position of the point's origin.
The screen space origin is the top, left corner of the canvas; <code>x</code> increases from
left to right, and <code>y</code> increases from top to bottom.
</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.</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 screen-space position of the point.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: PointPrimitive must be in a collection.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">console.log(p.computeScreenSpacePosition(scene).toString());</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="equals">
<a href="#equals" class="doc-link"></a>
equals<span class="signature">(other)</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/Scene/PointPrimitive.js#L638">Scene/PointPrimitive.js 638</a>
</div>
</h4>
</div>
<div class="description">
Determines if this point equals another point. Points are equal if all their properties
are equal. Points in different collections can be equal.
</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>other</code></td>
<td class="type">
<span class="param-type"><a href="PointPrimitive.html">PointPrimitive</a></span>
</td>
<td class="description last">
The point to compare for equality.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the points are equal; otherwise, <code>false</code>.
</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>