一个包含 Cesium 场景的小部件。
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
container
|
Element | String | 将包含小部件的 DOM 元素或 ID。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options
|
Object |
具有以下属性的
可选
对象:
|
Throws:
-
DeveloperError :文档中不存在 ID 为'容器'的元素。
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', {
imageryProvider : Cesium.createWorldImagery(),
terrainProvider : Cesium.createWorldTerrain(),
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
readonly camera : Camera
获取相机。
获取画布。
readonly clock : Clock
获取时钟。
获取父容器。
获取信用容器。
获取信用视口
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
为地球提供表面几何图形的地形提供者。
指示是否使用浏览器推荐的分辨率的布尔标志。如果为 true,则忽略浏览器的设备像素比并改用 1.0,有效地基于 CSS 像素而不是设备像素进行渲染。这可以提高具有高像素密度的功能较弱的设备的性能。当为 false 时,渲染将以设备像素为单位。
CesiumWidget#resolutionScale
不管这个标志是真还是假都会生效。
-
Default Value:
true
获取或设置此小部件是否应控制渲染循环。如果设置为 true,小部件将使用
requestAnimationFrame
来执行小部件的渲染和调整大小,以及驱动模拟时钟。如果设置为 false,您必须手动调用
resize
、
render
方法作为自定义渲染循环的一部分。如果在渲染过程中发生错误,会引发
Scene
的
renderError
事件并且该属性将被设置为 false。错误后必须将其设置回 true 才能继续渲染。
Methods
销毁小部件。如果从布局中永久删除小部件,则应调用。
Returns:
如果对象已被销毁,则为 true,否则为 false。
渲染场景。除非
useDefaultRenderLoop
设置为 false,否则会自动调用此函数;
更新画布大小、相机纵横比和视口大小。此函数会根据需要自动调用,除非
useDefaultRenderLoop
设置为 false。
向用户显示一个错误面板,其中包含标题和更长的错误消息,可以使用 OK 按钮将其关闭。如果在构建小部件时 showRenderLoopErrors 不为假,则发生渲染循环错误时会自动显示此面板。
Name | Type | Description |
---|---|---|
title
|
String | 要在错误面板上显示的标题。此字符串被解释为文本。 |
message
|
String | 可选 在详细错误信息之前显示的有用的、面向用户的消息。此字符串被解释为 HTML。 |
error
|
String |
可选
要在错误面板上显示的错误。此字符串使用
formatError
格式化,然后显示为文本。
|