包含 Cesium 场景的小部件。
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
container |
Element | string | 将包含小部件的DOM元素或ID。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options |
object |
optional
对象，具有以下属性：
|
Throws:
-
DeveloperError : id为"container"的元素在文档中不存在。
Example:
// For each example, include a link to CesiumWidget.css stylesheet in HTML head,
// and in the body, include: <div id="cesiumContainer"></div>
// Widget with no terrain and default Bing Maps imagery provider.
const widget = new Cesium.CesiumWidget("cesiumContainer");
// Widget with ion imagery and 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"
}
}),
// Show Columbus View map with Web Mercator projection
sceneMode: Cesium.SceneMode.COLUMBUS_VIEW,
mapProjection: new Cesium.WebMercatorProjection()
});Demo:
Members
获取或设置数据源是否可以暂时暂停
动画，以避免向用户显示不完整的图片。
例如，如果异步基元正在
background，则在几何图形准备就绪之前，时钟不会前进。
readonly camera : Camera
获取相机。
获取画布。
readonly clock : Clock
获取时钟。
clockTrackedDataSource : DataSource
获取或设置要使用小组件的时钟进行跟踪的数据源。
获取父容器。
获取 credit 容器。
creditDisplay : CreditDisplay
管理要在屏幕上和灯箱中显示的积分列表。
获取信用视区
readonly dataSourceDisplay : DataSourceDisplay
获取用于
DataSource 可视化的显示。
readonly dataSources : DataSourceCollection
获取要可视化的
DataSource 实例的集合。
readonly ellipsoid : Ellipsoid
获取场景的默认椭球体。
readonly entities : EntityCollection
获取未绑定到特定数据源的实体的集合。
这是
dataSourceDisplay.defaultDataSource.entities 的快捷方式。
readonly imageryLayers : ImageryLayerCollection
获取将在地球上渲染的图像图层的集合。
获取或设置渲染分辨率的缩放因子。 小于 1.0 的值可以提高
性能在功能较弱的设备上，而大于 1.0 的值将以更高的
分辨率，然后按比例缩小，从而提高视觉保真度。
例如，如果 Widget 的布局大小为 640x480，请将此值设置为 0.5
将导致场景以 320x240 渲染，然后在设置
设置为 2.0 将导致场景以 1280x960 渲染，然后缩小。
-
Default Value:
1.0
readonly scene : Scene
得到场景.
readonly screenSpaceEventHandler : ScreenSpaceEventHandler
获取屏幕空间事件处理程序。
获取或设置
使用 DefaultRenderLoop 时 widget 的目标帧率
为 true。如果未定义，则浏览器的 requestAnimationFrame 实现
确定帧速率。 如果已定义，则此值必须大于 0。 更高的值
时，底层的 requestAnimationFrame 实现将不起作用。
terrainProvider : TerrainProvider
提供地球表面几何图形的 terrain 提供程序。
trackedEntity : Entity|undefined
获取或设置相机当前正在跟踪的 Entity 实例。
readonly trackedEntityChanged : Event
获取在跟踪的实体更改时引发的事件。
布尔标志，指示是否使用浏览器的推荐分辨率。
如果为 true，则忽略浏览器的设备像素比，改用 1.0，
基于 CSS 像素而不是设备像素进行有效渲染。这可以改善
在具有高像素密度的较弱设备上的性能。当 false 时，渲染
将以设备像素为单位。
CesiumWidget#resolutionScale 仍然会生效
此标志为 true 或 false。
-
Default Value:
true
获取或设置是否此小部件应控制渲染循环。
如果为 true，则 widget 将使用 requestAnimationFrame 来
执行 widget 的渲染和大小调整，以及驱动
模拟时钟。如果设置为 false，则必须手动调用
调整大小，将方法作为自定义的一部分进行渲染
渲染循环。 如果在渲染过程中发生错误，则 Scene 的
renderError 事件，并且此属性
将设置为 false。 必须将其设置回 true 才能继续渲染
after the error.
Methods
销毁小部件。如果从布局中永久删除小部件，
则应该调用。
将摄像机飞到提供的实体、实体或数据源。
如果数据源仍在加载过程中，或者可视化图表仍在加载中，
此方法在执行 Flight 之前等待数据准备就绪。
偏移量是以边界球体中心为中心的本地北向参考系中的航向/俯仰/范围。 航向角和俯仰角在当地东西向北向上的参考系中定义。 航向是与 y 轴成的角度，并逐渐沿 x 轴增加。Pitch 是从 xy 平面开始的旋转。正间距 角度位于平面上方。负俯仰角位于平面下方。范围是距中心的距离。如果范围为 zero，则计算一个范围，使整个边界球体可见。
在 2D 中，必须有一个自上而下的视图。相机将放置在向下看的目标上方。高于 target 将是范围。航向将根据偏移量确定。如果标题不能为 根据偏移量确定，航向将为北。
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
target |
Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|VoxelPrimitive)> | 要查看的实体、实体数组、实体集合、数据源、Cesium3DTileset、点云或图像图层。您还可以传递一个 Promise，该 Promise 解析为前面提到的类型之一。 | ||||||||||||||||
options |
object |
optional
对象具有以下属性：
|
Returns:
如果飞行成功，则解析为 true，如果目标当前未在场景中可视化或飞行已取消，则解析为 false。//TODO： 清理实体提及
Returns:
如果对象已被销毁，则为true，否则为false。
渲染场景。 此函数是自动调用的
除非
useDefaultRenderLoop 设置为 false;
更新画布大小、摄像机纵横比和视口大小。
此函数会根据需要自动调用，除非
useDefaultRenderLoop 设置为 false。
向用户显示包含标题和较长错误消息的错误面板，
可以使用 OK 按钮关闭。 此面板将自动显示
当渲染循环发生错误时，如果 showRenderLoopErrors 不是 false，则
小部件。
| Name | Type | Description |
|---|---|---|
title |
string | 要在错误面板上显示的标题。 此字符串被解释为文本。 |
message |
string | optional 在详细的错误信息之前显示一条面向用户的有用消息。 此字符串被解释为 HTML。 |
error |
string |
optional
错误面板上显示的错误。 此字符串使用 formatError 进行格式设置，然后显示为文本。 |
异步设置摄像机以查看提供的实体、实体或数据源。
如果数据源仍在加载过程中，或者可视化图表仍在加载中，
此方法在执行缩放之前等待数据准备就绪。
偏移量是以边界球体中心为中心的本地北向参考系中的航向/俯仰/范围。 航向角和俯仰角在当地东西向北向上的参考系中定义。 航向是与 y 轴成的角度，并逐渐沿 x 轴增加。Pitch 是从 xy 平面开始的旋转。正间距 角度位于平面上方。负俯仰角位于平面下方。范围是距中心的距离。如果范围为 zero，则计算一个范围，使整个边界球体可见。
在 2D 中，必须有一个自上而下的视图。相机将放置在向下看的目标上方。高于 target 将是范围。航向将根据偏移量确定。如果标题不能为 根据偏移量确定，航向将为北。
| Name | Type | Description |
|---|---|---|
target |
Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|VoxelPrimitive)> | 要查看的实体、实体数组、实体集合、数据源、Cesium3DTileset、点云或图像图层。您还可以传递一个 Promise，该 Promise 解析为前面提到的类型之一。 |
offset |
HeadingPitchRange | optional 在本地东西向向上参考系中与实体中心的偏移量。 |
Returns:
一个 Promise，如果缩放成功，则解析为 true，如果目标当前未在场景中可视化或缩放已取消，则解析为 false。