kotlin-cesium-engine/cesium.engine/CesiumWidget

CesiumWidget

external class CesiumWidget(val container: Element, options: CesiumWidget.ConstructorOptions? = definedExternally)(source)

A widget containing a Cesium scene.

// 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 CesiumWidget("cesiumContainer");

// Widget with ion imagery and Cesium World Terrain.
const widget2 = new CesiumWidget("cesiumContainer", {
    baseLayer: ImageryLayer.fromWorldTerrain(),
    terrain: Terrain.fromWorldTerrain()
    skyBox: new 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: SceneMode.COLUMBUS_VIEW,
    mapProjection: new WebMercatorProjection()
});

Constructors

CesiumWidget

constructor(container: Element, options: CesiumWidget.ConstructorOptions? = definedExternally)

Types

ConstructorOptions

sealed interface ConstructorOptions

Properties

camera

val camera: Camera

Gets the camera.

canvas

val canvas: HTMLCanvasElement

Gets the canvas.

clock

val clock: Clock

Gets the clock.

container

val container: Element

The DOM element that will contain the widget.

creditContainer

val creditContainer: Element

Gets the credit container.

creditDisplay

var creditDisplay: CreditDisplay

Manages the list of credits to display on screen and in the lightbox.

creditViewport

val creditViewport: Element

Gets the credit viewport

ellipsoid

val ellipsoid: Ellipsoid

Gets the default ellipsoid for the scene.

imageryLayers

val imageryLayers: ImageryLayerCollection

Gets the collection of image layers that will be rendered on the globe.

resolutionScale

var resolutionScale: Double

Gets or sets a scaling factor for rendering resolution. Values less than 1.0 can improve performance on less powerful devices while values greater than 1.0 will render at a higher resolution and then scale down, resulting in improved visual fidelity. For example, if the widget is laid out at a size of 640x480, setting this value to 0.5 will cause the scene to be rendered at 320x240 and then scaled up while setting it to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down.

scene

val scene: Scene

Gets the scene.

screenSpaceEventHandler

val screenSpaceEventHandler: ScreenSpaceEventHandler

Gets the screen space event handler.

targetFrameRate

var targetFrameRate: Int

Gets or sets the target frame rate of the widget when useDefaultRenderLoop is true. If undefined, the browser's requestAnimationFrame implementation determines the frame rate. If defined, this value must be greater than 0. A value higher than the underlying requestAnimationFrame implementation will have no effect.

terrainProvider

var terrainProvider: TerrainProvider

The terrain provider providing surface geometry for the globe.

useBrowserRecommendedResolution

var useBrowserRecommendedResolution: Boolean

Boolean flag indicating if the browser's recommended resolution is used. If true, the browser's device pixel ratio is ignored and 1.0 is used instead, effectively rendering based on CSS pixels instead of device pixels. This can improve performance on less powerful devices that have high pixel density. When false, rendering will be in device pixels. CesiumWidget.resolutionScale will still take effect whether this flag is true or false.

useDefaultRenderLoop

var useDefaultRenderLoop: Boolean

Gets or sets whether or not this widget should control the render loop. If true the widget will use requestAnimationFrame to perform rendering and resizing of the widget, as well as drive the simulation clock. If set to false, you must manually call the resize, render methods as part of a custom render loop. If an error occurs during rendering, Scene's renderError event will be raised and this property will be set to false. It must be set back to true to continue rendering after the error.

Functions

destroy

fun destroy()

Destroys the widget. Should be called if permanently removing the widget from layout.

isDestroyed

fun isDestroyed(): Boolean

render

fun render()

Renders the scene. This function is called automatically unless useDefaultRenderLoop is set to false;

resize

fun resize()

Updates the canvas size, camera aspect ratio, and viewport size. This function is called automatically as needed unless useDefaultRenderLoop is set to false.

showErrorPanel

fun showErrorPanel(title: String, message: String? = definedExternally, error: String? = definedExternally)

Show an error panel to the user containing a title and a longer error message, which can be dismissed using an OK button. This panel is displayed automatically when a render loop error occurs, if showRenderLoopErrors was not false when the widget was constructed.

CesiumWidget

See also

Constructors

Types

Properties

Functions