org.cesiumjs.cs.widgets.options

Class CesiumWidgetOptions

java.lang.Object

org.cesiumjs.cs.widgets.options.CesiumWidgetOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class CesiumWidgetOptions
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Clock	clock The clock to use to control current time.
Object	contextOptions Context and WebGL creation properties corresponding to options passed to Scene.
com.google.gwt.dom.client.Element	creditContainer The DOM element or ID that will contain the CreditDisplay.
Globe	globe The globe to use in the scene.
ImageryProvider	imageryProvider The imagery provider to serve as the base layer.
int	mapMode2D Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
MapProjection	mapProjection The map projection to use in 2D and Columbus View modes.
SceneMode	sceneMode The initial scene mode.
boolean	shadows Determines if shadows are cast by the sun.
boolean	showRenderLoopErrors If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
SkyAtmosphere	skyAtmosphere Blue sky, and the glow around the Earth's limb.
SkyBox	skyBox The skybox used to render the stars.
double	targetFrameRate The target frame rate when using the default render loop.
double	terrainExaggeration A scalar used to exaggerate the terrain.
TerrainProvider	terrainProvider The terrain provider.
int	terrainShadows Determines if the terrain casts or receives shadows from the sun.
boolean	useDefaultRenderLoop True if this widget should control the render loop, false otherwise.

Constructor Summary

Constructors

Constructor and Description
CesiumWidgetOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

clock

@JsProperty
public Clock clock

The clock to use to control current time.

imageryProvider

@JsProperty
public ImageryProvider imageryProvider

The imagery provider to serve as the base layer. If set to false, no imagery provider will be added. Default: new BingMapsImageryProvider()

terrainProvider

@JsProperty
public TerrainProvider terrainProvider

The terrain provider. Defaults: new EllipsoidTerrainProvider

skyBox

@JsProperty
public SkyBox skyBox

The skybox used to render the stars. When undefined, the default stars are used. If set to false, no skyBox, Sun, or Moon will be added.

skyAtmosphere

@JsProperty
public SkyAtmosphere skyAtmosphere

Blue sky, and the glow around the Earth's limb. Set to false to turn it off.

sceneMode

@JsProperty
public SceneMode sceneMode

The initial scene mode. Default: SceneMode.SCENE3D

mapProjection

@JsProperty
public MapProjection mapProjection

The map projection to use in 2D and Columbus View modes. Default: new GeographicProjection()

globe

@JsProperty
public Globe globe

The globe to use in the scene. If set to false, no globe will be added. Default: new Globe(mapProjection.ellipsoid)

useDefaultRenderLoop

@JsProperty
public boolean useDefaultRenderLoop

True if this widget should control the render loop, false otherwise. Default: true

targetFrameRate

@JsProperty
public double targetFrameRate

The target frame rate when using the default render loop.

showRenderLoopErrors

@JsProperty
public boolean showRenderLoopErrors

If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. Default: true

contextOptions

@JsProperty
public Object contextOptions

Context and WebGL creation properties corresponding to options passed to Scene.

creditContainer

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

The DOM element or ID that will contain the CreditDisplay. If not specified, the credits are added to the bottom of the widget itself.

terrainExaggeration

@JsProperty
public double terrainExaggeration

A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. Default: 1.0

shadows

@JsProperty
public boolean shadows

Determines if shadows are cast by the sun. Default: false

terrainShadows

@JsProperty
public int terrainShadows

Determines if the terrain casts or receives shadows from the sun. Default: ShadowMode.RECEIVE_ONLY

mapMode2D

@JsProperty
public int mapMode2D

Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. Default: MapMode2D.INFINITE_SCROLL

Constructor Detail

CesiumWidgetOptions

@JsConstructor
public CesiumWidgetOptions()