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

3030 lines
99 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>ModelExperimental - 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>
ModelExperimental
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ModelExperimental">
<a href="#ModelExperimental" class="doc-link"></a>
new Cesium.ModelExperimental<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L55">Scene/ModelExperimental/ModelExperimental.js 55</a>
</div>
</h4>
</div>
<div class="description">
A 3D model. This is a new architecture that is more decoupled than the older <a href="Model.html"><code>Model</code></a>. This class is still experimental.
<p>
Do not call this function directly, instead use the `from` functions to create
the Model from your source data type.
</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>resource</code></td>
<td class="type">
<span class="param-type"><a href="Resource.html">Resource</a></span>
</td>
<td class="default">
</td>
<td class="description last">
The Resource to the 3D model.</td>
</tr>
<tr>
<td class="name"><code>modelMatrix</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="default">
<code class="language-javascript">Matrix4.IDENTITY</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The 4x4 transformation matrix that transforms the model from model to world coordinates.</td>
</tr>
<tr>
<td class="name"><code>debugShowBoundingVolume</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>
For debugging only. Draws the bounding sphere for each draw command in the model.</td>
</tr>
<tr>
<td class="name"><code>cull</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used.</td>
</tr>
<tr>
<td class="name"><code>opaquePass</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">Pass.OPAQUE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The pass to use in the <a href="DrawCommand.html"><code>DrawCommand</code></a> for the opaque portions of the model.</td>
</tr>
<tr>
<td class="name"><code>allowPicking</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
When <code>true</code>, each primitive is pickable with <a href="Scene.html#pick"><code>Scene#pick</code></a>.</td>
</tr>
<tr>
<td class="name"><code>customShader</code></td>
<td class="type">
<span class="param-type"><a href="CustomShader.html">CustomShader</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a <a href="Cesium3DTileStyle.html"><code>Cesium3DTileStyle</code></a> may lead to undefined behavior.</td>
</tr>
<tr>
<td class="name"><code>content</code></td>
<td class="type">
<span class="param-type"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The tile content this model belongs to. This property will be undefined if model is not loaded as part of a tileset.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether or not to render the model.</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A color that blends with the model's rendered color.</td>
</tr>
<tr>
<td class="name"><code>colorBlendMode</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ColorBlendMode">ColorBlendMode</a></span>
</td>
<td class="default">
<code class="language-javascript">ColorBlendMode.HIGHLIGHT</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Defines how the color blends with the model.</td>
</tr>
<tr>
<td class="name"><code>colorBlendAmount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.5</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Value used to determine the color strength when the <code>colorBlendMode</code> is <code>MIX</code>. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two.</td>
</tr>
<tr>
<td class="name"><code>featureIdIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The index into the list of primitive feature IDs used for picking and styling. For EXT_feature_metadata, feature ID attributes are listed before feature ID textures. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.</td>
</tr>
<tr>
<td class="name"><code>instanceFeatureIdIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The index into the list of instance feature IDs used for picking and styling. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.</td>
</tr>
<tr>
<td class="name"><code>pointCloudShading</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>
Options for constructing a <a href="PointCloudShading.html"><code>PointCloudShading</code></a> object to control point attenuation based on geometric error and lighting.</td>
</tr>
<tr>
<td class="name"><code>backFaceCulling</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent.</td>
</tr>
<tr>
<td class="name"><code>shadows</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ShadowMode">ShadowMode</a></span>
</td>
<td class="default">
<code class="language-javascript">ShadowMode.ENABLED</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Determines whether the model casts or receives shadows from light sources.</td>
</tr>
<tr>
<td class="name"><code>showCreditsOnScreen</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>
Whether to display the credits of this model on screen.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<div class="tag-experimental">
<h5>Experimental</h5>
<p>This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.</p>
</div>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="boundingSphere">
<a href="#boundingSphere" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> boundingSphere<span class="type-signature"> : <a href="BoundingSphere.html">BoundingSphere</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L535">Scene/ModelExperimental/ModelExperimental.js 535</a>
</div>
</h4>
</div>
<div class="description">
Gets the model's bounding sphere.
</div>
<dl class="details">
</dl>
<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/ModelExperimental/ModelExperimental.js#L481">Scene/ModelExperimental/ModelExperimental.js 481</a>
</div>
</h4>
</div>
<div class="description">
The color to blend with the model's rendered color.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="colorBlendAmount">
<a href="#colorBlendAmount" class="doc-link"></a>
colorBlendAmount<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L518">Scene/ModelExperimental/ModelExperimental.js 518</a>
</div>
</h4>
</div>
<div class="description">
Value used to determine the color strength when the <code>colorBlendMode</code> is <code>MIX</code>. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.5</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="colorBlendMode">
<a href="#colorBlendMode" class="doc-link"></a>
colorBlendMode<span class="type-signature"> : <a href="global.html#Cesium3DTileColorBlendMode">Cesium3DTileColorBlendMode</a>|<a href="global.html#ColorBlendMode">ColorBlendMode</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L501">Scene/ModelExperimental/ModelExperimental.js 501</a>
</div>
</h4>
</div>
<div class="description">
Defines how the color blends with the model.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">ColorBlendMode.HIGHLIGHT</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="customShader">
<a href="#customShader" class="doc-link"></a>
customShader<span class="type-signature"> : <a href="CustomShader.html">CustomShader</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L364">Scene/ModelExperimental/ModelExperimental.js 364</a>
</div>
</h4>
</div>
<div class="description">
The model's custom shader, if it exists. Using custom shaders with a <a href="Cesium3DTileStyle.html"><code>Cesium3DTileStyle</code></a>
may lead to undefined behavior.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="debugShowBoundingVolume">
<a href="#debugShowBoundingVolume" class="doc-link"></a>
debugShowBoundingVolume<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L561">Scene/ModelExperimental/ModelExperimental.js 561</a>
</div>
</h4>
</div>
<div class="description">
This property is for debugging only; it is not for production use nor is it optimized.
<p>
Draws the bounding sphere for each draw command in the model.
</p>
</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="featureIdIndex">
<a href="#featureIdIndex" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> featureIdIndex<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L604">Scene/ModelExperimental/ModelExperimental.js 604</a>
</div>
</h4>
</div>
<div class="description">
The index into the list of primitive feature IDs used for picking and
styling. For EXT_feature_metadata, feature ID attributes are listed before
feature ID textures. If both per-primitive and per-instance feature IDs are
present, the instance feature IDs take priority.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="instanceFeatureIdIndex">
<a href="#instanceFeatureIdIndex" class="doc-link"></a>
instanceFeatureIdIndex<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L628">Scene/ModelExperimental/ModelExperimental.js 628</a>
</div>
</h4>
</div>
<div class="description">
The index into the list of instance feature IDs used for picking and
styling. If both per-primitive and per-instance feature IDs are present,
the instance feature IDs take priority.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="pointCloudShading">
<a href="#pointCloudShading" class="doc-link"></a>
pointCloudShading<span class="type-signature"> : <a href="PointCloudShading.html">PointCloudShading</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L341">Scene/ModelExperimental/ModelExperimental.js 341</a>
</div>
</h4>
</div>
<div class="description">
Point cloud shading settings for controlling point cloud attenuation
and lighting. For 3D Tiles, this is inherited from the
<a href="Cesium3DTileset.html"><code>Cesium3DTileset</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="ready">
<a href="#ready" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> ready<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L270">Scene/ModelExperimental/ModelExperimental.js 270</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, this model is ready to render, i.e., the external binary, image,
and shader files were downloaded and the WebGL resources were created. This is set to
<code>true</code> right before <a href="ModelExperimental.html#readyPromise"><code>ModelExperimental#readyPromise</code></a> is resolved.
</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="readyPromise">
<a href="#readyPromise" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> readyPromise<span class="type-signature"> : Promise.&lt;<a href="ModelExperimental.html">ModelExperimental</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L288">Scene/ModelExperimental/ModelExperimental.js 288</a>
</div>
</h4>
</div>
<div class="description">
Gets the promise that will be resolved when this model is ready to render, i.e. when the external resources
have been downloaded and the WebGL resources are created.
<p>
This promise is resolved at the end of the frame before the first frame the model is rendered in.
</p>
</div>
<dl class="details">
</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/ModelExperimental/ModelExperimental.js#L582">Scene/ModelExperimental/ModelExperimental.js 582</a>
</div>
</h4>
</div>
<div class="description">
Whether or not to render the model.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="showCreditsOnScreen">
<a href="#showCreditsOnScreen" class="doc-link"></a>
showCreditsOnScreen<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L691">Scene/ModelExperimental/ModelExperimental.js 691</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether the credits of the model will be displayed on the screen
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".fromGltf">
<a href="#.fromGltf" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ModelExperimental.fromGltf<span class="signature">(options)</span> &rarr; <span class="type-signature returnType"><a href="ModelExperimental.html">ModelExperimental</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L936">Scene/ModelExperimental/ModelExperimental.js 936</a>
</div>
</h4>
</div>
<div class="description">
<p>
Creates a model from a glTF asset. When the model is ready to render, i.e., when the external binary, image,
and shader files are downloaded and the WebGL resources are created, the <a href="Model.html#readyPromise"><code>Model#readyPromise</code></a> is resolved.
</p>
<p>
The model can be a traditional glTF asset with a .gltf extension or a Binary glTF using the .glb extension.
</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>gltf</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
<span class="param-type">Uint8Array</span>
|
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last">
A Resource/URL to a glTF/glb file, a binary glTF buffer, or a JSON object containing the glTF contents</td>
</tr>
<tr>
<td class="name"><code>basePath</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
</td>
<td class="default">
<code class="language-javascript">''</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The base path that paths in the glTF JSON are relative to.</td>
</tr>
<tr>
<td class="name"><code>modelMatrix</code></td>
<td class="type">
<span class="param-type"><a href="Matrix4.html">Matrix4</a></span>
</td>
<td class="default">
<code class="language-javascript">Matrix4.IDENTITY</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The 4x4 transformation matrix that transforms the model from model to world coordinates.</td>
</tr>
<tr>
<td class="name"><code>incrementallyLoadTextures</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Determine if textures may continue to stream in after the model is loaded.</td>
</tr>
<tr>
<td class="name"><code>releaseGltfJson</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>
When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective.</td>
</tr>
<tr>
<td class="name"><code>debugShowBoundingVolume</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>
For debugging only. Draws the bounding sphere for each draw command in the model.</td>
</tr>
<tr>
<td class="name"><code>cull</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used.</td>
</tr>
<tr>
<td class="name"><code>opaquePass</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">Pass.OPAQUE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The pass to use in the <a href="DrawCommand.html"><code>DrawCommand</code></a> for the opaque portions of the model.</td>
</tr>
<tr>
<td class="name"><code>upAxis</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Axis">Axis</a></span>
</td>
<td class="default">
<code class="language-javascript">Axis.Y</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The up-axis of the glTF model.</td>
</tr>
<tr>
<td class="name"><code>forwardAxis</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Axis">Axis</a></span>
</td>
<td class="default">
<code class="language-javascript">Axis.Z</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The forward-axis of the glTF model.</td>
</tr>
<tr>
<td class="name"><code>allowPicking</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
When <code>true</code>, each primitive is pickable with <a href="Scene.html#pick"><code>Scene#pick</code></a>.</td>
</tr>
<tr>
<td class="name"><code>customShader</code></td>
<td class="type">
<span class="param-type"><a href="CustomShader.html">CustomShader</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a <a href="Cesium3DTileStyle.html"><code>Cesium3DTileStyle</code></a> may lead to undefined behavior.</td>
</tr>
<tr>
<td class="name"><code>content</code></td>
<td class="type">
<span class="param-type"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The tile content this model belongs to. This property will be undefined if model is not loaded as part of a tileset.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether or not to render the model.</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A color that blends with the model's rendered color.</td>
</tr>
<tr>
<td class="name"><code>colorBlendMode</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ColorBlendMode">ColorBlendMode</a></span>
</td>
<td class="default">
<code class="language-javascript">ColorBlendMode.HIGHLIGHT</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Defines how the color blends with the model.</td>
</tr>
<tr>
<td class="name"><code>colorBlendAmount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.5</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Value used to determine the color strength when the <code>colorBlendMode</code> is <code>MIX</code>. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two.</td>
</tr>
<tr>
<td class="name"><code>featureIdIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The index into the list of primitive feature IDs used for picking and styling. For EXT_feature_metadata, feature ID attributes are listed before feature ID textures. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.</td>
</tr>
<tr>
<td class="name"><code>instanceFeatureIdIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The index into the list of instance feature IDs used for picking and styling. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.</td>
</tr>
<tr>
<td class="name"><code>pointCloudShading</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>
Options for constructing a <a href="PointCloudShading.html"><code>PointCloudShading</code></a> object to control point attenuation and lighting.</td>
</tr>
<tr>
<td class="name"><code>backFaceCulling</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent.</td>
</tr>
<tr>
<td class="name"><code>shadows</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ShadowMode">ShadowMode</a></span>
</td>
<td class="default">
<code class="language-javascript">ShadowMode.ENABLED</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Determines whether the model casts or receives shadows from light sources.</td>
</tr>
<tr>
<td class="name"><code>showCreditsOnScreen</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>
Whether to display the credits of this model on screen.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The newly created model.
</div>
<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/Scene/ModelExperimental/ModelExperimental.js#L872">Scene/ModelExperimental/ModelExperimental.js 872</a>
</div>
</h4>
</div>
<div class="description">
Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
release of WebGL resources, instead of relying on the garbage collector to destroy 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">model = model &amp;&amp; model.destroy();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="ModelExperimental.html#isDestroyed">ModelExperimental#isDestroyed</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/Scene/ModelExperimental/ModelExperimental.js#L852">Scene/ModelExperimental/ModelExperimental.js 852</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="ModelExperimental.html#destroy">ModelExperimental#destroy</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="update">
<a href="#update" class="doc-link"></a>
update<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelExperimental/ModelExperimental.js#L724">Scene/ModelExperimental/ModelExperimental.js 724</a>
</div>
</h4>
</div>
<div class="description">
Called when <a href="Viewer.html"><code>Viewer</code></a> or <a href="CesiumWidget.html"><code>CesiumWidget</code></a> render the scene to
get the draw commands needed to render this primitive.
<p>
Do not call this function directly. This is documented just to
list the exceptions that may be propagated when the scene is rendered:
</p>
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
: Failed to load external reference.
</div>
</li>
</ul>
<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>