CesiumWidget

new Cesium.CesiumWidget (container, options )

包含Cesium场景的小部件。
Name Type Description
container Element | String 将包含窗口小部件的DOM元素或ID。
options Object optional Object with the following properties:
Name Type Default Description
clock Clock new Clock() 可选 用于控制当前时间的时钟。
imageryProvider ImageryProvider | false createWorldImagery() 可选 图像提供者用作基础层。如果设置为 false ,则不会添加任何图像提供程序。
terrainProvider TerrainProvider new EllipsoidTerrainProvider 可选 地形提供者。
skyBox SkyBox | false 可选 用来渲染星星的天空盒。 undefined (未定义)时,将使用默认星号。如果设置为 false ,则不会添加skyBox,Sun或Moon。
skyAtmosphere SkyAtmosphere | false 可选 蓝天和地球四肢的光芒。设置为 false 将其关闭。
sceneMode SceneMode SceneMode.SCENE3D 可选 初始场景模式。
scene3DOnly Boolean false 可选 如果为 true ,则每个几何实例将仅以3D渲染以节省GPU内存。
orderIndependentTranslucency Boolean true 可选 如果为true并且配置支持它,则使用顺序无关的半透明性。
mapProjection MapProjection new GeographicProjection() 可选 在2D和Columbus View模式下使用的地图投影。
globe Globe | false new Globe(mapProjection.ellipsoid) 可选 场景中使用的地球仪。如果设置为 false ,则不会添加任何地球仪。
useDefaultRenderLoop Boolean true 可选 如果此小部件应控制渲染循环,则为true,否则为false。
useBrowserRecommendedResolution Boolean true 可选 如果为true,则以浏览器建议的分辨率进行渲染,并忽略 window.devicePixelRatio
targetFrameRate Number 可选 使用默认渲染循环时的目标帧速率。
showRenderLoopErrors Boolean true 可选 如果为true,则在发生渲染循环错误时,此小部件将自动向包含错误的用户显示HTML面板。
contextOptions Object 可选 options 相对应的上下文和WebGL创建属性传递给 Scene
creditContainer Element | String 可选 包含 CreditDisplay 的DOM元素或ID。如果未指定,则添加积分 到小部件本身底部。
creditViewport Element | String 可选 包含由 CreditDisplay 创建的弹出窗口的DOM元素或ID。如果未指定,它将显示在小部件本身上。
terrainExaggeration Number 1.0 可选 用于放大地形的标量。请注意,地形夸张不会修改其他相对于椭球的图元。
shadows Boolean false 可选 确定阴影是否由光源投射。
terrainShadows ShadowMode ShadowMode.RECEIVE_ONLY 可选 确定地形是投射还是接收来自光源的阴影。
mapMode2D MapMode2D MapMode2D.INFINITE_SCROLL 可选 确定2D地图是可旋转的还是可以在水平方向无限滚动。
requestRenderMode Boolean false 可选 如果为true,则仅根据场景中的更改确定是否需要渲染帧。启用可以提高应用程序的性能,但需要使用 '> Scene#requestRender 在此模式下显式渲染新框架。在API的其他部分对场景进行更改后,在许多情况下这是必要的。请参见 通过显式渲染提高性能
maximumRenderTimeChange Number 0.0 可选 如果requestRenderMode为true,则此值定义在请求渲染之前允许的最大仿真时间更改。请参见 通过显式渲染提高性能
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.
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 creditContainer : Element

获取信用容器。

readonly creditViewport : Element

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

useBrowserRecommendedResolution : Boolean

布尔标志,指示是否使用浏览器推荐的分辨率。如果为true,则会忽略浏览器的设备像素比率,而改用1.0,根据CSS像素而不是设备像素有效地渲染。这样可以改善在像素密度较高的功能较弱的设备上的性能。如果为假,则渲染将以设备像素为单位。 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 )

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