cesium-examples/map/3d/static/Cesium/Build/Documentation/DistanceDisplayConditionGeo...

896 lines
57 KiB
HTML
Raw Permalink Normal View History

<!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>DistanceDisplayConditionGeometryInstanceAttribute - 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>
DistanceDisplayConditionGeometryInstanceAttribute
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="DistanceDisplayConditionGeometryInstanceAttribute">
<a href="#DistanceDisplayConditionGeometryInstanceAttribute" class="doc-link"></a>
new Cesium.DistanceDisplayConditionGeometryInstanceAttribute<span class="signature">(<span class="optional">near</span>, <span class="optional">far</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js#L44">Core/DistanceDisplayConditionGeometryInstanceAttribute.js 44</a>
</div>
</h4>
</div>
<div class="description">
Value and type information for per-instance geometry attribute that determines if the geometry instance has a distance display condition.
</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>near</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The near distance.</td>
</tr>
<tr>
<td class="name"><code>far</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">Number.MAX_VALUE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The far distance.</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: far must be greater than near.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">var instance = new Cesium.GeometryInstance({ geometry : new Cesium.BoxGeometry({ vertexFormat : Cesium.VertexFormat.POSITION_AND_NORMAL, minimum : new Cesium.Cartesian3(-250000.0, -250000.0, -250000.0), maximum : new Cesium.Cartesian3(250000.0, 250000.0, 250000.0) }), modelMatrix : Cesium.Matrix4.multiplyByTranslation(Cesium.Transforms.eastNorthUpToFixedFrame( Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883)), new Cesium.Cartesian3(0.0, 0.0, 1000000.0), new Cesium.Matrix4()), id : 'box', attributes : { distanceDisplayCondition : new Cesium.DistanceDisplayConditionGeometryInstanceAttribute(100.0, 10000.0) } });</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="GeometryInstance.html">GeometryInstance</a></li>
<li><a href="GeometryInstanceAttribute.html">GeometryInstanceAttribute</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="componentDatatype">
<a href="#componentDatatype" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>componentDatatype<span class="type-signature"> : <a href="ComponentDatatype.html">ComponentDatatype</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js#L76">Core/DistanceDisplayConditionGeometryInstanceAttribute.js 76</a>
</div>
</h4>
</div>
<div class="description">
The datatype of each component in the attribute, e.g., individual elements in <a href="DistanceDisplayConditionGeometryInstanceAttribute.html#value"><code>DistanceDisplayConditionGeometryInstanceAttribute#value</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="ComponentDatatype.html#.FLOAT"><code>ComponentDatatype.FLOAT</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="componentsPerAttribute">
<a href="#componentsPerAttribute" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>componentsPerAttribute<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js#L92">Core/DistanceDisplayConditionGeometryInstanceAttribute.js 92</a>
</div>
</h4>
</div>
<div class="description">
The number of components in the attributes, i.e., <a href="DistanceDisplayConditionGeometryInstanceAttribute.html#value"><code>DistanceDisplayConditionGeometryInstanceAttribute#value</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">3</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="normalize">
<a href="#normalize" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>normalize<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js#L110">Core/DistanceDisplayConditionGeometryInstanceAttribute.js 110</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code> and <code>componentDatatype</code> is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="value">
<a href="#value" class="doc-link"></a>
value<span class="type-signature"> : Float32Array</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js#L61">Core/DistanceDisplayConditionGeometryInstanceAttribute.js 61</a>
</div>
</h4>
</div>
<div class="description">
The values for the attributes stored in a typed array.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[0.0, 0.0, Number.MAX_VALUE]</code>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".fromDistanceDisplayCondition">
<a href="#.fromDistanceDisplayCondition" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.DistanceDisplayConditionGeometryInstanceAttribute.fromDistanceDisplayCondition<span class="signature">(distanceDisplayCondition)</span> &rarr; <span class="type-signature returnType"><a href="DistanceDisplayConditionGeometryInstanceAttribute.html">DistanceDisplayConditionGeometryInstanceAttribute</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js#L134">Core/DistanceDisplayConditionGeometryInstanceAttribute.js 134</a>
</div>
</h4>
</div>
<div class="description">
Creates a new <a href="DistanceDisplayConditionGeometryInstanceAttribute.html"><code>DistanceDisplayConditionGeometryInstanceAttribute</code></a> instance given the provided an enabled flag and <a href="DistanceDisplayCondition.html"><code>DistanceDisplayCondition</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>distanceDisplayCondition</code></td>
<td class="type">
<span class="param-type"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></span>
</td>
<td class="description last">
The distance display condition.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The new <a href="DistanceDisplayConditionGeometryInstanceAttribute.html"><code>DistanceDisplayConditionGeometryInstanceAttribute</code></a> instance.
</div>
<h5>Throws:</h5>
<ul>
<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>Example:</h5>
<pre><code class="language-javascript">var distanceDisplayCondition = new Cesium.DistanceDisplayCondition(100.0, 10000.0); var instance = new Cesium.GeometryInstance({ geometry : geometry, attributes : { distanceDisplayCondition : Cesium.DistanceDisplayConditionGeometryInstanceAttribute.fromDistanceDisplayCondition(distanceDisplayCondition) } });</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".toValue">
<a href="#.toValue" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue<span class="signature">(distanceDisplayCondition, <span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType">Float32Array</span>
<div class="source-link rightLinks">
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js#L158">Core/DistanceDisplayConditionGeometryInstanceAttribute.js 158</a>
</div>
</h4>
</div>
<div class="description">
Converts a distance display condition to a typed array that can be used to assign a distance display condition attribute.
</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>distanceDisplayCondition</code></td>
<td class="type">
<span class="param-type"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></span>
</td>
<td class="description last">
The distance display condition value.</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">Float32Array</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The array to store the result in, if undefined a new instance will be created.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if result was undefined.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">var attributes = primitive.getGeometryInstanceAttributes('an id'); attributes.distanceDisplayCondition = Cesium.DistanceDisplayConditionGeometryInstanceAttribute.toValue(distanceDisplayCondition, attributes.distanceDisplayCondition);</code></pre>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</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="ArcType"><a href="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</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="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-name="Cesium3DTileFeature"><a href="Cesium3DTileFeature.html">Cesium3DTileFeature</a></li><li data-name="Cesium3DTilePointFeature"><a href="Cesium3
</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>