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

1262 lines
63 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>DebugAppearance - 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>
DebugAppearance
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="DebugAppearance">
<a href="#DebugAppearance" class="doc-link"></a>
new Cesium.DebugAppearance<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L35">Scene/DebugAppearance.js 35</a>
</div>
</h4>
</div>
<div class="description">
Visualizes a vertex attribute by displaying it as a color for debugging.
<p>
Components for well-known unit-length vectors, i.e., <code>normal</code>,
<code>tangent</code>, and <code>bitangent</code>, are scaled and biased
from [-1.0, 1.0] to (-1.0, 1.0).
</p>
</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">
Object with the following properties:
<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>attributeName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
The name of the attribute to visualize.</td>
</tr>
<tr>
<td class="name"><code>perInstanceAttribute</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">false</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Boolean that determines whether this attribute is a per-instance geometry attribute.</td>
</tr>
<tr>
<td class="name"><code>glslDatatype</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
<code class="language-javascript">'vec3'</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The GLSL datatype of the attribute. Supported datatypes are <code>float</code>, <code>vec2</code>, <code>vec3</code>, and <code>vec4</code>.</td>
</tr>
<tr>
<td class="name"><code>vertexShaderSource</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Optional GLSL vertex shader source to override the default vertex shader.</td>
</tr>
<tr>
<td class="name"><code>fragmentShaderSource</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Optional GLSL fragment shader source to override the default fragment shader.</td>
</tr>
<tr>
<td class="name"><code>renderState</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Optional render state to override the default render state.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: options.glslDatatype must be float, vec2, vec3, or vec4.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const primitive = new Cesium.Primitive({
geometryInstances : // ...
appearance : new Cesium.DebugAppearance({
attributeName : 'normal'
})
});</code></pre>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="attributeName">
<a href="#attributeName" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> attributeName<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L217">Scene/DebugAppearance.js 217</a>
</div>
</h4>
</div>
<div class="description">
The name of the attribute being visualized.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="closed">
<a href="#closed" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> closed<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L203">Scene/DebugAppearance.js 203</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, the geometry is expected to be closed.
</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="fragmentShaderSource">
<a href="#fragmentShaderSource" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> fragmentShaderSource<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L173">Scene/DebugAppearance.js 173</a>
</div>
</h4>
</div>
<div class="description">
The GLSL source code for the fragment shader. The full fragment shader
source is built procedurally taking into account the <a href="DebugAppearance.html#material"><code>DebugAppearance#material</code></a>.
Use <a href="DebugAppearance.html#getFragmentShaderSource"><code>DebugAppearance#getFragmentShaderSource</code></a> to get the full source.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="glslDatatype">
<a href="#glslDatatype" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> glslDatatype<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L231">Scene/DebugAppearance.js 231</a>
</div>
</h4>
</div>
<div class="description">
The GLSL datatype of the attribute being visualized.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="material">
<a href="#material" class="doc-link"></a>
material<span class="type-signature"> : <a href="Material.html">Material</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L122">Scene/DebugAppearance.js 122</a>
</div>
</h4>
</div>
<div class="description">
This property is part of the <a href="Appearance.html"><code>Appearance</code></a> interface, but is not
used by <a href="DebugAppearance.html"><code>DebugAppearance</code></a> since a fully custom fragment shader is used.
</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="renderState">
<a href="#renderState" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> renderState<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L187">Scene/DebugAppearance.js 187</a>
</div>
</h4>
</div>
<div class="description">
The WebGL fixed-function state to use when rendering the geometry.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="translucent">
<a href="#translucent" class="doc-link"></a>
translucent<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L131">Scene/DebugAppearance.js 131</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, the geometry is expected to appear translucent.
</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="vertexShaderSource">
<a href="#vertexShaderSource" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> vertexShaderSource<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L157">Scene/DebugAppearance.js 157</a>
</div>
</h4>
</div>
<div class="description">
The GLSL source code for the vertex shader.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="getFragmentShaderSource">
<a href="#getFragmentShaderSource" class="doc-link"></a>
getFragmentShaderSource<span class="signature">()</span> &rarr; <span class="type-signature returnType">String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L246">Scene/DebugAppearance.js 246</a>
</div>
</h4>
</div>
<div class="description">
Returns the full GLSL fragment shader source, which for <a href="DebugAppearance.html"><code>DebugAppearance</code></a> is just
<a href="DebugAppearance.html#fragmentShaderSource"><code>DebugAppearance#fragmentShaderSource</code></a>.
</div>
<h5>Returns:</h5>
<div class="param-desc">
The full GLSL fragment shader source.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getRenderState">
<a href="#getRenderState" class="doc-link"></a>
getRenderState<span class="signature">()</span> &rarr; <span class="type-signature returnType">Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/DebugAppearance.js#L267">Scene/DebugAppearance.js 267</a>
</div>
</h4>
</div>
<div class="description">
Creates a render state. This is not the final render state instance; instead,
it can contain a subset of render state properties identical to the render state
created in the context.
</div>
<h5>Returns:</h5>
<div class="param-desc">
The render state.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isTranslucent">
<a href="#isTranslucent" class="doc-link"></a>
isTranslucent<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/Scene/DebugAppearance.js#L256">Scene/DebugAppearance.js 256</a>
</div>
</h4>
</div>
<div class="description">
Determines if the geometry is translucent based on <a href="DebugAppearance.html#translucent"><code>DebugAppearance#translucent</code></a>.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the appearance is translucent.
</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>