包含 Cesium 场景的部件。
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
container |
Element | string | 包含此部件的 DOM 元素或 ID。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options |
object |
optional
具有以下属性的对象：
|
Throws:
-
DeveloperError : 文档中不存在 ID 为 "container" 的元素。
Example:
// 对于每个示例，在 HTML 头部包含 CesiumWidget.css 样式表的链接，
// 并在正文中包含：<div id="cesiumContainer"></div>
// 没有地形和默认 Bing Maps 影像提供者的部件。
const widget = new Cesium.CesiumWidget("cesiumContainer");
// 使用 ion 影像和 Cesium World Terrain 的部件。
const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
baseLayer: Cesium.ImageryLayer.fromWorldTerrain(),
terrain: Cesium.Terrain.fromWorldTerrain()
skyBox: new Cesium.SkyBox({
sources: {
positiveX: "stars/TychoSkymapII.t3_08192x04096_80_px.jpg",
negativeX: "stars/TychoSkymapII.t3_08192x04096_80_mx.jpg",
positiveY: "stars/TychoSkymapII.t3_08192x04096_80_py.jpg",
negativeY: "stars/TychoSkymapII.t3_08192x04096_80_my.jpg",
positiveZ: "stars/TychoSkymapII.t3_08192x04096_80_pz.jpg",
negativeZ: "stars/TychoSkymapII.t3_08192x04096_80_mz.jpg"
}
}),
// 使用 Web Mercator 投影显示哥伦布视图地图
sceneMode: Cesium.SceneMode.COLUMBUS_VIEW,
mapProjection: new Cesium.WebMercatorProjection()
});Demo:
Members
获取或设置数据源是否可以暂时暂停动画，以避免向用户显示不完整的画面。
例如，如果异步图元正在后台处理，时钟将不会前进，直到几何图形准备就绪。
readonly camera : Camera
获取相机。
获取画布。
readonly clock : Clock
获取时钟。
clockTrackedDataSource : DataSource
获取或设置要与部件的时钟一起跟踪的数据源。
获取父容器。
获取版权容器。
creditDisplay : CreditDisplay
Manages the list of credits to display on screen and in the lightbox.
获取版权视口。
readonly dataSourceDisplay : DataSourceDisplay
获取用于
DataSource 可视化的显示。
readonly dataSources : DataSourceCollection
获取要可视化的
DataSource 实例集合。
readonly ellipsoid : Ellipsoid
获取场景的默认椭球体。
readonly entities : EntityCollection
获取未绑定到特定数据源的实体集合。
这是
dataSourceDisplay.defaultDataSource.entities 的快捷方式。
readonly imageryLayers : ImageryLayerCollection
获取将在地球上渲染的影像图层集合。
获取或设置渲染分辨率的缩放因子。小于 1.0 的值可以在性能较弱的设备上提高性能，
而大于 1.0 的值将以更高的分辨率渲染然后缩小，从而提高视觉保真度。
例如，如果部件布局大小为 640x480，将此值设置为 0.5 将导致场景以 320x240 渲染然后放大，
而将其设置为 2.0 将导致场景以 1280x960 渲染然后缩小。
-
Default Value:
1.0
readonly scene : Scene
获取场景。
readonly screenSpaceEventHandler : ScreenSpaceEventHandler
获取屏幕空间事件处理器。
获取或设置当
useDefaultRenderLoop 为 true 时部件的目标帧率。
如果未定义，则浏览器的 requestAnimationFrame 实现将决定帧率。
如果定义，此值必须大于 0。高于底层 requestAnimationFrame 实现的值将不起作用。
terrainProvider : TerrainProvider
为地球提供表面几何的地形提供者。
trackedEntity : Entity|undefined
获取或设置当前被相机跟踪的实体实例。
readonly trackedEntityChanged : Event
获取当被跟踪的实体更改时引发的事件。
布尔标志，指示是否使用浏览器推荐的分辨率。
如果为 true，则忽略浏览器的设备像素比并使用 1.0，实际上基于 CSS 像素而不是设备像素进行渲染。
这可以在具有高像素密度的性能较弱的设备上提高性能。当为 false 时，渲染将使用设备像素。
无论此标志是 true 还是 false，
CesiumWidget#resolutionScale 仍将生效。
-
Default Value:
true
获取或设置此部件是否应控制渲染循环。
如果为 true，部件将使用 requestAnimationFrame 来执行部件的渲染和调整大小，以及驱动模拟时钟。
如果设置为 false，您必须手动调用
resize、render 方法作为自定义渲染循环的一部分。
如果在渲染期间发生错误，Scene 的 renderError 事件将被引发，并且此属性将被设置为 false。
错误发生后，必须将其设置回 true 才能继续渲染。
Methods
销毁部件。如果从布局中永久移除部件，应调用此方法。
飞行相机到提供的实体、实体数组或数据源。
如果数据源仍在加载过程中或可视化仍在加载中，此方法会等待数据准备就绪后再执行飞行。
偏移量是位于边界球体中心处的局部东-北-上参考系中的航向/俯仰/距离。 航向和俯仰角在局部东-北-上参考系中定义。 航向是从 y 轴开始的角度，并朝向 x 轴增加。俯仰是从 xy 平面开始的旋转。正俯仰角 在平面之上。负俯仰角在平面之下。距离是距中心的距离。如果距离为 零，将计算一个距离，使整个边界球体都可见。
在 2D 中，必须是俯视图。相机将放置在目标上方向下看。在目标上方的 高度将是距离。航向将根据偏移量确定。如果无法从偏移量 确定航向，则航向将为北。
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
target |
Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|VoxelPrimitive|BufferPrimitiveCollection.<BufferPrimitive>)> | 要查看的实体、实体数组、实体集合、数据源、Cesium3DTileset、点云或影像图层。您也可以传递一个解析为上述类型之一的 Promise。 | ||||||||||||||||
options |
object |
optional
具有以下属性的对象：
|
Returns:
如果飞行成功则解析为 true 的 Promise，如果目标当前未在场景中可视化或飞行被取消则解析为 false。 //TODO: 清理实体提及
Returns:
如果对象已被销毁则返回 true，否则返回 false。
渲染场景。除非
useDefaultRenderLoop 设置为 false，否则会自动调用此函数；
更新画布大小、相机纵横比和视口大小。
除非
useDefaultRenderLoop 设置为 false，否则会根据需要自动调用此函数。
向用户显示一个错误面板，包含标题和更详细的错误消息，
可以使用"确定"按钮关闭。如果在构建部件时 showRenderLoopErrors 不为 false，
则当发生渲染循环错误时，此面板会自动显示。
| Name | Type | Description |
|---|---|---|
title |
string | 要在错误面板上显示的标题。此字符串被解释为文本。 |
message |
string | optional 在详细错误信息之前显示的面向用户的有用消息。此字符串被解释为 HTML。 |
error |
string |
optional
要在错误面板上显示的错误。此字符串使用 formatError 格式化，然后作为文本显示。 |
异步设置相机以查看提供的实体、实体数组或数据源。
如果数据源仍在加载过程中或可视化仍在加载中，此方法会等待数据准备就绪后再执行缩放。
偏移量是位于边界球体中心处的局部东-北-上参考系中的航向/俯仰/距离。 航向和俯仰角在局部东-北-上参考系中定义。 航向是从 y 轴开始的角度，并朝向 x 轴增加。俯仰是从 xy 平面开始的旋转。正俯仰角 在平面之上。负俯仰角在平面之下。距离是距中心的距离。如果距离为 零，将计算一个距离，使整个边界球体都可见。
在 2D 中，必须是俯视图。相机将放置在目标上方向下看。在目标上方的 高度将是距离。航向将根据偏移量确定。如果无法从偏移量 确定航向，则航向将为北。
| Name | Type | Description |
|---|---|---|
target |
Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|VoxelPrimitive|BufferPrimitiveCollection.<BufferPrimitive>)> | 要查看的实体、实体数组、实体集合、数据源、Cesium3DTileset、点云或影像图层。您也可以传递一个解析为上述类型之一的 Promise。 |
offset |
HeadingPitchRange | optional 在局部东-北-上参考系中距实体中心的偏移量。 |
Returns:
如果缩放成功则解析为 true 的 Promise，如果目标当前未在场景中可视化或缩放被取消则解析为 false。