org.cesiumjs.cs.core.providers

Class CesiumTerrainProvider

java.lang.Object

org.cesiumjs.cs.core.providers.CesiumTerrainProvider

All Implemented Interfaces:

TerrainProvider

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
TileAvailability	availability Gets an object that can be used to determine availability of terrain from this provider, such as at points and in rectangles.
Credit	credit Gets the credit to display when this terrain provider is active.
Event	errorEvent Gets an event that is raised when the terrain provider encounters an asynchronous error..
boolean	hasVertexNormals Gets a value indicating whether or not the requested tiles include vertex normals.
boolean	hasWaterMask Gets a value indicating whether or not the provider includes a water mask.
boolean	ready Gets a value indicating whether or not the provider is ready for use.
boolean	requestVertexNormals Boolean flag that indicates if the client should request vertex normals from the server.
boolean	requestWaterMask Boolean flag that indicates if the client should request a watermask from the server.
GeographicTilingScheme	tilingScheme Gets the tiling scheme used by this provider.

Constructor Summary

Constructors

Constructor and Description
CesiumTerrainProvider(CesiumTerrainProviderOptions options) A TerrainProvider that access terrain data in a Cesium terrain format.

Method Summary

Modifier and Type	Method and Description
double	getLevelMaximumGeometricError(int level) Gets the maximum geometric error allowed in a tile at a given level.
boolean	getTileDataAvailable(int x, int y, int level) Determines whether data for a tile is available to be loaded.
Promise<Boolean,Void>	readyPromise() Gets a promise that resolves to true when the provider is ready for use.
Promise<TerrainData,Void>	requestTileGeometry(int x, int y, int level, Request request) Requests the geometry for a given tile.

Methods inherited from class java.lang.Object

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

Field Detail

availability

@JsProperty
public TileAvailability availability

Gets an object that can be used to determine availability of terrain from this provider, such as at points and in rectangles. This function should not be called before ready returns true. This property may be undefined if availability information is not available.

credit

@JsProperty
public Credit credit

Gets the credit to display when this terrain provider is active. Typically this is used to credit the source of the terrain. This function should not be called before ready returns true.

errorEvent

@JsProperty
public Event errorEvent

Gets an event that is raised when the terrain provider encounters an asynchronous error.. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

hasVertexNormals

@JsProperty
public boolean hasVertexNormals

Gets a value indicating whether or not the requested tiles include vertex normals. This function should not be called before ready returns true.

hasWaterMask

@JsProperty
public boolean hasWaterMask

Gets a value indicating whether or not the provider includes a water mask. The water mask indicates which areas of the globe are water rather than land, so they can be rendered as a reflective surface with animated waves. This function should not be called before TerrainProvider#ready returns true.

ready

@JsProperty
public boolean ready

Gets a value indicating whether or not the provider is ready for use.

requestVertexNormals

@JsProperty
public boolean requestVertexNormals

Boolean flag that indicates if the client should request vertex normals from the server. Vertex normals data is appended to the standard tile mesh data only if the client requests the vertex normals and if the server provides vertex normals.

requestWaterMask

@JsProperty
public boolean requestWaterMask

Boolean flag that indicates if the client should request a watermask from the server. Watermask data is appended to the standard tile mesh data only if the client requests the watermask and if the server provides a watermask.

tilingScheme

@JsProperty
public GeographicTilingScheme tilingScheme

Gets the tiling scheme used by this provider. This function should not be called before ready returns true.

Constructor Detail

CesiumTerrainProvider

@JsConstructor
public CesiumTerrainProvider(CesiumTerrainProviderOptions options)

A TerrainProvider that access terrain data in a Cesium terrain format. The format is described on the Cesium wiki.

Parameters:

options -

Method Detail

readyPromise

@JsProperty(name="readyPromise")
public Promise<Boolean,Void> readyPromise()

Gets a promise that resolves to true when the provider is ready for use.

getLevelMaximumGeometricError

@JsMethod
public double getLevelMaximumGeometricError(int level)

Gets the maximum geometric error allowed in a tile at a given level. This function should not be called before ready returns true.

Specified by:

getLevelMaximumGeometricError in interface TerrainProvider

Parameters:

level - The tile level for which to get the maximum geometric error.

Returns:

The maximum geometric error.

getTileDataAvailable

@JsMethod
public boolean getTileDataAvailable(int x,
                                              int y,
                                              int level)

Determines whether data for a tile is available to be loaded.

Specified by:

getTileDataAvailable in interface TerrainProvider

Parameters:

x - The X coordinate of the tile for which to request geometry.

y - The Y coordinate of the tile for which to request geometry.

level - The level of the tile for which to request geometry.

Returns:

Undefined if not supported by the terrain provider, otherwise true or false.

requestTileGeometry

@JsMethod
public Promise<TerrainData,Void> requestTileGeometry(int x,
                                                               int y,
                                                               int level,
                                                               Request request)

Requests the geometry for a given tile. This function should not be called before ready returns true. The result must include terrain data and may optionally include a water mask and an indication of which child tiles are available.

Specified by:

requestTileGeometry in interface TerrainProvider

Parameters:

x - The X coordinate of the tile for which to request geometry.

y - The Y coordinate of the tile for which to request geometry.

level - The level of the tile for which to request geometry.

request - The request object. Intended for internal use only.

Returns:

A promise for the requested geometry. If this method returns undefined instead of a promise, it is an indication that too many requests are already pending and the request will be retried later.