数字孪生Web 后台dt( digital twin)2.0版本 统一命名格式
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2020 lines
30 KiB

10 months ago
<!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>Earth - 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>
Earth
<div class="titleCenterer"></div>
</h1>
<section>
<header>
<div class="class-description">地球类</div>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Earth">
<a href="#Earth" class="doc-link"></a>
new Earth<span class="signature">(container, cesiumOptions)</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
创建地球类
</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>container</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">
容器ID</td>
</tr>
<tr>
<td class="name"><code>cesiumOptions</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">
改配置项和Cesium的Viewer创建时的options一致,请参见Cesium.Viewer <a href="https://cesium.com/docs/cesiumjs-ref-doc/Viewer.html?classFilter=Viewer#Viewer">https://cesium.com/docs/cesiumjs-ref-doc/Viewer.html?classFilter=Viewer#Viewer</a></td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">var earth = new XE.Earth('earthContainer', {
// 这里设置Viewer的配置,和new Viewer(container, options)中的options一致
homeButton: true,
timeline: true,
});</code></pre>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="analyzation">
<a href="#analyzation" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>analyzation<span class="type-signature"> : <a href="Analyzation.html">Analyzation</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
分析类
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="camera">
<a href="#camera" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>camera<span class="type-signature"> : <a href="Camera.html">Camera</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
相机管理器
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="cameraFlight">
<a href="#cameraFlight" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>cameraFlight<span class="type-signature"> : <a href="CameraFlight.html">CameraFlight</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
相机自动飞行
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="cameraViewManager">
<a href="#cameraViewManager" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>cameraViewManager<span class="type-signature"> : <a href="CameraView.Manager.html">CameraView.Manager</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
视角管理器
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="czm">
<a href="#czm" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>czm<span class="type-signature"> : object</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
可以通过此对象调用Cesium相关接口,
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>viewer</code></td>
<td class="type">
<span class="param-type">Cesium.Viewer</span>
</td>
<td class="description last">返回Cesium的viewer对象</td>
</tr>
<tr>
<td class="name"><code>scene</code></td>
<td class="type">
<span class="param-type">Cesium.Scene</span>
</td>
<td class="description last">返回Cesium的scene对象</td>
</tr>
<tr>
<td class="name"><code>camera</code></td>
<td class="type">
<span class="param-type">Cesium.Camera</span>
</td>
<td class="description last">返回Cesium的camera对象</td>
</tr>
</tbody>
</table>
</dl>
<div class="nameContainer">
<h4 class="name" id="effect">
<a href="#effect" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>effect<span class="type-signature"> : <a href="Effect.html">Effect</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
特效
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="interaction">
<a href="#interaction" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>interaction<span class="type-signature"> : <a href="XbsjInteraction.html">XbsjInteraction</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
交互类
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="ionDefaultAccessToken">
<a href="#ionDefaultAccessToken" class="doc-link"></a>
ionDefaultAccessToken<span class="type-signature"> : string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
Ion AccessToken
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">''</code>
<h5>Example:</h5>
<pre><code class="language-javascript">// 如果为空字符串,表示使用Cesium默认的accessToken
// 用来配置Cesium Ion服务地址,这样就可以加载Cesium官方的资源,注意Cesium官方公开的token每隔两个月就会自动过期,如果出现地形服务等不能访问,可以在Cesium官网自行申请一个token来使用,这样就可以避免过期问题。
earth.ionDefaultAccessToken = 'xxx'; // xxx请到Cesium官网申请!</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="postProcess">
<a href="#postProcess" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>postProcess<span class="type-signature"> : <a href="PostProcess.html">PostProcess</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
后处理
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="sceneTree">
<a href="#sceneTree" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>sceneTree<span class="type-signature"> : <a href="SceneTree.Tree.html">SceneTree.Tree</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
场景树
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="terrainEffect">
<a href="#terrainEffect" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>terrainEffect<span class="type-signature"> : <a href="TerrainEffect.html">TerrainEffect</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
地形特效
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="Weather">
<a href="#Weather" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>Weather<span class="type-signature"> : <a href="Weather.html">Weather</a></span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
天气
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="capture">
<a href="#capture" class="doc-link"></a>
capture<span class="signature">(width, height)</span> &rarr; <span class="type-signature returnType">string</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
截图
</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>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">
图像宽度,单位像素</td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">
图像高度,单位像素</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
返回图像的base64为字符串
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getAllObjects">
<a href="#getAllObjects" class="doc-link"></a>
getAllObjects<span class="signature">(<span class="optional">filterType</span>)</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
获取某一类对象的集合
</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>filterType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">
<span class="optional">optional</span>
对象类型名</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getObject">
<a href="#getObject" class="doc-link"></a>
getObject<span class="signature">(id)</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
根据guid获取某个对象
</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>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">
对象的guid</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="getSceneSize">
<a href="#getSceneSize" class="doc-link"></a>
getSceneSize<span class="signature">(position, screenSize)</span> &rarr; <span class="type-signature returnType">number</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
假定物体在屏幕上的大小来计算该物体实际尺寸,单位米
</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>position</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">
位置,形式如[1.0, 0.5, 50.0],表示[经度, 纬度, 高度],经纬度以弧度为单位,高度以米为单位</td>
</tr>
<tr>
<td class="name"><code>screenSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">
窗口上的实际像素大小,单位像素</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
返回实际尺寸大小,单位米
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pickPosition">
<a href="#pickPosition" class="doc-link"></a>
pickPosition<span class="signature">(movePosition, result)</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
位置拾取
</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>movePosition</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">
windows窗口坐标,形式如 {x: 10, y: 50 }</td>
</tr>
<tr>
<td class="name"><code>result</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">
返回值一个位置,形式如 [1.0, 0.5, 50.0],表示[经度, 纬度, 高度],经纬度以弧度为单位,高度以米为单位</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="toJSON">
<a href="#toJSON" class="doc-link"></a>
toJSON<span class="signature">()</span> &rarr; <span class="type-signature returnType">object</span>
<div class="source-link rightLinks">
</div>
</h4>
</div>
<div class="description">
注意:每次都会创建一个新对象!
</div>
<h5>Returns:</h5>
<div class="param-desc">
创建的JSON数据对象
</div>
<dl class="details">
</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">
</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.Image
</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>