<!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 - XbsjEarth 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> -->
<a href="index.html">EarthSDK</a>
Model
<div class="titleCenterer"></div>
</h1>
<section>
<header>
<div class="class-description">模型（gltf加载）</div>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Model">
<a href="#Model" class="doc-link"></a>
new Model<span class="signature">()</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="XbsjCzmObj.html">XbsjCzmObj</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".xbsjEnvirement">
<a href="#.xbsjEnvirement" class="doc-link"></a>
<span class="type-signature attribute-static">static</span>Obj.Model.xbsjEnvirement<span class="type-signature"></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
一个内置的环境贴图，可以设置给属性specularEnvironmentMaps。
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="allowPicking">
<a href="#allowPicking" class="doc-link"></a>
allowPicking<span class="type-signature"> : boolean</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, each glTF mesh and primitive is pickable with <code>Scene#pick</code>.
</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>
asynchronous<span class="type-signature"> : boolean</span>
<div class="source-link rightLinks">
</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="attachedPathGuid">
<a href="#attachedPathGuid" class="doc-link"></a>
attachedPathGuid<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
绑定的路径的guid
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">''</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="basePath">
<a href="#basePath" class="doc-link"></a>
basePath<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
The base path that paths in the glTF JSON are relative to.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">''</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="cameraAttachedOffsetPosition">
<a href="#cameraAttachedOffsetPosition" class="doc-link"></a>
cameraAttachedOffsetPosition<span class="type-signature"> : Array.<number></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
相机绑定后的位置偏移
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[0, 0, 0]</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="cameraAttachedOffsetRotation">
<a href="#cameraAttachedOffsetRotation" class="doc-link"></a>
cameraAttachedOffsetRotation<span class="type-signature"> : Array.<number></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
相机绑定后的姿态偏移
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[0, -Math.PI/3, 0]</code>
</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">
</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">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="color">
<a href="#color" class="doc-link"></a>
color<span class="type-signature"> : Array.<number></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
颜色叠加
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[1, 1, 1, 1]</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">
</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"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
Defines how the color blends with the mode. mode: ColorBlendMode.HIGHLIGHT, ColorBlendMode.REPLACE, ColorBlendMode.MIX
</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="customProp">
<a href="#customProp" class="doc-link"></a>
customProp<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
用来临时存储客户需要的一些信息，方便使用<br/>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjCzmObj.html#customProp">XbsjCzmObj#customProp</a>
</li></dd>
<span class="details-header">Default Value:</span>
<code class="language-javascript">''</code>
</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">
</div>
</h4>
</div>
<div class="description">
For debugging only. Draws the bounding sphere for each <code>DrawCommand</code> in the model.
</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">
</div>
</h4>
</div>
<div class="description">
For debugging only. Draws the model in wireframe.
</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="destroyEvalString">
<a href="#destroyEvalString" class="doc-link"></a>
destroyEvalString<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
销毁时的执行语句，只有在对象销毁时才会执行，方便用来清理随该对象创建时附带创建的资源<br/>
有一个内置变量p，表示当前对象。
注意对象的销毁除了使用destroyEvalString，还可以使用 <a href="XbsjBase.html#disposers"><code>disposers</code></a> 属性来销毁。
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjCzmObj.html#destroyEvalString">XbsjCzmObj#destroyEvalString</a>
</li></dd>
<span class="details-header">Default Value:</span>
<code class="language-javascript">''</code>
<h5>See:</h5>
<ul class="see-list">
<li><a href="XbsjCzmObj.html#evalString">XbsjCzmObj#evalString</a></li>
<li><a href="XbsjCzmObj.html#preUpdateEvalString">XbsjCzmObj#preUpdateEvalString</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="disposers">
<a href="#disposers" class="doc-link"></a>
disposers<span class="type-signature"></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
用来收集资源销毁函数，并在析构时自动调用！
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#disposers">XbsjBase#disposers</a>
</li></dd>
<h5>Example:</h5>
<pre><code class="language-javascript">// 示例1：
myObject.disposers.push(() => {
// 此处执行需要销毁的资源
});
// 示例2：
// XE.MVVM.bind的返回值是一个函数，作用是用来解除双向绑定，
// 把它的返回值放到disposer中，那么对象销毁时就会执行解绑操作。
myObject.disposers.push(XE.MVVM.bind(xxx));
// 示例3：
// XE.MVVM.watch的返回值是一个函数，作用是用来取消监视，
// 把它的返回值放到disposer中，那么对象销毁时就会执行取消监视的操作。
myObject.disposers.push(XE.MVVM.watch(xxx));</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="distanceDisplayCondition">
<a href="#distanceDisplayCondition" class="doc-link"></a>
distanceDisplayCondition<span class="type-signature"> : Array.<number>|undefined</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
模型视距范围，两个元素的数组，分别表示near和far。形式如：[200.0, 3000.0]
</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="earth">
<a href="#earth" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>earth<span class="type-signature"> : <a href="Earth.html">Earth</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
返回该对象的所属earth实例
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjObject.html#earth">XbsjObject#earth</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="enabled">
<a href="#enabled" class="doc-link"></a>
enabled<span class="type-signature"> : boolean</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
是否启用
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjObject.html#enabled">XbsjObject#enabled</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="evalString">
<a href="#evalString" class="doc-link"></a>
evalString<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
设置执行语句，<br/>
内部有一个内置的变量p，用来指示当前对象。<br/>
注意evalString每次进行属性设置都会执行一遍，如果evalString中有创建资源，资源需要记录，避免再次执行后销毁不了。<br/>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjCzmObj.html#evalString">XbsjCzmObj#evalString</a>
</li></dd>
<span class="details-header">Default Value:</span>
<code class="language-javascript">''</code>
<h5>Example:</h5>
<pre><code class="language-javascript">myObject.evalString = `
// 技巧1：p是一个内置变量，可以直接使用
if (p._div) { // 技巧2：evalString有可能执行多次，这个地方的判断是避免div重复创建！
return;
}
// 创建div
const div = document.createElement('div');
p._div = div;
// 技巧3：可以通过p.earth来获取earth变量
const earth = p.earth;
`;</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="XbsjCzmObj.html#preUpdateEvalString">XbsjCzmObj#preUpdateEvalString</a></li>
<li><a href="XbsjCzmObj.html#destroyEvalString">XbsjCzmObj#destroyEvalString</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="guid">
<a href="#guid" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>guid<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
对象的唯一标识符<br/>
注意，对象一旦创建，guid不可更改！
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjObject.html#guid">XbsjObject#guid</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="heightReference">
<a href="#heightReference" class="doc-link"></a>
heightReference<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
Determines how the model is drawn relative to terrain. 值如下：HeightReference.NONE, HeightReference.CLAMP_TO_GROUND, HeightReference.RELATIVE_TO_GROUND,
</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="incrementallyLoadTextures">
<a href="#incrementallyLoadTextures" class="doc-link"></a>
incrementallyLoadTextures<span class="type-signature"> : boolean</span>
<div class="source-link rightLinks">
</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="luminanceAtZenith">
<a href="#luminanceAtZenith" class="doc-link"></a>
luminanceAtZenith<span class="type-signature"> : number</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
材质底色 Cesium 1.61以后默认值为0.2，之前为0.5
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.2</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumScale">
<a href="#maximumScale" class="doc-link"></a>
maximumScale<span class="type-signature"> : number|undefined</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
The maximum scale for the 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="minimumPixelSize">
<a href="#minimumPixelSize" class="doc-link"></a>
minimumPixelSize<span class="type-signature"> : number</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
The approximate minimum pixel size of the model regardless of zoom.
</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="preUpdateEvalString">
<a href="#preUpdateEvalString" class="doc-link"></a>
preUpdateEvalString<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
设置每帧执行语句，和evalString的作用类似 <br/>
它有三个内置变量，分别是p, scene, time，分别表示当前对象，Cesium的场景对象scene，Cesium的当前帧的时间time
需要注意的是它会每帧执行一次。
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjCzmObj.html#preUpdateEvalString">XbsjCzmObj#preUpdateEvalString</a>
</li></dd>
<span class="details-header">Default Value:</span>
<code class="language-javascript">‘’</code>
<h5>Example:</h5>
<pre><code class="language-javascript">myObject.preUpdateEvalString = `
// 技巧1：p是一个内置变量，可以直接使用，还有scene，time都可以直接使用
p._angle += 1;
if (p._angle > 360.0) {
p._angle = 0.0;
}
const angle = p._angle;
// drawCanvas时使用angle来改变图像内容
// ...
`;</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="XbsjCzmObj.html#preUpdateEvalString">XbsjCzmObj#preUpdateEvalString</a></li>
<li><a href="XbsjCzmObj.html#destroyEvalString">XbsjCzmObj#destroyEvalString</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="scale">
<a href="#scale" class="doc-link"></a>
scale<span class="type-signature"> : boolean</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
A uniform scale applied to this model.
</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"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
Determines whether the model casts or receives shadows from each light source. mode: ShadowMode.CAST_ONLY, ShadowMode.DISABLED, ShadowMode.ENABLED, ShadowMode.RECEIVE_ONLY
</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">
</div>
</h4>
</div>
<div class="description">
是否在三维窗口中显示
</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"> : Array.<number></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
The silhouette color. If more than 256 models have silhouettes enabled, there is a small chance that overlapping models will have minor artifacts.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[1.0, 0.0, 0.0, 1.0]</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">
</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|undefined</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
环境贴图
</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="url">
<a href="#url" class="doc-link"></a>
url<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
资源URL路径 The url to the .gltf file.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">''</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="viewDistance">
<a href="#viewDistance" class="doc-link"></a>
viewDistance<span class="type-signature"> : number</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
相机飞入时的视距设定，即调用flyTo后，相机距离物体多远处停下来
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">50.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="xbsjGuid">
<a href="#xbsjGuid" class="doc-link"></a>
xbsjGuid<span class="type-signature"> : string|undefined</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
对象的唯一标识符 <br/>
警告：该属性已废弃，请不要使用属性，且禁止修改此属性。<br/>
如果需要获取guid，请通过<a href="XbsjObject.html#guid"><code>guid</code></a>属性来获取。<br/>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjObject.html#xbsjGuid">XbsjObject#xbsjGuid</a>
</li></dd>
<p>
<span class="details-header important">Deprecated:</span>
<span>true</span>
</p>
</dl>
<div class="nameContainer">
<h4 class="name" id="xbsjPosition">
<a href="#xbsjPosition" class="doc-link"></a>
xbsjPosition<span class="type-signature"> : Array.<number></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
位置数组 [经度、纬度、高度] <br/>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[0, 0, 0]</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="xbsjRotation">
<a href="#xbsjRotation" class="doc-link"></a>
xbsjRotation<span class="type-signature"> : Array.<number></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
姿态数组 [偏航角、俯仰角、翻转角]
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[0, 0, 0]</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="xbsjScale">
<a href="#xbsjScale" class="doc-link"></a>
xbsjScale<span class="type-signature"> : Array.<number></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
缩放数组 [x向缩放、y向缩放、z向缩放]
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">[1, 1, 1]</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="xbsjType">
<a href="#xbsjType" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>xbsjType<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
获取对象的类型信息
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjObject.html#xbsjType">XbsjObject#xbsjType</a>
</li></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span> → <span class="type-signature returnType">undefined</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
销毁对象<br/>
警告：对象一旦销毁不可再次使用！<br/>
警告：挂在场景树上的对象禁止调用destroy方法，只要通过数组函数将其从场景树中移除，就会自动销毁！<br/>
</div>
<h5>Returns:</h5>
<div class="param-desc">
返回undefined
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#destroy">XbsjBase#destroy</a>
</li></dd>
<h5>Example:</h5>
<pre><code class="language-javascript">// 使用范例
// 这样写的好处是，一旦对象销毁，会同时将引用该对象的变量同时置为undefined，防止再次使用。
this._myObject = this._myObject && this._myObject.destroy();</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="flyTo">
<a href="#flyTo" class="doc-link"></a>
flyTo<span class="signature">()</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
飞入该对象
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjCzmObj.html#flyTo">XbsjCzmObj#flyTo</a>
</li></dd>
</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">
</div>
</h4>
</div>
<div class="description">
检查对象是否已被销毁<br/>
警告：对象一旦销毁不可再次使用！仅此函数可以调用！<br/>
</div>
<h5>Returns:</h5>
<div class="param-desc">
对象是否已销毁
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#isDestroyed">XbsjBase#isDestroyed</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="nativeModel">
<a href="#nativeModel" class="doc-link"></a>
nativeModel<span class="signature">()</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
获取Cesium原始模型信息，注意有可能因获取不到而返回undefined
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="toAllJSON">
<a href="#toAllJSON" class="doc-link"></a>
toAllJSON<span class="signature">()</span> → <span class="type-signature returnType">object</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
数据整个JSOn对象，包括默认值
</div>
<h5>Returns:</h5>
<div class="param-desc">
创建的JSON数据对象
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#toAllJSON">XbsjBase#toAllJSON</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="toAllJSONStr">
<a href="#toAllJSONStr" class="doc-link"></a>
toAllJSONStr<span class="signature">()</span> → <span class="type-signature returnType">string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
转化成JSON字符串，输出全部元素
</div>
<h5>Returns:</h5>
<div class="param-desc">
JSON格式化好的字符串
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#toAllJSONStr">XbsjBase#toAllJSONStr</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="toJSON">
<a href="#toJSON" class="doc-link"></a>
toJSON<span class="signature">()</span> → <span class="type-signature returnType">object</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
转化成一个JSON数据对象 <br/>
注意：每次都会创建一个新对象！
</div>
<h5>Returns:</h5>
<div class="param-desc">
创建的JSON数据对象
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#toJSON">XbsjBase#toJSON</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="toJSONStr">
<a href="#toJSONStr" class="doc-link"></a>
toJSONStr<span class="signature">()</span> → <span class="type-signature returnType">string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
转化成JSON字符串，默认元素不输出
</div>
<h5>Returns:</h5>
<div class="param-desc">
JSON格式化好的字符串
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#toJSONStr">XbsjBase#toJSONStr</a>
</li></dd>
</dl>
<div class="nameContainer">
<h4 class="name" id="xbsjFromJSON">
<a href="#xbsjFromJSON" class="doc-link"></a>
xbsjFromJSON<span class="signature">(jsonObject)</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
通过JSON数据对象来设置属性
</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>jsonObject</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="XbsjBase.html#xbsjFromJSON">XbsjBase#xbsjFromJSON</a>
</li></dd>
<h5>Example:</h5>
<pre><code class="language-javascript">// 创建一个pin对象
const objConfig = {
"name": 'Pin1',
"xbsjType": "Pin",
"position": [1.9017005694855162, 0.5972477268978722, 488.7695178987821],
"near": 300,
"show": false,
evalString,
};
const pin = new XE.Obj.Pin(earth);
pin.xbsjFromJSON(objConfig);</code></pre>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="AmbientOcclusionStage"><a href="AmbientOcclusionStage.html">AmbientOcclusionStage</a></li><li data-name="Analyzation"><a href="Analyzation.html">Analyzation</a></li><li data-name="CutFillComputing"><a href="Analyzation.CutFillComputing.html">CutFillComputing</a></li><li data-name="Measurement"><a href="Analyzation.Measurement.html">Measurement</a></li><li data-name="BlackAndWhiteStage"><a href="BlackAndWhiteStage.html">BlackAndWhiteStage</a></li><li data-name="BloomStage"><a href="BloomStage.html">BloomStage</a></li><li data-name="BrightnessStage"><a href="BrightnessStage.html">BrightnessStage</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="Immersion"><a href="Camera.Immersion.html">Immersion</a></li><li data-name="Interaction"><a href="Camera.Interaction.html">Interaction</a></li><li data-name="Navigator"><a href="Camera.Navigator.html">Navigator</a></li><li data-name="Viewport"><a href="Camera.Viewport.html">Viewport</a></li><li data-name="CameraFlight"><a href="CameraFlight.html">CameraFlight</a></li><li data-name="CameraTrack"><a href="CameraFlight.CameraTrack.html">CameraTrack</a></li><li data-name="CameraView"><a href="CameraView.html">CameraView</a></li><li data-name="Manager"><a href="CameraView.Manager.html">Manager</a></li><li data-name="Status"><a href="CameraView.Status.html">Status</a></li><li data-name="View"><a href="CameraView.View.html">View</a></li><li data-name="DepthOfFieldStage"><a href="DepthOfFieldStage.html">DepthOfFieldStage</a></li><li data-name="Earth"><a href="Earth.html">Earth</a></li><li data-name="Effect"><a href="Effect.html">Effect</a></li><li data-name="ForceSunPos"><a href="Effect.ForceSunPos.html">ForceSunPos</a></li><li data-name="Shadow"><a href="Effect.Shadow.html">Shadow</a></li><li data-name="HTML"><a href="HTML.html">HTML</a></li><li data-name="LensFlareStage"><a href="LensFlareStage.html">LensFlareStage</a></li><li data-name="MapVLayer"><a href="MapVLayer.MapVLayer.html">MapVLayer</a></li><li data-name="MapVRenderer"><a href="MapVRenderer.MapVRenderer.html">MapVRenderer</a></li><li data-name="Misc"><a href="Misc.html">Misc</a></li><li data-name="Debug"><a href="Misc.Debug.html">Debug</a></li><li data-name="MosaicStage"><a href="MosaicStage.html">MosaicStage</a></li><li data-name="MVVM"><a href="MVVM.html">MVVM</a></li><li data-name="NightVisionStage"><a href="NightVisionStage.html">NightVisionStage</a></li><li data-name="Obj"><a href="Obj.html">Obj</a></li><li data-name="CameraVideo"><a href="Obj.CameraVideo.html">CameraVideo</a></li><li data-name="ClassificationPolygon"><a href="Obj.ClassificationPolygon.html">ClassificationPolygon</a></li><li data-name="Outline"><a href="Obj.ClassificationPolygon.Outline.html">Outline</a></li><li data-name="ClippingPlane"><a href="Obj.ClippingPlane.html">ClippingPlane</a></li><li data-name="CustomGroundRectangle"><a href="Obj.CustomGroundRectangle.html">CustomGroundRectangle</a></li><li data-name="CustomPrimitive"><a href="Obj.CustomPrimitive.html">CustomPrimitive</a></li><li data-name="Geometry"><a href="Obj.CustomPrimitive.Geometry.html">Geometry</a></li><li data-name="CutSurface"><a href="Obj.CutSurface.html">CutSurface</a></li><li data-name="FlattenedPolygonCollection"><a href="Obj.FlattenedPolygonCollection.html">FlattenedPolygonCollection</a></li><li data-name="FlattenedPolygon"><a href="Obj.FlattenedPolygonCollection.FlattenedPolygon.html">FlattenedPolygon</a></li><li data-name="Forest"><a href="Obj.Forest.html">Forest</a></li><li data-name="GroundImage"><a href="Obj.GroundImage.html">GroundImage</a></li><li data-name="HeatMap"><a href="Obj.HeatMap.html">HeatMap</a></li><li data-name="Imagery"><a href="Obj.Imagery.html">Imagery</a></li><li data-name="ImageryProvider"><a href="Obj.Imagery.ImageryProvider.html">ImageryProvider</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="Obj.Imagery.ImageryProvider.ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="GoogleEarthEnterpriseImageryProvider"><a href="Obj.Imagery.ImageryProvider.GoogleEarthEnterpriseImageryProvider.html">GoogleEarthEnterpriseImageryProvider</a></li><li data-name="TileMapServiceImageryProvider"><a href="Obj.Imagery.ImageryProvider.TileMapServiceImageryProvider.html">TileMapServiceImageryProvider</a></li><li data-name="UrlTemplateImageryProvider"><a href="Obj.Imagery.ImageryProvider.UrlTemplateImageryProvider.html">UrlTemplateImageryProvider</a></li><li data-name="WebMapServiceImageryProvider"><a href="Obj.Imagery.ImageryProvider.WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li><li data-name="WebMapTileServiceImageryProvider"><a href="Obj.Imagery.ImageryProvider.WebMapTileServiceImageryProvider.html">WebMapTileServiceImageryProvider</a></li><li data-name="XbsjImageryProvider"><a href="Obj.Imagery.ImageryProvider.XbsjImageryProvider.html">XbsjImageryProvider</a></li><li data-name="Model"><a href="Obj.Model.html">Model</a></li><li data-name="ODLines"><a href="Obj.ODLines.html">ODLines</a></li><li data-name="Path"><a href="Obj.Path.html">Path</a></li><li data-name="Pin"><a href="Obj.Pin.html">Pin</a></li><li data-name="PinBuilder"><a href="Obj.Pin.PinBuilder.html">PinBuilder</a></li><li data-name="PlotBase"><a href="Obj.PlotBase.html">PlotBase</a></li><li data-name="Polygon"><a href="Obj.Polygon.html">Polygon</a></li><li data-name="Outline"><a href="Obj.Polygon.Outline.html">Outline</a></li><li data-name="Polyline"><a href="Obj.Polyline.html">Polyline</a></li><li data-name="Material"><a href="Obj.Polyline.Material.html">Material</a></li><li data-name="Color"><a href="Obj.Polyline.Material.Color.html">Color</a></li><li data-name="PolylineArrow"><a href="Obj.Polyline.Material.PolylineArrow.html">PolylineArrow</a></li><li data-name="PolylineDash"><a href="Obj.Polyline.Material.PolylineDash.html">PolylineDash</a></li><li data-name="PolylineGlow"><a href="Obj.Polyline.Material.PolylineGlow.html">PolylineGlow</a></li><li data-name="PolylineOutline"><a href="Obj.Polyline.Material.PolylineOutline.html">PolylineOutline</a></li><li data-name="XbsjODLine"><a href="Obj.Polyline.Material.XbsjODLine.html">XbsjODLine</a></li><li data-name="Road"><a href="Obj.Road.html">Road</a></li><li data-name="Scanline"><a href="Obj.Scanline.html">Scanline</a></li><li data-name="Surface"><a href="Obj.Surface.html">Surface</a></li><li data-name="Terrain"><a href="Obj.Terrain.html">Terrain</a></li><li data-name="TerrainProvider"><a href="Obj.Terrain.TerrainProvider.html">TerrainProvider</a></li><li data-name="GoogleEarthEnterpriseTerrainProvider"><a href="Obj.Terrain.TerrainProvider.GoogleEarthEnterpriseTerrainProvider.html">GoogleEarthEnterpriseTerrainProvider</a></li><li data-name="XbsjCesiumTerrainProvider"><a href="Obj.Terrain.TerrainProvider.XbsjCesiumTerrainProvider.html">XbsjCesiumTerrainProvider</a></li><li data-name="XbsjEllipsoidTerrainProvider"><a href="Obj.Terrain.TerrainProvider.XbsjEllipsoidTerrainProvider.html">XbsjEllipsoidTerrainProvider</a></li><li data-name="Tileset"><a href="Obj.Tileset.html">Tileset</a></li><li data-name="Viewshed"><a href="Obj.Viewshed.html">Viewshed</a></li><li data-name="Wall"><a href="Obj.Wall.html">Wall</a></li><li data-name="Water"><a href="Obj.Water.html">Water</a></li><li data-name="Picking"><a href="Picking.html">Picking</a></li><li data-name="PolylineVolumeGeometry"><a href="PolylineVolumeGeometry.html">PolylineVolumeGeometry</a></li><li data-name="PostProcess"><a href="PostProcess.html">PostProcess</a></li><li data-name="RotateCenter"><a href="RotateCenter.html">RotateCenter</a></li><li data-name="SceneTree"><a href="SceneTree.html">SceneTree</a></li><li data-name="Group"><a href="SceneTree.Group.html">Group</a></li><li data-name="Leaf"><a href="SceneTree.Leaf.html">Leaf</a></li><li data-name="Node"><a href="SceneTree.Node.html">Node</a></li><li data-name="Tree"><a href="SceneTree.Tree.html">Tree</a></li><li data-name="TerrainEffect"><a href="TerrainEffect.html">TerrainEffect</a></li><li data-name="AspectRamp"><a href="TerrainEffect.AspectRamp.html">AspectRamp</a></li><li data-name="Contour"><a href="TerrainEffect.Contour.html">Contour</a></li><li data-name="ElevationRamp"><a href="TerrainEffect.ElevationRamp.html">ElevationRamp</a></li><li data-name="GlobeTranslucency"><a href="TerrainEffect.GlobeTranslucency.html">GlobeTranslucency</a></li><li data-name="Restrict"><a href="TerrainEffect.Restrict.html">Restrict</a></li><li data-name="SlopeRamp"><a href="TerrainEffect.SlopeRamp.html">SlopeRamp</a></li><li data-name="Weather"><a href="Weather.html">Weather</a></li><li data-name="Atmosphere"><a href="Weather.Atmosphere.html">Atmosphere</a></li><li data-name="Fog"><a href="Weather.Fog.html">Fog</a></li><li data-name="FogPostProcess"><a href="Weather.FogPostProcess.html">FogPostProcess</a></li><li data-name="Moon"><a href="Weather.Moon.html">Moon</a></li><li data-name="Rain"><a href="Weather.Rain.html">Rain</a></li><li data-name="RainPostProcess"><a href="Weather.RainPostProcess.html">RainPostProcess</a></li><li data-name="SkyBox"><a href="Weather.SkyBox.html">SkyBox</a></li><li data-name="Snow"><a href="Weather.Snow.html">Snow</a></li><li data-name="SnowPostProcess"><a href="Weather.SnowPostProcess.html">SnowPostProcess</a></li><li data-name="Sun"><a href="Weather.Sun.html">Sun</a></li><li data-name="WorldCloud"><a href="Weather.WorldCloud.html">WorldCloud</a></li><li data-name="XbsjBase"><a href="XbsjBase.html">XbsjBase</a></li><li data-name="XbsjCzmObj"><a href="XbsjCzmObj.html">XbsjCzmObj</a></li><li data-name="XbsjInteraction"><a href="XbsjInteraction.html">XbsjInteraction</a></li><li data-name="XbsjObject"><a href="XbsjObject.html">XbsjObject</a></li><li data-name="XbsSilhouetteStage"><a href="XbsSilhouetteStage.html">XbsSilhouetteStage</a></li><li data-name="XE"><a href="XE.html">XE</a></li></ul>
</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>