CesiumWidget

new Cesium.CesiumWidget (container, options )

一个包含 Cesium 场景的小部件。
Name Type Description
container Element | String 将包含小部件的 DOM 元素或 ID。
options Object 具有以下属性的 可选 对象:
姓名 类型 默认 描述
clock new Clock() 可选 用于控制当前时间的时钟。
imageryProvider 图像提供者 | 错误的 createWorldImagery() 可选 用作基础层的图像提供者。如果设置为 false ,则不会添加图像提供者。
terrainProvider 地形提供者 new EllipsoidTerrainProvider 可选 地形提供者。
skyBox 天空盒 | 错误的 可选 用于渲染星星的天空盒。当 undefined 时,使用默认的星星。如果设置为 false ,则不会添加天空盒、太阳或月亮。
skyAtmosphere 天空大气 | 错误的 可选 蓝天,以及地球四肢周围的辉光。设置为 false 将其关闭。
sceneMode 场景模式 SceneMode.SCENE3D 可选 初始场景模式。
scene3DOnly 布尔值 false 可选 true 时,每个几何实例将仅以 3D 呈现以节省 GPU 内存。
orderIndependentTranslucency 布尔值 true 可选 如果为 true 并且配置支持它,请使用与顺序无关的半透明。
mapProjection 地图投影 new GeographicProjection() 可选 在 2D 和哥伦布视图模式中使用的地图投影。
globe 地球仪 | 错误的 new Globe(mapProjection.ellipsoid) 可选 在场景中使用的地球仪。如果设置为 false ,则不会添加地球。
useDefaultRenderLoop 布尔值 true 可选 如果此小部件应控制渲染循环,则为 true,否则为 false。
useBrowserRecommendedResolution 布尔值 true 可选 如果为 true,则以浏览器推荐的分辨率渲染并忽略 window.devicePixelRatio
targetFrameRate 数字 可选 使用默认渲染循环时的目标帧速率。
showRenderLoopErrors 布尔值 true 可选 如果为 true,如果出现渲染循环错误,此小部件将自动向用户显示包含错误的 HTML 面板。
contextOptions 目的 与传递给 Scene options 相对应的 可选 Context 和 WebGL 创建属性。
creditContainer 元素 | 细绳 可选 将包含 CreditDisplay 的 DOM 元素或 ID。如果未指定,积分将添加到小部件本身的底部。
creditViewport 元素 | 细绳 可选 将包含 CreditDisplay 创建的信用弹出窗口的 DOM 元素或 ID。如果未指定,它将出现在小部件本身之上。
shadows 布尔值 false 可选 确定阴影是否由光源投射。
terrainShadows 阴影模式 ShadowMode.RECEIVE_ONLY 可选 确定地形是否投射或接收来自光源的阴影。
mapMode2D MapMode2D MapMode2D.INFINITE_SCROLL 可选 确定 2D 地图是可旋转的还是可以在水平方向上无限滚动。
requestRenderMode 布尔值 false 可选 如果为 true,则仅在需要时才会渲染帧,具体取决于场景中的更改。启用会提高应用程序的性能,但需要使用 Scene#requestRender 在此模式下显式渲染新帧。在对 API 的其他部分中的场景进行更改后,这在许多情况下是必要的。请参阅 使用显式渲染提高性能
maximumRenderTimeChange 数字 0.0 可选 如果 requestRenderMode 为 true,则此值定义在请求渲染之前允许的模拟时间的最大变化。请参阅 使用显式渲染提高性能
msaaSamples 数字 1 可选 如果提供,此值控制多重采样抗锯齿的速率。典型的多重采样率为每像素 2、4 甚至有时 8 个样本。更高的 MSAA 采样率可能会影响性能以换取改进的视觉质量。此值仅适用于支持多样本渲染目标的 WebGL2 上下文。
Throws:
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 canvas : HTMLCanvasElement

获取画布。
获取时钟。
获取父容器。

readonly creditContainer : Element

获取信用容器。

readonly creditViewport : Element

获取信用视口
获取将在地球上呈现的图像图层的集合。
获取或设置渲染分辨率的比例因子。小于 1.0 的值可以提高功能较弱的设备的性能,而大于 1.0 的值将以更高的分辨率渲染,然后按比例缩小,从而提高视觉保真度。例如,如果小部件的布局尺寸为 640x480,则将此值设置为 0.5 将导致场景以 320x240 渲染然后放大,而将其设置为 2.0 将导致场景以 1280x960 渲染然后缩放下。
Default Value: 1.0
获取场景。
获取屏幕空间事件处理程序。
useDefaultRenderLoop 为 true 时,获取或设置小部件的目标帧速率。如果未定义,浏览器的 requestAnimationFrame 实现将确定帧速率。如果已定义,此值必须大于 0。高于底层 requestAnimationFrame 实现的值将无效。
为地球提供表面几何图形的地形提供者。

useBrowserRecommendedResolution : Boolean

指示是否使用浏览器推荐的分辨率的布尔标志。如果为 true,则忽略浏览器的设备像素比并改用 1.0,有效地基于 CSS 像素而不是设备像素进行渲染。这可以提高具有高像素密度的功能较弱的设备的性能。当为 false 时,渲染将以设备像素为单位。 CesiumWidget#resolutionScale 不管这个标志是真还是假都会生效。
Default Value: true

useDefaultRenderLoop : Boolean

获取或设置此小部件是否应控制渲染循环。如果设置为 true,小部件将使用 requestAnimationFrame 来执行小部件的渲染和调整大小,以及驱动模拟时钟。如果设置为 false,您必须手动调用 resize render 方法作为自定义渲染循环的一部分。如果在渲染过程中发生错误,会引发 Scene renderError 事件并且该属性将被设置为 false。错误后必须将其设置回 true 才能继续渲染。

Methods

销毁小部件。如果从布局中永久删除小部件,则应调用。
Returns:
如果对象已被销毁,则为 true,否则为 false。
渲染场景。除非 useDefaultRenderLoop 设置为 false,否则会自动调用此函数;
更新画布大小、相机纵横比和视口大小。此函数会根据需要自动调用,除非 useDefaultRenderLoop 设置为 false。

showErrorPanel (title, message , error )

向用户显示一个错误面板,其中包含标题和更长的错误消息,可以使用 OK 按钮将其关闭。如果在构建小部件时 showRenderLoopErrors 不为假,则发生渲染循环错误时会自动显示此面板。
Name Type Description
title String 要在错误面板上显示的标题。此字符串被解释为文本。
message String 可选 在详细错误信息之前显示的有用的、面向用户的消息。此字符串被解释为 HTML。
error String 可选 要在错误面板上显示的错误。此字符串使用 formatError 格式化,然后显示为文本。