6381 lines
152 KiB
HTML
6381 lines
152 KiB
HTML
|
<!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>Model - 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>
|
||
|
Model
|
||
|
<div class="titleCenterer"></div>
|
||
|
</h1>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<section>
|
||
|
|
||
|
<header>
|
||
|
|
||
|
</header>
|
||
|
|
||
|
<article>
|
||
|
<div class="container-overview">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="Model">
|
||
|
<a href="#Model" class="doc-link"></a>
|
||
|
new Cesium.Model<span class="signature">(<span class="optional">options</span>)</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L237">Scene/Model.js 237</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
A 3D model based on glTF, the runtime asset format for WebGL, OpenGL ES, and OpenGL.
|
||
|
<p>
|
||
|
Cesium includes support for geometry and materials, glTF animations, and glTF skinning.
|
||
|
In addition, individual glTF nodes are pickable with <a href="Scene.html#pick"><code>Scene#pick</code></a> and animatable
|
||
|
with <a href="Model.html#getNode"><code>Model#getNode</code></a>. glTF cameras and lights are not currently supported.
|
||
|
</p>
|
||
|
<p>
|
||
|
An external glTF asset is created with <a href="Model.html#.fromGltf"><code>Model.fromGltf</code></a>. glTF JSON can also be
|
||
|
created at runtime and passed to this constructor function. In either case, the
|
||
|
<a href="Model.html#readyPromise"><code>Model#readyPromise</code></a> is resolved 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.
|
||
|
</p>
|
||
|
<p>
|
||
|
Cesium supports glTF assets with the following extensions:
|
||
|
<ul>
|
||
|
<li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Khronos/KHR_binary_glTF/README.md">KHR_binary_glTF (glTF 1.0)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Khronos/KHR_materials_common/README.md">KHR_materials_common (glTF 1.0)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Vendor/WEB3D_quantized_attributes/README.md">WEB3D_quantized_attributes (glTF 1.0)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/AGI_articulations/README.md">AGI_articulations</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/pull/1302">KHR_blend (draft)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_draco_mesh_compression/README.md">KHR_draco_mesh_compression</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness/README.md">KHR_materials_pbrSpecularGlossiness</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit/README.md">KHR_materials_unlit</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_techniques_webgl/README.md">KHR_techniques_webgl</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_transform/README.md">KHR_texture_transform</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_basisu">KHR_texture_basisu</a>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</p>
|
||
|
<p>
|
||
|
Note: for models with compressed textures using the KHR_texture_basisu extension, we recommend power of 2 textures in both dimensions
|
||
|
for maximum compatibility. This is because some samplers require power of 2 textures (<a href="https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Tutorial/Using_textures_in_WebGL">Using textures in WebGL</a>)
|
||
|
and KHR_texture_basisu requires multiple of 4 dimensions (<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_basisu/README.md#additional-requirements">KHR_texture_basisu additional requirements</a>).
|
||
|
</p>
|
||
|
<p>
|
||
|
For high-precision rendering, Cesium supports the <a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Vendor/CESIUM_RTC/README.md">CESIUM_RTC</a> extension, which introduces the
|
||
|
CESIUM_RTC_MODELVIEW parameter semantic that says the node is in WGS84 coordinates translated
|
||
|
relative to a local origin.
|
||
|
</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">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
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">Object</span>
|
||
|
|
|
||
|
|
||
|
<span class="param-type">ArrayBuffer</span>
|
||
|
|
|
||
|
|
||
|
<span class="param-type">Uint8Array</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A glTF JSON object, or a binary glTF buffer.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>basePath</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
||
|
|
|
||
|
|
||
|
<span class="param-type">String</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>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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if the model primitive will be shown.</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>scale</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">1.0</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A uniform scale applied to this model.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>minimumPixelSize</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 approximate minimum pixel size of the model regardless of zoom.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>maximumScale</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The maximum scale size of a model. An upper limit for minimumPixelSize.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>id</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A user-defined object to return when the model is picked with <a href="Scene.html#pick"><code>Scene#pick</code></a>.</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 glTF mesh and primitive is pickable with <a href="Scene.html#pick"><code>Scene#pick</code></a>.</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>asynchronous</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if model WebGL resource creation will be spread out over several frames or block until completion once all glTF files are loaded.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>clampAnimations</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if the model's animations should hold a pose over frames where no keyframes are specified.</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>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>debugWireframe</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 model in wireframe.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>heightReference</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="global.html#HeightReference">HeightReference</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">HeightReference.NONE</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines how the model is drawn relative to terrain.</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="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Must be passed in for models that use the height reference property.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<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="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The condition specifying at what distance from the camera that this model will be displayed.</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">
|
||
|
|
||
|
<code class="language-javascript">Color.WHITE</code>
|
||
|
|
||
|
</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>silhouetteColor</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Color.html">Color</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">Color.RED</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The silhouette color. If more than 256 models have silhouettes enabled, there is a small chance that overlapping models will have minor artifacts.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>silhouetteSize</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 size of the silhouette in pixels.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>clippingPlanes</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="ClippingPlaneCollection.html">ClippingPlaneCollection</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The <a href="ClippingPlaneCollection.html"><code>ClippingPlaneCollection</code></a> used to selectively disable rendering the model.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>dequantizeInShader</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if a <a href="https://github.com/google/draco">Draco</a> encoded model is dequantized on the GPU. This decreases total memory usage for encoded models.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>imageBasedLightingFactor</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">Cartesian2(1.0, 1.0)</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Scales diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>lightColor</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Cartesian3.html">Cartesian3</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The light color when shading the model. When <code>undefined</code> the scene's light color is used instead.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>luminanceAtZenith</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">0.2</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>sphericalHarmonicCoefficients</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Array.<<a href="Cartesian3.html">Cartesian3</a>></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>specularEnvironmentMaps</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>credit</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Credit.html">Credit</a></span>
|
||
|
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A credit for the data source, which is displayed on the canvas.</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>
|
||
|
|
||
|
|
||
|
|
||
|
<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 <a href="Model.html#color"><code>Model#color</code></a> is translucent or <a href="Model.html#silhouetteSize"><code>Model#silhouetteSize</code></a> is greater than 0.0.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>showOutline</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 display the outline for models using the <a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline">CESIUM_primitive_outline</a> extension. When true, outlines are displayed. When false, outlines are not displayed.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Demo:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="https://sandcastle.cesium.com/index.html?src=3D%2520Models.html">Cesium Sandcastle Models Demo</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="Model.html#.fromGltf">Model.fromGltf</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h3 class="subsection-title">Members</h3>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="activeAnimations">
|
||
|
<a href="#activeAnimations" class="doc-link"></a>
|
||
|
activeAnimations<span class="type-signature"> : <a href="ModelAnimationCollection.html">ModelAnimationCollection</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L444">Scene/Model.js 444</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The currently playing glTF animations.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="allowPicking">
|
||
|
<a href="#allowPicking" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> allowPicking<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L916">Scene/Model.js 916</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
When <code>true</code>, each glTF mesh and primitive is pickable with <a href="Scene.html#pick"><code>Scene#pick</code></a>. When <code>false</code>, GPU memory is saved.
|
||
|
</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="asynchronous">
|
||
|
<a href="#asynchronous" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> asynchronous<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L900">Scene/Model.js 900</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines if model WebGL resource creation will be spread out over several frames or
|
||
|
block until completion once all glTF files are loaded.
|
||
|
</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="backFaceCulling">
|
||
|
<a href="#backFaceCulling" class="doc-link"></a>
|
||
|
backFaceCulling<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L526">Scene/Model.js 526</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
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 <a href="Model.html#color"><code>Model#color</code></a> is
|
||
|
translucent or <a href="Model.html#silhouetteSize"><code>Model#silhouetteSize</code></a> is greater than 0.0.
|
||
|
</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="basePath">
|
||
|
<a href="#basePath" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> basePath<span class="type-signature"> : String</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L771">Scene/Model.js 771</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The base path that paths in the glTF JSON are relative to. The base
|
||
|
path is the same path as the path containing the .gltf file
|
||
|
minus the .gltf file, when binary, image, and shader files are
|
||
|
in the same directory as the .gltf. When this is <code>''</code>,
|
||
|
the app's base path is used.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">''</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<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/Model.js#L794">Scene/Model.js 794</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The model's bounding sphere in its local coordinate system. This does not take into
|
||
|
account glTF animations and skins nor does it take into account <a href="Model.html#minimumPixelSize"><code>Model#minimumPixelSize</code></a>.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">undefined</code>
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Example:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">// Center in WGS84 coordinates
|
||
|
const center = Cesium.Matrix4.multiplyByPoint(model.modelMatrix, model.boundingSphere.center, new Cesium.Cartesian3());</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="clampAnimations">
|
||
|
<a href="#clampAnimations" class="doc-link"></a>
|
||
|
clampAnimations<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L451">Scene/Model.js 451</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines if the model's animations should hold a pose over frames where no keyframes are specified.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="clippingPlanes">
|
||
|
<a href="#clippingPlanes" class="doc-link"></a>
|
||
|
clippingPlanes<span class="type-signature"> : <a href="ClippingPlaneCollection.html">ClippingPlaneCollection</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1126">Scene/Model.js 1126</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The <a href="ClippingPlaneCollection.html"><code>ClippingPlaneCollection</code></a> used to selectively disable rendering the model.
|
||
|
</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/Model.js#L477">Scene/Model.js 477</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
A color that blends with the model's rendered color.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">Color.WHITE</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</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/Model.js#L501">Scene/Model.js 501</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#ColorBlendMode">ColorBlendMode</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L487">Scene/Model.js 487</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="credit">
|
||
|
<a href="#credit" class="doc-link"></a>
|
||
|
credit<span class="type-signature"> : <a href="Credit.html">Credit</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1323">Scene/Model.js 1323</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Gets the credit that will be displayed for the model
|
||
|
</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/Model.js#L551">Scene/Model.js 551</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. A glTF primitive corresponds
|
||
|
to one draw command. A glTF mesh has an array of primitives, often of length one.
|
||
|
</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="debugWireframe">
|
||
|
<a href="#debugWireframe" class="doc-link"></a>
|
||
|
debugWireframe<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L567">Scene/Model.js 567</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 model in wireframe.
|
||
|
</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="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/Model.js#L976">Scene/Model.js 976</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Gets or sets the condition specifying at what distance from the camera that this model 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="gltf">
|
||
|
<a href="#gltf" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> gltf<span class="type-signature"> : Object</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L707">Scene/Model.js 707</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The object for the glTF JSON, including properties with default values omitted
|
||
|
from the JSON provided to this model.
|
||
|
</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="heightReference">
|
||
|
<a href="#heightReference" class="doc-link"></a>
|
||
|
heightReference<span class="type-signature"> : <a href="global.html#HeightReference">HeightReference</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L410">Scene/Model.js 410</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Returns the height reference of the model
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">HeightReference.NONE</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="id">
|
||
|
<a href="#id" class="doc-link"></a>
|
||
|
id<span class="type-signature"> : Object</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L400">Scene/Model.js 400</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
User-defined object returned when the model is picked.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">undefined</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="Scene.html#pick">Scene#pick</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="imageBasedLightingFactor">
|
||
|
<a href="#imageBasedLightingFactor" class="doc-link"></a>
|
||
|
imageBasedLightingFactor<span class="type-signature"> : <a href="Cartesian2.html">Cartesian2</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1157">Scene/Model.js 1157</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Cesium adds lighting from the earth, sky, atmosphere, and star skybox. This cartesian is used to scale the final
|
||
|
diffuse and specular lighting contribution from those sources to the final color. A value of 0.0 will disable those light sources.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">Cartesian2(1.0, 1.0)</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="incrementallyLoadTextures">
|
||
|
<a href="#incrementallyLoadTextures" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> incrementallyLoadTextures<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L932">Scene/Model.js 932</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determine if textures may continue to stream in after the model is loaded.
|
||
|
</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="lightColor">
|
||
|
<a href="#lightColor" class="doc-link"></a>
|
||
|
lightColor<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/Model.js#L1216">Scene/Model.js 1216</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
|
||
|
<p>
|
||
|
For example, disabling additional light sources by setting <code>model.imageBasedLightingFactor = new Cesium.Cartesian2(0.0, 0.0)</code> will make the
|
||
|
model much darker. Here, increasing the intensity of the light source will make the model brighter.
|
||
|
</p>
|
||
|
</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="luminanceAtZenith">
|
||
|
<a href="#luminanceAtZenith" class="doc-link"></a>
|
||
|
luminanceAtZenith<span class="type-signature"> : Number</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1243">Scene/Model.js 1243</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
|
||
|
This is used when <a href="Model.html#specularEnvironmentMaps"><code>Model#specularEnvironmentMaps</code></a> and <a href="Model.html#sphericalHarmonicCoefficients"><code>Model#sphericalHarmonicCoefficients</code></a> are not defined.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">0.2</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Demo:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="https://sandcastle.cesium.com/index.html?src=Image-Based%20Lighting.html">Sandcastle Image Based Lighting Demo</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="maximumScale">
|
||
|
<a href="#maximumScale" class="doc-link"></a>
|
||
|
maximumScale<span class="type-signature"> : Number</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L388">Scene/Model.js 388</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The maximum scale size for a model. This can be used to give
|
||
|
an upper limit to the <a href="Model.html#minimumPixelSize"><code>Model#minimumPixelSize</code></a>, ensuring that the model
|
||
|
is never an unreasonable scale.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="minimumPixelSize">
|
||
|
<a href="#minimumPixelSize" class="doc-link"></a>
|
||
|
minimumPixelSize<span class="type-signature"> : Number</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L378">Scene/Model.js 378</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The approximate minimum pixel size of the model regardless of zoom.
|
||
|
This can be used to ensure that a model is visible even when the viewer
|
||
|
zooms out. When <code>0.0</code>, no minimum size is enforced.
|
||
|
</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="modelMatrix">
|
||
|
<a href="#modelMatrix" class="doc-link"></a>
|
||
|
modelMatrix<span class="type-signature"> : <a href="Matrix4.html">Matrix4</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L351">Scene/Model.js 351</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The 4x4 transformation matrix that transforms the model from model to world coordinates.
|
||
|
When this is the identity matrix, the model is drawn in world coordinates, i.e., Earth's WGS84 coordinates.
|
||
|
Local reference frames can be used by providing a different transformation matrix, like that returned
|
||
|
by <a href="Transforms.html#.eastNorthUpToFixedFrame"><code>Transforms.eastNorthUpToFixedFrame</code></a>.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript"><a href="Matrix4.html#.IDENTITY"><code>Matrix4.IDENTITY</code></a></code>
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Example:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">const origin = Cesium.Cartesian3.fromDegrees(-95.0, 40.0, 200000.0);
|
||
|
m.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(origin);</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="pendingTextureLoads">
|
||
|
<a href="#pendingTextureLoads" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> pendingTextureLoads<span class="type-signature"> : Number</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L946">Scene/Model.js 946</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Return the number of pending texture loads.
|
||
|
</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/Model.js#L854">Scene/Model.js 854</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="Model.html#readyPromise"><code>Model#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.<<a href="Model.html">Model</a>></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L883">Scene/Model.js 883</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 binary, image,
|
||
|
and shader files were downloaded and the WebGL resources were 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">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Example:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">// Play all animations at half-speed when the model is ready to render
|
||
|
Cesium.when(model.readyPromise).then(function(model) {
|
||
|
model.activeAnimations.addAll({
|
||
|
multiplier : 0.5
|
||
|
});
|
||
|
}).otherwise(function(error){
|
||
|
window.alert(error);
|
||
|
});</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="Model.html#ready">Model#ready</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="scale">
|
||
|
<a href="#scale" class="doc-link"></a>
|
||
|
scale<span class="type-signature"> : Number</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L366">Scene/Model.js 366</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
A uniform scale applied to this model before the <a href="Model.html#modelMatrix"><code>Model#modelMatrix</code></a>.
|
||
|
Values greater than <code>1.0</code> increase the size of the model; values
|
||
|
less than <code>1.0</code> decrease.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">1.0</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="shadows">
|
||
|
<a href="#shadows" class="doc-link"></a>
|
||
|
shadows<span class="type-signature"> : <a href="global.html#ShadowMode">ShadowMode</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L467">Scene/Model.js 467</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines whether the model casts or receives shadows from light sources.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">ShadowMode.ENABLED</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</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/Model.js#L314">Scene/Model.js 314</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines if the model primitive will be shown.
|
||
|
</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/Model.js#L1334">Scene/Model.js 1334</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">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="showOutline">
|
||
|
<a href="#showOutline" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-readonly">readonly</span> showOutline<span class="type-signature"> : Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L538">Scene/Model.js 538</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Whether to display the outline for models using the
|
||
|
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline">CESIUM_primitive_outline</a> extension.
|
||
|
When true, outlines are displayed. When false, outlines are not displayed.
|
||
|
</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="silhouetteColor">
|
||
|
<a href="#silhouetteColor" class="doc-link"></a>
|
||
|
silhouetteColor<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/Model.js#L323">Scene/Model.js 323</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The silhouette color.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<span class="details-header">Default Value:</span>
|
||
|
<code class="language-javascript">Color.RED</code>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="silhouetteSize">
|
||
|
<a href="#silhouetteSize" class="doc-link"></a>
|
||
|
silhouetteSize<span class="type-signature"> : Number</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L335">Scene/Model.js 335</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The size of the silhouette in pixels.
|
||
|
</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="specularEnvironmentMaps">
|
||
|
<a href="#specularEnvironmentMaps" class="doc-link"></a>
|
||
|
specularEnvironmentMaps<span class="type-signature"> : String</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1306">Scene/Model.js 1306</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Demo:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="https://sandcastle.cesium.com/index.html?src=Image-Based%20Lighting.html">Sandcastle Image Based Lighting Demo</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="Model.html#sphericalHarmonicCoefficients">Model#sphericalHarmonicCoefficients</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="sphericalHarmonicCoefficients">
|
||
|
<a href="#sphericalHarmonicCoefficients" class="doc-link"></a>
|
||
|
sphericalHarmonicCoefficients<span class="type-signature"> : Array.<<a href="Cartesian3.html">Cartesian3</a>></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1278">Scene/Model.js 1278</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. When <code>undefined</code>, a diffuse irradiance
|
||
|
computed from the atmosphere color is used.
|
||
|
<p>
|
||
|
There are nine <code>Cartesian3</code> coefficients.
|
||
|
The order of the coefficients is: L<sub>00</sub>, L<sub>1-1</sub>, L<sub>10</sub>, L<sub>11</sub>, L<sub>2-2</sub>, L<sub>2-1</sub>, L<sub>20</sub>, L<sub>21</sub>, L<sub>22</sub>
|
||
|
</p>
|
||
|
|
||
|
These values can be obtained by preprocessing the environment map using the <code>cmgen</code> tool of
|
||
|
<a href="https://github.com/google/filament/releases">Google's Filament project</a>. This will also generate a KTX file that can be
|
||
|
supplied to <a href="Model.html#specularEnvironmentMaps"><code>Model#specularEnvironmentMaps</code></a>.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Demo:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="https://sandcastle.cesium.com/index.html?src=Image-Based%20Lighting.html">Sandcastle Image Based Lighting Demo</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="https://graphics.stanford.edu/papers/envmap/envmap.pdf">An Efficient Representation for Irradiance Environment Maps</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</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.Model.fromGltf<span class="signature">(options)</span> → <span class="type-signature returnType"><a href="Model.html">Model</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1497">Scene/Model.js 1497</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.
|
||
|
</p>
|
||
|
<p>
|
||
|
Cesium supports glTF assets with the following extensions:
|
||
|
<ul>
|
||
|
<li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Khronos/KHR_binary_glTF/README.md">KHR_binary_glTF (glTF 1.0)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Khronos/KHR_materials_common/README.md">KHR_materials_common (glTF 1.0)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Vendor/WEB3D_quantized_attributes/README.md">WEB3D_quantized_attributes (glTF 1.0)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/AGI_articulations/README.md">AGI_articulations</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/pull/1302">KHR_blend (draft)</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_draco_mesh_compression/README.md">KHR_draco_mesh_compression</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness/README.md">KHR_materials_pbrSpecularGlossiness</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit/README.md">KHR_materials_unlit</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_techniques_webgl/README.md">KHR_techniques_webgl</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_transform/README.md">KHR_texture_transform</a>
|
||
|
</li><li>
|
||
|
<a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_basisu/README.md">KHR_texture_basisu</a>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</p>
|
||
|
<p>
|
||
|
For high-precision rendering, Cesium supports the <a href="https://github.com/KhronosGroup/glTF/blob/master/extensions/1.0/Vendor/CESIUM_RTC/README.md">CESIUM_RTC</a> extension, which introduces the
|
||
|
CESIUM_RTC_MODELVIEW parameter semantic that says the node is in WGS84 coordinates translated
|
||
|
relative to a local origin.
|
||
|
</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>url</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
||
|
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The url to the .gltf file.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>basePath</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
||
|
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</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>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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if the model primitive will be shown.</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>scale</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">1.0</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A uniform scale applied to this model.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>minimumPixelSize</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 approximate minimum pixel size of the model regardless of zoom.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>maximumScale</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The maximum scale for the model.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>id</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A user-defined object to return when the model is picked with <a href="Scene.html#pick"><code>Scene#pick</code></a>.</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 glTF mesh and primitive is pickable with <a href="Scene.html#pick"><code>Scene#pick</code></a>.</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>asynchronous</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if model WebGL resource creation will be spread out over several frames or block until completion once all glTF files are loaded.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>clampAnimations</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if the model's animations should hold a pose over frames where no keyframes are specified.</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>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>debugWireframe</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 model in wireframe.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>heightReference</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="global.html#HeightReference">HeightReference</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">HeightReference.NONE</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines how the model is drawn relative to terrain.</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="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Must be passed in for models that use the height reference property.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<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="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The condition specifying at what distance from the camera that this model will be displayed.</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">
|
||
|
|
||
|
<code class="language-javascript">Color.WHITE</code>
|
||
|
|
||
|
</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>silhouetteColor</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Color.html">Color</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
<code class="language-javascript">Color.RED</code>
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The silhouette color. If more than 256 models have silhouettes enabled, there is a small chance that overlapping models will have minor artifacts.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>silhouetteSize</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 size of the silhouette in pixels.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>clippingPlanes</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="ClippingPlaneCollection.html">ClippingPlaneCollection</a></span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
The <a href="ClippingPlaneCollection.html"><code>ClippingPlaneCollection</code></a> used to selectively disable rendering the model.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>dequantizeInShader</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>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Determines if a <a href="https://github.com/google/draco">Draco</a> encoded model is dequantized on the GPU. This decreases total memory usage for encoded models.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>credit</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type"><a href="Credit.html">Credit</a></span>
|
||
|
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="default">
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
|
||
|
<span class="optional">optional</span>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
A credit for the model, which is displayed on the canvas.</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>
|
||
|
|
||
|
|
||
|
|
||
|
<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 <a href="Model.html#color"><code>Model#color</code></a> is translucent or <a href="Model.html#silhouetteSize"><code>Model#silhouetteSize</code></a> is greater than 0.0.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>showOutline</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 display the outline for models using the <a href="https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline">CESIUM_primitive_outline</a> extension. When true, outlines are displayed. When false, outlines are not displayed.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
The newly created model.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Examples:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">// Example 1. Create a model from a glTF asset
|
||
|
const model = scene.primitives.add(Cesium.Model.fromGltf({
|
||
|
url : './duck/duck.gltf'
|
||
|
}));</code></pre>
|
||
|
|
||
|
<pre><code class="language-javascript">// Example 2. Create model and provide all properties and events
|
||
|
const origin = Cesium.Cartesian3.fromDegrees(-95.0, 40.0, 200000.0);
|
||
|
const modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(origin);
|
||
|
|
||
|
const model = scene.primitives.add(Cesium.Model.fromGltf({
|
||
|
url : './duck/duck.gltf',
|
||
|
show : true, // default
|
||
|
modelMatrix : modelMatrix,
|
||
|
scale : 2.0, // double size
|
||
|
minimumPixelSize : 128, // never smaller than 128 pixels
|
||
|
maximumScale: 20000, // never larger than 20000 * model size (overrides minimumPixelSize)
|
||
|
allowPicking : false, // not pickable
|
||
|
debugShowBoundingVolume : false, // default
|
||
|
debugWireframe : false
|
||
|
}));
|
||
|
|
||
|
model.readyPromise.then(function(model) {
|
||
|
// Play all animations when the model is ready to render
|
||
|
model.activeAnimations.addAll();
|
||
|
});</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id=".silhouetteSupported">
|
||
|
<a href="#.silhouetteSupported" class="doc-link"></a>
|
||
|
<span class="type-signature attribute-static">static</span> Cesium.Model.silhouetteSupported<span class="signature">(scene)</span> → <span class="type-signature returnType">Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1386">Scene/Model.js 1386</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Determines if silhouettes are supported.
|
||
|
</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>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
<code>true</code> if silhouettes are supported; otherwise, returns <code>false</code>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="applyArticulations">
|
||
|
<a href="#applyArticulations" class="doc-link"></a>
|
||
|
applyArticulations<span class="signature">()</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1784">Scene/Model.js 1784</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Applies any modified articulation stages to the matrix of each node that participates
|
||
|
in any articulation. Note that this will overwrite any nodeTransformations on participating nodes.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: The model is not loaded. Use Model.readyPromise or wait for Model.ready to be true.
|
||
|
</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/Scene/Model.js#L5931">Scene/Model.js 5931</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 && model.destroy();</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="Model.html#isDestroyed">Model#isDestroyed</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="getMaterial">
|
||
|
<a href="#getMaterial" class="doc-link"></a>
|
||
|
getMaterial<span class="signature">(name)</span> → <span class="type-signature returnType"><a href="ModelMaterial.html">ModelMaterial</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1648">Scene/Model.js 1648</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Returns the glTF material with the given <code>name</code> property.
|
||
|
</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>name</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
The glTF name of the material.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
The material or <code>undefined</code> if no material with <code>name</code> exists.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: The model is not loaded. Use Model.readyPromise or wait for Model.ready to be true.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="getMesh">
|
||
|
<a href="#getMesh" class="doc-link"></a>
|
||
|
getMesh<span class="signature">(name)</span> → <span class="type-signature returnType"><a href="ModelMesh.html">ModelMesh</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1636">Scene/Model.js 1636</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Returns the glTF mesh with the given <code>name</code> property.
|
||
|
</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>name</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
The glTF name of the mesh.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
The mesh or <code>undefined</code> if no mesh with <code>name</code> exists.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: The model is not loaded. Use Model.readyPromise or wait for Model.ready to be true.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="getNode">
|
||
|
<a href="#getNode" class="doc-link"></a>
|
||
|
getNode<span class="signature">(name)</span> → <span class="type-signature returnType"><a href="ModelNode.html">ModelNode</a></span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1622">Scene/Model.js 1622</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Returns the glTF node with the given <code>name</code> property. This is used to
|
||
|
modify a node's transform for animation outside of glTF animations.
|
||
|
</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>name</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
The glTF name of the node.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Returns:</h5>
|
||
|
|
||
|
|
||
|
<div class="param-desc">
|
||
|
The node or <code>undefined</code> if no node with <code>name</code> exists.
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: The model is not loaded. Use Model.readyPromise or wait for Model.ready to be true.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Example:</h5>
|
||
|
|
||
|
<pre><code class="language-javascript">// Apply non-uniform scale to node LOD3sp
|
||
|
const node = model.getNode('LOD3sp');
|
||
|
node.matrix = Cesium.Matrix4.fromScale(new Cesium.Cartesian3(5.0, 1.0, 1.0), node.matrix);</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="isDestroyed">
|
||
|
<a href="#isDestroyed" class="doc-link"></a>
|
||
|
isDestroyed<span class="signature">()</span> → <span class="type-signature returnType">Boolean</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L5911">Scene/Model.js 5911</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="Model.html#destroy">Model#destroy</a></li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
</dl>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="nameContainer">
|
||
|
<h4 class="name" id="setArticulationStage">
|
||
|
<a href="#setArticulationStage" class="doc-link"></a>
|
||
|
setArticulationStage<span class="signature">(articulationStageKey, value)</span>
|
||
|
|
||
|
|
||
|
<div class="source-link rightLinks">
|
||
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/Model.js#L1663">Scene/Model.js 1663</a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
</h4>
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="description">
|
||
|
Sets the current value of an articulation stage. After setting one or multiple stage values, call
|
||
|
Model.applyArticulations() to cause the node matrices to be recalculated.
|
||
|
</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>articulationStageKey</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">String</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
The name of the articulation, a space, and the name of the stage.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
|
||
|
<tr>
|
||
|
|
||
|
<td class="name"><code>value</code></td>
|
||
|
|
||
|
|
||
|
<td class="type">
|
||
|
|
||
|
|
||
|
<span class="param-type">Number</span>
|
||
|
|
||
|
|
||
|
|
||
|
</td>
|
||
|
|
||
|
|
||
|
|
||
|
<td class="description last">
|
||
|
|
||
|
The numeric value of this stage of the articulation.</td>
|
||
|
</tr>
|
||
|
|
||
|
|
||
|
</tbody>
|
||
|
</table>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>Throws:</h5>
|
||
|
<ul>
|
||
|
<li>
|
||
|
|
||
|
<div class="param-desc">
|
||
|
|
||
|
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
|
||
|
|
||
|
: The model is not loaded. Use Model.readyPromise or wait for Model.ready to be true.
|
||
|
</div>
|
||
|
|
||
|
</li>
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
<dl class="details">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h5>See:</h5>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="Model.html#applyArticulations">Model#applyArticulations</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/Model.js#L5237">Scene/Model.js 5237</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>
|