org.cesiumjs.cs.widgets

Class CesiumWidget

java.lang.Object

org.cesiumjs.cs.widgets.CesiumWidget

@JsType(isNative=true,
        namespace="Cesium",
        name="CesiumWidget")
public class CesiumWidget
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
com.google.gwt.dom.client.CanvasElement	canvas Gets the canvas.
Clock	clock Gets the clock.
com.google.gwt.dom.client.Element	container Gets the parent container.
com.google.gwt.dom.client.Element	creditContainer Gets the credit container.
double	resolutionScale Gets or sets a scaling factor for rendering resolution.
Scene	scene Gets the scene.
ScreenSpaceEventHandler	screenSpaceEventHandler Gets the screen space event handler.
double	targetFrameRate Gets or sets the target frame rate of the widget when useDefaultRenderLoop is true.
TerrainProvider	terrainProvider The terrain provider providing surface geometry for the globe.
boolean	useDefaultRenderLoop Gets or sets whether or not this widget should control the render loop.

Constructor Summary

Constructors

Constructor and Description
CesiumWidget(com.google.gwt.dom.client.Element container) A widget containing a Cesium scene.
CesiumWidget(com.google.gwt.dom.client.Element container, CesiumWidgetOptions options) A widget containing a Cesium scene.
CesiumWidget(String container) A widget containing a Cesium scene.
CesiumWidget(String container, CesiumWidgetOptions options) A widget containing a Cesium scene.

Method Summary

Modifier and Type	Method and Description
Camera	camera() Gets the camera.
void	destroy() Destroys the widget.
ImageryLayerCollection	imageryLayers() Gets the collection of imagery layers that will be rendered on the globe.
boolean	isDestroyed()
void	render() Renders the scene.
void	resize() Updates the canvas size, camera aspect ratio, and viewport size.
void	showErrorPanel(String title, String message) Show an error panel to the user containing a title and a longer error message, which can be dismissed using an OK button.
void	showErrorPanel(String title, String message, String error) Show an error panel to the user containing a title and a longer error message, which can be dismissed using an OK button.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

canvas

@JsProperty
public com.google.gwt.dom.client.CanvasElement canvas

Gets the canvas.

clock

@JsProperty
public Clock clock

Gets the clock.

container

@JsProperty
public com.google.gwt.dom.client.Element container

Gets the parent container.

creditContainer

@JsProperty
public com.google.gwt.dom.client.Element creditContainer

Gets the credit container.

resolutionScale

@JsProperty
public double resolutionScale

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. Default: 1.0

scene

@JsProperty
public Scene scene

Gets the scene.

screenSpaceEventHandler

@JsProperty
public ScreenSpaceEventHandler screenSpaceEventHandler

Gets the screen space event handler.

targetFrameRate

@JsProperty
public double targetFrameRate

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

@JsProperty
public TerrainProvider terrainProvider

The terrain provider providing surface geometry for the globe.

useDefaultRenderLoop

@JsProperty
public boolean useDefaultRenderLoop

Gets or sets whether or not this widget should control the render loop. If set to 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.

Constructor Detail

CesiumWidget

@JsConstructor
public CesiumWidget(com.google.gwt.dom.client.Element container)

A widget containing a Cesium scene.

Parameters:

container - The DOM element or ID that will contain the widget.

CesiumWidget

@JsConstructor
public CesiumWidget(String container)

A widget containing a Cesium scene.

Parameters:

container - The DOM element or ID that will contain the widget.

CesiumWidget

@JsConstructor
public CesiumWidget(com.google.gwt.dom.client.Element container,
                                   CesiumWidgetOptions options)

A widget containing a Cesium scene.

Parameters:

container - The DOM element or ID that will contain the widget.

options - Options.

CesiumWidget

@JsConstructor
public CesiumWidget(String container,
                                   CesiumWidgetOptions options)

A widget containing a Cesium scene.

Parameters:

container - The DOM element or ID that will contain the widget.

options - Options.

Method Detail

camera

@JsProperty(name="camera")
public Camera camera()

Gets the camera.

imageryLayers

@JsProperty(name="imageryLayers")
public ImageryLayerCollection imageryLayers()

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

destroy

@JsMethod
public void destroy()

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

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns:

true if the object has been destroyed, false otherwise.

render

@JsMethod
public void render()

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

resize

@JsMethod
public void 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

@JsMethod
public void showErrorPanel(String title,
                                     String message)

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.

Parameters:

title - The title to be displayed on the error panel. This string is interpreted as text.

message - A helpful, user-facing message to display prior to the detailed error information. This string is interpreted as HTML.

showErrorPanel

@JsMethod
public void showErrorPanel(String title,
                                     String message,
                                     String error)

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.

Parameters:

title - The title to be displayed on the error panel. This string is interpreted as text.

message - A helpful, user-facing message to display prior to the detailed error information. This string is interpreted as HTML.

error - The error to be displayed on the error panel. This string is formatted using formatError and then displayed as text.