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

2819 lines
89 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>ModelGraphics - 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>
ModelGraphics
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ModelGraphics">
<a href="#ModelGraphics" class="doc-link"></a>
new Cesium.ModelGraphics<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/DataSources/ModelGraphics.js#L64">DataSources/ModelGraphics.js 64</a>
</div>
</h4>
</div>
<div class="description">
A 3D model based on <a href="https://github.com/KhronosGroup/glTF">glTF</a>, the runtime asset format for WebGL, OpenGL ES, and OpenGL.
The position and orientation of the model is determined by the containing <a href="Entity.html"><code>Entity</code></a>.
<p>
Cesium includes support for glTF geometry, materials, animations, and skinning.
Cameras and lights are not currently supported.
</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"><a href="ModelGraphics.html#.ConstructorOptions">ModelGraphics.ConstructorOptions</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object describing initialization options</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 3D Models Demo</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="articulations">
<a href="#articulations" class="doc-link"></a>
articulations<span class="type-signature"> : <a href="PropertyBag.html">PropertyBag</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L299">DataSources/ModelGraphics.js 299</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the set of articulation values to apply to this model. This is represented as an <a href="PropertyBag.html"><code>PropertyBag</code></a>, where keys are
composed as the name of the articulation, a single space, and the name of the stage.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clampAnimations">
<a href="#clampAnimations" class="doc-link"></a>
clampAnimations<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L194">DataSources/ModelGraphics.js 194</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying if glTF animations should hold the last pose for time durations with no keyframes.
</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="clippingPlanes">
<a href="#clippingPlanes" class="doc-link"></a>
clippingPlanes<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L310">DataSources/ModelGraphics.js 310</a>
</div>
</h4>
</div>
<div class="description">
A property specifying 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="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L235">DataSources/ModelGraphics.js 235</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="Color.html"><code>Color</code></a> 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"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L253">DataSources/ModelGraphics.js 253</a>
</div>
</h4>
</div>
<div class="description">
A numeric Property specifying the color strength when the <code>colorBlendMode</code> is MIX.
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="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L243">DataSources/ModelGraphics.js 243</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the enum Property specifying 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="definitionChanged">
<a href="#definitionChanged" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> definitionChanged<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L119">DataSources/ModelGraphics.js 119</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that is raised whenever a property or sub-property is changed or modified.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L276">DataSources/ModelGraphics.js 276</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the <a href="DistanceDisplayCondition.html"><code>DistanceDisplayCondition</code></a> Property specifying at what distance from the camera that this model will be displayed.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="heightReference">
<a href="#heightReference" class="doc-link"></a>
heightReference<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L211">DataSources/ModelGraphics.js 211</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="global.html#HeightReference"><code>HeightReference</code></a>.
</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="imageBasedLightingFactor">
<a href="#imageBasedLightingFactor" class="doc-link"></a>
imageBasedLightingFactor<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L260">DataSources/ModelGraphics.js 260</a>
</div>
</h4>
</div>
<div class="description">
A property specifying the <a href="Cartesian2.html"><code>Cartesian2</code></a> used to scale the diffuse and specular image-based lighting contribution to the final color.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="incrementallyLoadTextures">
<a href="#incrementallyLoadTextures" class="doc-link"></a>
incrementallyLoadTextures<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L176">DataSources/ModelGraphics.js 176</a>
</div>
</h4>
</div>
<div class="description">
Get or sets the boolean Property specifying whether textures
may continue to stream in after the model is loaded.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="lightColor">
<a href="#lightColor" class="doc-link"></a>
lightColor<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L269">DataSources/ModelGraphics.js 269</a>
</div>
</h4>
</div>
<div class="description">
A property specifying the <a href="Cartesian3.html"><code>Cartesian3</code></a> light color when shading the model. When <code>undefined</code> the scene's light color is used instead.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumScale">
<a href="#maximumScale" class="doc-link"></a>
maximumScale<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L168">DataSources/ModelGraphics.js 168</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying the maximum scale
size of a model. This property is used as an upper limit for
<a href="ModelGraphics.html#minimumPixelSize"><code>ModelGraphics#minimumPixelSize</code></a>.
</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"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L159">DataSources/ModelGraphics.js 159</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying 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="nodeTransformations">
<a href="#nodeTransformations" class="doc-link"></a>
nodeTransformations<span class="type-signature"> : <a href="PropertyBag.html">PropertyBag</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L287">DataSources/ModelGraphics.js 287</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the set of node transformations to apply to this model. This is represented as an <a href="PropertyBag.html"><code>PropertyBag</code></a>, where keys are
names of nodes, and values are <a href="TranslationRotationScale.html"><code>TranslationRotationScale</code></a> Properties describing the transformation to apply to that node.
The transformation is applied after the node's existing transformation as specified in the glTF, and does not replace the node's existing transformation.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="runAnimations">
<a href="#runAnimations" class="doc-link"></a>
runAnimations<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L186">DataSources/ModelGraphics.js 186</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying if glTF animations should be run.
</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="scale">
<a href="#scale" class="doc-link"></a>
scale<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L148">DataSources/ModelGraphics.js 148</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying a uniform linear scale
for this model. Values greater than 1.0 increase the size of the model while
values less than 1.0 decrease it.
</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="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L203">DataSources/ModelGraphics.js 203</a>
</div>
</h4>
</div>
<div class="description">
Get or sets the enum Property specifying 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"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L131">DataSources/ModelGraphics.js 131</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the boolean Property specifying the visibility of the model.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="silhouetteColor">
<a href="#silhouetteColor" class="doc-link"></a>
silhouetteColor<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L219">DataSources/ModelGraphics.js 219</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Property specifying the <a href="Color.html"><code>Color</code></a> of the silhouette.
</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"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L227">DataSources/ModelGraphics.js 227</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the numeric Property specifying 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="uri">
<a href="#uri" class="doc-link"></a>
uri<span class="type-signature"> : <a href="Property.html">Property</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L138">DataSources/ModelGraphics.js 138</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the string Property specifying the URI of the glTF asset.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="clone">
<a href="#clone" class="doc-link"></a>
clone<span class="signature">(<span class="optional">result</span>)</span> &rarr; <span class="type-signature returnType"><a href="ModelGraphics.html">ModelGraphics</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L319">DataSources/ModelGraphics.js 319</a>
</div>
</h4>
</div>
<div class="description">
Duplicates this instance.
</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>result</code></td>
<td class="type">
<span class="param-type"><a href="ModelGraphics.html">ModelGraphics</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The object onto which to store the result.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The modified result parameter or a new instance if one was not provided.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="merge">
<a href="#merge" class="doc-link"></a>
merge<span class="signature">(source)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L352">DataSources/ModelGraphics.js 352</a>
</div>
</h4>
</div>
<div class="description">
Assigns each unassigned property on this object to the value
of the same property on the provided source object.
</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>source</code></td>
<td class="type">
<span class="param-type"><a href="ModelGraphics.html">ModelGraphics</a></span>
</td>
<td class="description last">
The object to be merged into this object.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".ConstructorOptions">
<a href="#.ConstructorOptions" class="doc-link"></a>
Cesium.ModelGraphics.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/DataSources/ModelGraphics.js#L21">DataSources/ModelGraphics.js 21</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the ModelGraphics constructor
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">A boolean Property specifying the visibility of the model.</td>
</tr>
<tr>
<td class="name"><code>uri</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">string</span>
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A string or Resource Property specifying the URI of the glTF asset.</td>
</tr>
<tr>
<td class="name"><code>scale</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1.0
</td>
<td class="description last">A numeric Property specifying a uniform linear scale.</td>
</tr>
<tr>
<td class="name"><code>minimumPixelSize</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0.0
</td>
<td class="description last">A numeric Property specifying 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"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The maximum scale size of a model. An upper limit for minimumPixelSize.</td>
</tr>
<tr>
<td class="name"><code>incrementallyLoadTextures</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">Determine if textures may continue to stream in after the model is loaded.</td>
</tr>
<tr>
<td class="name"><code>runAnimations</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">A boolean Property specifying if glTF animations specified in the model should be started.</td>
</tr>
<tr>
<td class="name"><code>clampAnimations</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">A boolean Property specifying if glTF animations should hold the last pose for time durations with no keyframes.</td>
</tr>
<tr>
<td class="name"><code>shadows</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#ShadowMode">ShadowMode</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
ShadowMode.ENABLED
</td>
<td class="description last">An enum Property specifying whether the model casts or receives shadows from light sources.</td>
</tr>
<tr>
<td class="name"><code>heightReference</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#HeightReference">HeightReference</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
HeightReference.NONE
</td>
<td class="description last">A Property specifying what the height is relative to.</td>
</tr>
<tr>
<td class="name"><code>silhouetteColor</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Color.RED
</td>
<td class="description last">A Property specifying the <a href="Color.html"><code>Color</code></a> of the silhouette.</td>
</tr>
<tr>
<td class="name"><code>silhouetteSize</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0.0
</td>
<td class="description last">A numeric Property specifying the size of the silhouette in pixels.</td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Color.WHITE
</td>
<td class="description last">A Property specifying the <a href="Color.html"><code>Color</code></a> 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="Property.html">Property</a></span>
|
<span class="param-type"><a href="global.html#ColorBlendMode">ColorBlendMode</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
ColorBlendMode.HIGHLIGHT
</td>
<td class="description last">An enum Property specifying how the color blends with the model.</td>
</tr>
<tr>
<td class="name"><code>colorBlendAmount</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0.5
</td>
<td class="description last">A numeric Property specifying 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>imageBasedLightingFactor</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Cartesian2.html">Cartesian2</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
new Cartesian2(1.0, 1.0)
</td>
<td class="description last">A property specifying the contribution from diffuse and specular image-based lighting.</td>
</tr>
<tr>
<td class="name"><code>lightColor</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A property specifying 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>distanceDisplayCondition</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="DistanceDisplayCondition.html">DistanceDisplayCondition</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A Property specifying at what distance from the camera that this model will be displayed.</td>
</tr>
<tr>
<td class="name"><code>nodeTransformations</code></td>
<td class="type">
<span class="param-type"><a href="PropertyBag.html">PropertyBag</a></span>
|
<span class="param-type">Object.&lt;string, <a href="TranslationRotationScale.html">TranslationRotationScale</a>></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">An object, where keys are names of nodes, and values are <a href="TranslationRotationScale.html"><code>TranslationRotationScale</code></a> Properties describing the transformation to apply to that node. The transformation is applied after the node's existing transformation as specified in the glTF, and does not replace the node's existing transformation.</td>
</tr>
<tr>
<td class="name"><code>articulations</code></td>
<td class="type">
<span class="param-type"><a href="PropertyBag.html">PropertyBag</a></span>
|
<span class="param-type">Object.&lt;string, number></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">An object, where keys are composed of an articulation name, a single space, and a stage name, and the values are numeric properties.</td>
</tr>
<tr>
<td class="name"><code>clippingPlanes</code></td>
<td class="type">
<span class="param-type"><a href="Property.html">Property</a></span>
|
<span class="param-type"><a href="ClippingPlaneCollection.html">ClippingPlaneCollection</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A property specifying the <a href="ClippingPlaneCollection.html"><code>ClippingPlaneCollection</code></a> used to selectively disable rendering the model.</td>
</tr>
</tbody>
</table>
</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>