CesiumWidget

new Cesium.CesiumWidget(container, options)

包含铯场景的小部件。
Name Type Description
container Element | String 将包含小部件的DOM元素或ID。
options Object optional 具有以下属性的对象:
Name Type Default Description
clock Clock new Clock() optional 用来控制当前时间的时钟。
imageryProvider ImageryProvider | false createWorldImagery() optional 作为基础层的图像提供者。如果设置为false,则不会添加图像提供程序。
terrainProvider TerrainProvider new EllipsoidTerrainProvider optional 地形提供商。
skyBox SkyBox | false optional 用来渲染星星的天空盒。当undefined时,使用默认的星形。如果设置为false,则不会添加skyBox、太阳或月亮。
skyAtmosphere SkyAtmosphere | false optional 蓝色的天空,以及环绕地球的光辉。设置为false可将其关闭。
sceneMode SceneMode SceneMode.SCENE3D optional 初始场景模式。
scene3DOnly Boolean false optionaltrue时,每个几何体实例将只渲染为3D以节省GPU内存。
orderIndependentTranslucency Boolean true optional 如果为true且配置支持它,请使用与顺序无关的半透明。
mapProjection MapProjection new GeographicProjection() optional 要在二维和哥伦布视图模式中使用的地图投影。
globe Globe | false new Globe(mapProjection.ellipsoid) optional 要在场景中使用的地球仪。如果设置为false,则不会添加任何球体。
useDefaultRenderLoop Boolean true optional 如果此小部件应控制渲染循环,则为True,否则为false。
useBrowserRecommendedResolution Boolean true optional 如果为true,则以浏览器建议的分辨率渲染,并忽略window.devicePixelRatio
targetFrameRate Number optional 使用默认渲染循环时的目标帧速率。
showRenderLoopErrors Boolean true optional 如果为true,则当出现呈现循环错误时,此小部件将自动向用户显示包含错误的HTML面板。
contextOptions Object optionaloptions对应的上下文和WebGL创建属性传递给Scene
creditContainer Element | String optional 将包含CreditDisplay的DOM元素或ID。如果未指定,则增加学分 小部件本身的底部。
creditViewport Element | String optional 将包含CreditDisplay创建的信用弹出窗口的DOM元素或ID。如果没有指定,它将出现在小部件本身的上方。
terrainExaggeration Number 1.0 optional 用来夸大地形的标量。请注意,地形放大不会修改任何其他基本体,因为它们相对于椭球体定位。
shadows Boolean false optional 确定阴影是否由光源投射。
terrainShadows ShadowMode ShadowMode.RECEIVE_ONLY optional 确定地形是投射还是接收来自光源的阴影。
mapMode2D MapMode2D MapMode2D.INFINITE_SCROLL optional 确定二维贴图是可旋转的还是可以在水平方向无限滚动。
requestRenderMode Boolean false optional 如果为true,则仅在需要时渲染帧(由场景中的更改决定)。启用可提高应用程序的性能,但需要使用Scene#requestRender在该模式下显式呈现新帧。在许多情况下,在API的其他部分对场景进行更改后,这是必需的。见Improving Performance with Explicit Rendering
maximumRenderTimeChange Number 0.0 optional 如果requestRenderMode为true,则此值定义请求渲染之前允许的模拟时间的最大更改。见Improving Performance with Explicit Rendering
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.
var widget = new Cesium.CesiumWidget('cesiumContainer');

//Widget with ion imagery and Cesium World Terrain.
var widget = 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 container : Element

获取父容器。

readonly creditContainer : Element

获取信用容器。

readonly creditViewport : Element

获取“信用”视口
获取将在全局上呈现的图像层的集合。

resolutionScale : Number

获取或设置呈现分辨率的比例因子。小于1.0的值可以提高 当值大于1.0时,在功能较弱的设备上的性能将以更高的速度呈现 然后缩小分辨率,从而提高视觉逼真度。 例如,如果小部件的布局尺寸为640x480,则将该值设置为0.5 将导致场景渲染为320x240,然后在设置时按比例放大 将其设置为2.0将导致场景渲染为1280x960,然后按比例缩小。
Default Value: 1.0
得到现场。
获取屏幕空间事件处理程序。

targetFrameRate : Number

useDefaultRenderLoop时,获取或设置小部件的目标帧速率 是真的。如果未定义,则浏览器的requestAnimationFrame实现 确定帧速率。如果已定义,则此值必须大于0。更高的价值 否则,实现将没有底层框架的动画效果。
为地球提供曲面几何图形的地形提供商。

useBrowserRecommendedResolution : Boolean

指示是否使用浏览器建议的分辨率的布尔标志。 如果为true,则忽略浏览器的设备像素比,而使用1.0, 有效地基于CSS像素而不是设备像素进行渲染。这可以改善 在像素密度较高、功能较弱的设备上的性能。如果为false,则渲染 将以设备像素为单位。CesiumWidget#resolutionScale是否仍将生效 此标志为真或假。
Default Value: true

useDefaultRenderLoop : Boolean

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

Methods

销毁小部件。如果是永久性的 正在从布局中删除小部件。

isDestroyed()Boolean

Returns:
如果对象已被销毁,则为true,否则为false。
渲染场景。此函数将自动调用 除非useDefaultRenderLoop设置为false;
更新画布大小、摄影机纵横比和视口大小。 此函数根据需要自动调用,除非 useDefaultRenderLoop设置为false。

showErrorPanel(title, message, error)

向用户显示包含标题和较长错误消息的错误面板, 可以使用“确定”按钮取消。此面板将自动显示 当发生渲染循环错误时,如果showRenderLoopErrors在 小部件被构造。
Name Type Description
title String 要在错误面板上显示的标题。此字符串被解释为文本。
message String optional 在详细错误信息之前显示的一条有用的面向用户的消息。此字符串被解释为HTML。
error String optional 要在错误面板上显示的错误。此字符串使用formatError格式化,然后显示为文本。