Globe (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.scene.Globe

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

Author:: Serge Silaev aka iSergio

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`atmosphereBrightnessShift` The brightness shift to apply to the atmosphere.
`double`	`atmosphereHueShift` The hue shift to apply to the atmosphere.
`double`	`atmosphereSaturationShift` The saturation shift to apply to the atmosphere.
`Color`	`baseColor` Gets or sets the color of the globe when no imagery is available.
`Rectangle`	`cartographicLimitRectangle` Use this to limit terrain and imagery to a specific Rectangle area.
`ClippingPlaneCollection`	`clippingPlanes` The `ClippingPlaneCollection` used to selectively disable rendering the tileset.
`boolean`	`depthTestAgainstTerrain` True if primitives such as billboards, polylines, labels, etc. should be depth-tested against the terrain surface, or false if such primitives should always be drawn on top of terrain unless they're on the opposite side of the globe.
`Ellipsoid`	`ellipsoid` Gets an ellipsoid describing the shape of this globe.
`boolean`	`enableLighting` Enable lighting the globe with the sun as a light source.
`ImageryLayerCollection`	`imageryLayers` Gets the collection of imagery layers that will be rendered on this globe.
`double`	`lightingFadeInDistance` The distance where lighting resumes.
`double`	`lightingFadeOutDistance` The distance where everything becomes lit.
`Material`	`material` Gets or sets the material appearance of the Globe.
`double`	`maximumScreenSpaceError` The maximum screen-space error used to drive level-of-detail refinement.
`double`	`nightFadeInDistance` The distance where the darkness of night from the ground atmosphere fades in to an unlit ground atmosphere.
`double`	`nightFadeOutDistance` The distance where the darkness of night from the ground atmosphere fades out to a lit ground atmosphere.
`String`	`oceanNormalMapUrl` The normal map to use for rendering waves in the ocean.
`Number`	`shadows` Determines whether the globe casts or receives shadows from each light source.
`boolean`	`show` Determines if the globe will be shown.
`boolean`	`showGroundAtmosphere` Enable the ground atmosphere.
`boolean`	`showWaterEffect` True if an animated wave effect should be shown in areas of the globe covered by water; otherwise, false.
`TerrainProvider`	`terrainProvider` The terrain provider providing surface geometry for this globe.
`int`	`tileCacheSize` The size of the terrain tile cache, expressed as a number of tiles.
`Event`	`tileLoadProgressEvent` Gets an event that's raised when the length of the tile load queue has changed since the last render frame.

Constructor Summary

Constructors
Constructor and Description

Globe()

Globe(Ellipsoid ellipsoid)

Constructors
Constructor and Description
`Globe()`
`Globe(Ellipsoid ellipsoid)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroys the WebGL resources held by this object.
`double`	`getHeight(Cartographic cartographic)` Get the height of the surface at a given cartographic.
`Event`	`imageryLayersUpdatedEvent()` Gets an event that's raised when an imagery layer is added, shown, hidden, moved, or removed.
`boolean`	`isDestroyed()` Returns true if this object was destroyed; otherwise, false.
`Cartesian3`	`pick(Ray ray, Scene scene)` Find an intersection between a ray and the globe surface that was rendered.
`Cartesian3`	`pick(Ray ray, Scene scene, Cartesian3 result)` Find an intersection between a ray and the globe surface that was rendered.
`Event`	`terrainProviderChanged()` Gets an event that's raised when the terrain provider is changed
`boolean`	`tilesLoaded()` Returns true when the tile load queue is empty, false otherwise.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - atmosphereBrightnessShift
```
@JsProperty
public double atmosphereBrightnessShift
```
    The brightness shift to apply to the atmosphere. Defaults to 0.0 (no shift). A brightness shift of -1.0 is complete darkness, which will let space show through. Default: 0.0
  - atmosphereHueShift
```
@JsProperty
public double atmosphereHueShift
```
    The hue shift to apply to the atmosphere. Defaults to 0.0 (no shift). A hue shift of 1.0 indicates a complete rotation of the hues available. Default: 0.0
  - atmosphereSaturationShift
```
@JsProperty
public double atmosphereSaturationShift
```
    The saturation shift to apply to the atmosphere. Defaults to 0.0 (no shift). A saturation shift of -1.0 is monochrome. Default: 0.0
  - baseColor
```
@JsProperty
public Color baseColor
```
    Gets or sets the color of the globe when no imagery is available.
  - clippingPlanes
```
@JsProperty
public ClippingPlaneCollection clippingPlanes
```
    The ClippingPlaneCollection used to selectively disable rendering the tileset. Clipping planes are not currently supported in Internet Explorer.
  - cartographicLimitRectangle
```
@JsProperty
public Rectangle cartographicLimitRectangle
```
    Use this to limit terrain and imagery to a specific Rectangle area.
  - depthTestAgainstTerrain
```
@JsProperty
public boolean depthTestAgainstTerrain
```
    True if primitives such as billboards, polylines, labels, etc. should be depth-tested against the terrain surface, or false if such primitives should always be drawn on top of terrain unless they're on the opposite side of the globe. The disadvantage of depth testing primitives against terrain is that slight numerical noise or terrain level-of-detail switched can sometimes make a primitive that should be on the surface disappear underneath it. Default: false.
  - ellipsoid
```
@JsProperty
public Ellipsoid ellipsoid
```
    Gets an ellipsoid describing the shape of this globe.
  - enableLighting
```
@JsProperty
public boolean enableLighting
```
    Enable lighting the globe with the sun as a light source. Default: false
  - imageryLayers
```
@JsProperty
public ImageryLayerCollection imageryLayers
```
    Gets the collection of imagery layers that will be rendered on this globe.
  - lightingFadeInDistance
```
@JsProperty
public double lightingFadeInDistance
```
    The distance where lighting resumes. This only takes effect when enableLighting is true. Default: 9000000.0
  - lightingFadeOutDistance
```
@JsProperty
public double lightingFadeOutDistance
```
    The distance where everything becomes lit. This only takes effect when enableLighting is true. Default: 6500000.0
  - material
```
@JsProperty
public Material material
```
    Gets or sets the material appearance of the Globe. This can be one of several built-in Material objects or a custom material, scripted with Fabric.
  - maximumScreenSpaceError
```
@JsProperty
public double maximumScreenSpaceError
```
    The maximum screen-space error used to drive level-of-detail refinement. Higher values will provide better performance but lower visual quality. Default Value: 2
  - nightFadeInDistance
```
@JsProperty
public double nightFadeInDistance
```
    The distance where the darkness of night from the ground atmosphere fades in to an unlit ground atmosphere. This only takes effect when showGroundAtmosphere and enableLighting are true. Default: 50000000.0
  - nightFadeOutDistance
```
@JsProperty
public double nightFadeOutDistance
```
    The distance where the darkness of night from the ground atmosphere fades out to a lit ground atmosphere. This only takes effect when showGroundAtmosphere and enableLighting are true. Default: 10000000.0
  - oceanNormalMapUrl
```
@JsProperty
public String oceanNormalMapUrl
```
    The normal map to use for rendering waves in the ocean. Setting this property will only have an effect if the configured terrain provider includes a water mask. Default: buildModuleUrl('Assets/Textures/waterNormalsSmall.jpg')
  - shadows
```
@JsProperty
public Number shadows
```
    Determines whether the globe casts or receives shadows from each light source. Setting the globe to cast shadows may impact performance since the terrain is rendered again from the light's perspective. Currently only terrain that is in view casts shadows. By default the globe does not cast shadows. Default: ShadowMode.RECEIVE_ONLY
  - show
```
@JsProperty
public boolean show
```
    Determines if the globe will be shown. Default: true
  - showGroundAtmosphere
```
@JsProperty
public boolean showGroundAtmosphere
```
    Enable the ground atmosphere. Default: true
  - showWaterEffect
```
@JsProperty
public boolean showWaterEffect
```
    True if an animated wave effect should be shown in areas of the globe covered by water; otherwise, false. This property is ignored if the terrainProvider does not provide a water mask. Default: true
  - terrainProvider
```
@JsProperty
public TerrainProvider terrainProvider
```
    The terrain provider providing surface geometry for this globe.
  - tileCacheSize
```
@JsProperty
public int tileCacheSize
```
    The size of the terrain tile cache, expressed as a number of tiles. Any additional tiles beyond this number will be freed, as long as they aren't needed for rendering this frame. A larger number will consume more memory but will show detail faster when, for example, zooming out and then back in. Default: 100
  - tileLoadProgressEvent
```
@JsProperty
public Event tileLoadProgressEvent
```
    Gets an event that's raised when the length of the tile load queue has changed since the last render frame. When the load queue is empty, all terrain and imagery for the current view have been loaded. The event passes the new length of the tile load queue.
- Constructor Detail
  - Globe
```
@JsConstructor
public Globe()
```
  - Globe
```
@JsConstructor
public Globe(Ellipsoid ellipsoid)
```
- Method Detail
  - imageryLayersUpdatedEvent
```
@JsProperty(name="imageryLayersUpdatedEvent")
public Event imageryLayersUpdatedEvent()
```
    Gets an event that's raised when an imagery layer is added, shown, hidden, moved, or removed.
  - terrainProviderChanged
```
@JsProperty(name="terrainProviderChanged")
public Event terrainProviderChanged()
```
    Gets an event that's raised when the terrain provider is changed
  - tilesLoaded
```
@JsMethod(name="tilesLoaded")
public boolean tilesLoaded()
```
    Returns true when the tile load queue is empty, false otherwise. When the load queue is empty, all terrain and imagery for the current view have been loaded.
  - destroy
```
@JsMethod
public void destroy()
```
    Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
    
    See Also:
    
    isDestroyed()
  - getHeight
```
@JsMethod
public double getHeight(Cartographic cartographic)
```
    Get the height of the surface at a given cartographic.
    
    Parameters:
    
    cartographic -
    
    Returns:
    
    The cartographic for which to find the height.
  - isDestroyed
```
@JsMethod
public boolean isDestroyed()
```
    Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
    
    Returns:
    
    True if this object was destroyed; otherwise, false.
    
    See Also:
    
    destroy()
  - pick
```
@JsMethod
public Cartesian3 pick(Ray ray,
                                 Scene scene)
```
    Find an intersection between a ray and the globe surface that was rendered. The ray must be given in world coordinates.
```
     
     // find intersection of ray through a pixel and the globe
     Ray ray = viewer.camera.getPickRay(windowCoordinates);
     Cartesian3 intersection = globe.pick(ray, scene);
     
 
```
    Parameters:
    
    ray - The ray to test for intersection.
    
    scene - The scene.
    
    Returns:
    
    The intersection or undefined if none was found.
  - pick
```
@JsMethod
public Cartesian3 pick(Ray ray,
                                 Scene scene,
                                 Cartesian3 result)
```
    Find an intersection between a ray and the globe surface that was rendered. The ray must be given in world coordinates.
```
     
     // find intersection of ray through a pixel and the globe
     Ray ray = viewer.camera.getPickRay(windowCoordinates);
     Cartesian3 intersection = globe.pick(ray, scene);
     
 
```
    Parameters:
    
    ray - The ray to test for intersection.
    
    scene - The scene.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The intersection or undefined if none was found.

Class Globe

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

atmosphereBrightnessShift

atmosphereHueShift

atmosphereSaturationShift

baseColor

clippingPlanes

cartographicLimitRectangle

depthTestAgainstTerrain

ellipsoid

enableLighting

imageryLayers

lightingFadeInDistance

lightingFadeOutDistance

material

maximumScreenSpaceError

nightFadeInDistance

nightFadeOutDistance

oceanNormalMapUrl

shadows

show

showGroundAtmosphere

showWaterEffect

terrainProvider

tileCacheSize

tileLoadProgressEvent

Constructor Detail

Globe

Globe

Method Detail

imageryLayersUpdatedEvent

terrainProviderChanged

tilesLoaded

destroy

getHeight

isDestroyed

pick

pick