org.cesiumjs.cs

Class Cesium

java.lang.Object

org.cesiumjs.cs.Cesium

public class Cesium
extends Object

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cesium.CreateWorldTerrainOptions
static class	Cesium.ExportKmlOptions Options for exportKml(ExportKmlOptions)
static interface	Cesium.Function
static interface	Cesium.RequestAnimationFrameCallback

Constructor Summary

Constructors

Constructor and Description
Cesium()

Method Summary

Modifier and Type	Method and Description
static String	buildModuleUrl(String moduleId) Given a non-relative moduleID, returns an absolute URL to the file represented by that module ID, using, in order of preference, require.toUrl, the value of a global CESIUM_BASE_URL, or the base URL of the Cesium.js script.
static void	cancelAnimationFrame(Number requestID) A browser-independent function to cancel an animation frame requested using requestAnimationFrame.
static Command	createCommand(Cesium.Function func) Create a Command from a given function, for use with ViewModels.
static Command	createCommand(Cesium.Function func, boolean canExecute) Create a Command from a given function, for use with ViewModels.
static UrlTemplateImageryProvider	createOpenStreetMapImageryProvider() Creates a UrlTemplateImageryProvider instance that provides tiled imagery hosted by OpenStreetMap or another provider of Slippy tiles.
static UrlTemplateImageryProvider	createOpenStreetMapImageryProvider(OpenStreetMapImageryProviderOptions options) Creates a UrlTemplateImageryProvider instance that provides tiled imagery hosted by OpenStreetMap or another provider of Slippy tiles.
static UrlTemplateImageryProvider	createOpenStreetMapImageryProvider(String url)
static UrlTemplateImageryProvider	createTileMapServiceImageryProvider() Creates a UrlTemplateImageryProvider instance that provides tiled imagery as generated by GDDAL2Tiles etc.
static UrlTemplateImageryProvider	createTileMapServiceImageryProvider(String url)
static UrlTemplateImageryProvider	createTileMapServiceImageryProvider(TileMapServiceImageryProviderOptions options) Creates a UrlTemplateImageryProvider instance that provides tiled imagery as generated by GDDAL2Tiles etc.
static CesiumTerrainProvider	createWorldTerrain() Creates a CesiumTerrainProvider instance for the Cesium World Terrain.
static CesiumTerrainProvider	createWorldTerrain(Cesium.CreateWorldTerrainOptions options) Creates a CesiumTerrainProvider instance for the Cesium World Terrain.
static boolean	defined(Object object)
static void	destroyObject(Object object) Destroys an object.
static void	destroyObject(Object object, String message) Destroys an object.
static Promise<JsObject,Void>	exportKml(Cesium.ExportKmlOptions options) Exports an EntityCollection as a KML document.
static void	fixSmartGWT() Fix for SmartGWT Thanks for Mark Erikson (https://groups.google.com/forum/#!
static boolean	isInitialized()
static void	log(Object object)
static String	path()
static Number	requestAnimationFrame(Cesium.RequestAnimationFrameCallback callback) A browser-independent function to request a new animation frame.
static Promise<Cartographic[],Void>	sampleTerrain(TerrainProvider terrainProvider, int level, Cartographic[] positions) Initiates a terrain height query for an array of Cartographic positions by requesting tiles from a terrain provider, sampling, and interpolating.
static Promise<Cartographic[],Void>	sampleTerrainMostDetailed(TerrainProvider terrainProvider, Cartographic[] positions) Initiates a sampleTerrain() request at the maximum available tile level for a terrain dataset.
static String	version()

Methods inherited from class java.lang.Object

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

Constructor Detail

Cesium

public Cesium()

Method Detail

isInitialized

@JsProperty(namespace="<global>",
            name="Cesium")
public static boolean isInitialized()

version

@JsProperty(namespace="Cesium",
            name="VERSION")
public static String version()

path

@JsProperty(namespace="<global>",
            name="CesiumPath")
public static String path()

log

public static void log(Object object)

fixSmartGWT

public static void fixSmartGWT()

Fix for SmartGWT Thanks for Mark Erikson (https://groups.google.com/forum/#!msg/cesium-dev/ZfyW0CNRsSU/lP6KTaUpEQAJ)

buildModuleUrl

@JsMethod(namespace="Cesium",
          name="buildModuleUrl")
public static String buildModuleUrl(String moduleId)

Given a non-relative moduleID, returns an absolute URL to the file represented by that module ID, using, in order of preference, require.toUrl, the value of a global CESIUM_BASE_URL, or the base URL of the Cesium.js script.

defined

@JsMethod(namespace="Cesium")
public static boolean defined(Object object)

sampleTerrain

@JsMethod(namespace="Cesium",
          name="sampleTerrain")
public static Promise<Cartographic[],Void> sampleTerrain(TerrainProvider terrainProvider,
                                                                                                                       int level,
                                                                                                                       Cartographic[] positions)

Initiates a terrain height query for an array of Cartographic positions by requesting tiles from a terrain provider, sampling, and interpolating. The interpolation matches the triangles used to render the terrain at the specified level. The query happens asynchronously, so this function returns a promise that is resolved when the query completes. Each point height is modified in place. If a height can not be determined because no terrain data is available for the specified level at that location, or another error occurs, the height is set to undefined. As is typical of the Cartographic type, the supplied height is a height above the reference ellipsoid (such as Ellipsoid.WGS84()) rather than an altitude above mean sea level. In other words, it will not necessarily be 0.0 if sampled in the ocean.

Parameters:

terrainProvider - The terrain provider from which to query heights.

level - The terrain level-of-detail from which to query terrain heights.

positions - The positions to update with terrain heights.

Returns:

A promise that resolves to the provided list of positions when terrain the query has completed.

createOpenStreetMapImageryProvider

@JsMethod(namespace="Cesium",
          name="createOpenStreetMapImageryProvider")
public static UrlTemplateImageryProvider createOpenStreetMapImageryProvider()

Creates a UrlTemplateImageryProvider instance that provides tiled imagery hosted by OpenStreetMap or another provider of Slippy tiles. The default url connects to OpenStreetMap's volunteer-run servers, so you must conform to their Tile Usage Policy.

Returns:

The imagery provider.

createOpenStreetMapImageryProvider

@JsMethod(namespace="Cesium",
          name="createOpenStreetMapImageryProvider")
public static UrlTemplateImageryProvider createOpenStreetMapImageryProvider(OpenStreetMapImageryProviderOptions options)

Creates a UrlTemplateImageryProvider instance that provides tiled imagery hosted by OpenStreetMap or another provider of Slippy tiles. The default url connects to OpenStreetMap's volunteer-run servers, so you must conform to their Tile Usage Policy.

Parameters:

options - Options

Returns:

The imagery provider.

createOpenStreetMapImageryProvider

public static UrlTemplateImageryProvider createOpenStreetMapImageryProvider(String url)

createTileMapServiceImageryProvider

@JsMethod(namespace="Cesium",
          name="createTileMapServiceImageryProvider")
public static UrlTemplateImageryProvider createTileMapServiceImageryProvider()

Creates a UrlTemplateImageryProvider instance that provides tiled imagery as generated by GDDAL2Tiles etc.

Returns:

The imagery provider.

createTileMapServiceImageryProvider

@JsMethod(namespace="Cesium",
          name="createTileMapServiceImageryProvider")
public static UrlTemplateImageryProvider createTileMapServiceImageryProvider(TileMapServiceImageryProviderOptions options)

Creates a UrlTemplateImageryProvider instance that provides tiled imagery as generated by GDDAL2Tiles etc.

Parameters:

options - Options

Returns:

The imagery provider.

createTileMapServiceImageryProvider

public static UrlTemplateImageryProvider createTileMapServiceImageryProvider(String url)

createCommand

@JsMethod(namespace="Cesium",
          name="createCommand")
public static Command createCommand(Cesium.Function func)

Create a Command from a given function, for use with ViewModels. A Command is a function with an extra canExecute observable property to determine whether the command can be executed. When executed, a Command function will check the value of canExecute and throw if false. It also provides events for when a command has been or is about to be executed.

Parameters:

func - The function to execute.

Returns:

Command function

createCommand

@JsMethod(namespace="Cesium",
          name="createCommand")
public static Command createCommand(Cesium.Function func,
                                                                                                  boolean canExecute)

Create a Command from a given function, for use with ViewModels. A Command is a function with an extra canExecute observable property to determine whether the command can be executed. When executed, a Command function will check the value of canExecute and throw if false. It also provides events for when a command has been or is about to be executed.

Parameters:

func - The function to execute.

canExecute - A boolean indicating whether the function can currently be executed.

Returns:

Command function

requestAnimationFrame

@JsMethod(namespace="Cesium",
          name="requestAnimationFrame")
public static Number requestAnimationFrame(Cesium.RequestAnimationFrameCallback callback)

A browser-independent function to request a new animation frame. This is used to create an application's draw loop as shown in the example below.

Parameters:

callback - The function to call when the next frame should be drawn.

Returns:

An ID that can be passed to cancelAnimationFrame(java.lang.Number) to cancel the request.

cancelAnimationFrame

@JsMethod(namespace="Cesium",
          name="cancelAnimationFrame")
public static void cancelAnimationFrame(Number requestID)

A browser-independent function to cancel an animation frame requested using requestAnimationFrame.

Parameters:

requestID - The value returned by requestAnimationFrame.

sampleTerrainMostDetailed

@JsMethod(namespace="Cesium",
          name="sampleTerrainMostDetailed")
public static Promise<Cartographic[],Void> sampleTerrainMostDetailed(TerrainProvider terrainProvider,
                                                                                                                                               Cartographic[] positions)

Initiates a sampleTerrain() request at the maximum available tile level for a terrain dataset.

Parameters:

terrainProvider - The terrain provider from which to query heights.

positions - The positions to update with terrain heights.

Returns:

A promise that resolves to the provided list of positions when terrain the query has completed. This promise will reject if the terrain provider's `availability` property is undefined.

     Example:
     
     CesiumTerrainProviderOptions options = new CesiumTerrainProviderOptions();
     options.url = "https://assets.agi.com/stk-terrain/world";
     CesiumTerrainProvider terrainProvider = new CesiumTerrainProvider(options);
     Cartographic[] positions = new Cartographic[] {Cartographic.fromDegrees(86.925145, 27.988257), Cartographic.fromDegrees(87.0, 28.0)};
     Promise<Cartographic[], Void> promise = Cesium.sampleTerrainMostDetailed(terrainProvider, positions);
     promise.then(new Fulfill<Cartographic[]>() {
         {@literal @}Override
         public void onFulfilled(Cartographic[] updatedPositions) {
             //
         }
     });
     
 

destroyObject

@JsMethod(namespace="Cesium",
          name="destroyObject")
public static void destroyObject(Object object)

Destroys an object. Each of the object's functions, including functions in its prototype, is replaced with a function that throws a DeveloperError, except for the object's isDestroyed function, which is set to a function that returns true. The object's properties are removed with delete. This function is used by objects that hold native resources, e.g., WebGL resources, which need to be explicitly released. Client code calls an object's destroy function, which then releases the native resource and calls destroyObject to put itself in a destroyed state.

Parameters:

object - The object to destroy.

destroyObject

@JsMethod(namespace="Cesium",
          name="destroyObject")
public static void destroyObject(Object object,
                                                                                               String message)

Destroys an object. Each of the object's functions, including functions in its prototype, is replaced with a function that throws a DeveloperError, except for the object's isDestroyed function, which is set to a function that returns true. The object's properties are removed with delete. This function is used by objects that hold native resources, e.g., WebGL resources, which need to be explicitly released. Client code calls an object's destroy function, which then releases the native resource and calls destroyObject to put itself in a destroyed state.

Parameters:

object - The object to destroy.

message - The message to include in the exception that is thrown if a destroyed object's function is called.

createWorldTerrain

@JsMethod(namespace="Cesium",
          name="createWorldTerrain")
public static CesiumTerrainProvider createWorldTerrain()

Creates a CesiumTerrainProvider instance for the Cesium World Terrain.

Returns:

CesiumTerrainProvider instance for the Cesium World Terrain.

createWorldTerrain

@JsMethod(namespace="Cesium",
          name="createWorldTerrain")
public static CesiumTerrainProvider createWorldTerrain(Cesium.CreateWorldTerrainOptions options)

Creates a CesiumTerrainProvider instance for the Cesium World Terrain.

Parameters:

options - Cesium.CreateWorldTerrainOptions object.

Returns:

CesiumTerrainProvider instance for the Cesium World Terrain.

exportKml

@JsMethod(namespace="Cesium",
          name="exportKml")
public static Promise<JsObject,Void> exportKml(Cesium.ExportKmlOptions options)

Exports an EntityCollection as a KML document. Only Point, Billboard, Model, Path, Polygon, Polyline geometries will be exported. Note that there is not a 1 to 1 mapping of Entity properties to KML Feature properties. For example, entity properties that are time dynamic but cannot be dynamic in KML are exported with their values at options.time or the beginning of the EntityCollection's time interval if not specified. For time-dynamic properties that are supported in KML, we use the samples if it is a SampledProperty otherwise we sample the value using the options.sampleDuration. Point, Billboard, Model and Path geometries with time-dynamic positions will be exported as gx:Track Features. Not all Materials are representable in KML, so for more advanced Materials just the primary color is used. Canvas objects are exported as PNG images.

Parameters:

options - object with properties

Returns:

A promise that resolved to an object containing the KML string and a dictionary of external file blobs, or a kmz file as a blob if options.kmz is true.