org.cesiumjs.cs.scene.providers

Class SingleTileImageryProvider

java.lang.Object

org.cesiumjs.cs.scene.providers.SingleTileImageryProvider

All Implemented Interfaces:

ImageryProvider

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

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
SingleTileImageryProvider(SingleTileImageryProviderOptions options) Provides a single, top-level imagery tile.

Method Summary

Modifier and Type	Method and Description
Credit	credit() Gets the credit to display when this imagery provider is active.
Event	errorEvent() Gets an event that is raised when the imagery provider encounters an asynchronous error.
Credit[]	getTileCredits(int x, int y, int level) Gets the credits to be displayed when a given tile is displayed.
boolean	hasAlphaChannel() Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel.
int	maximumLevel() Gets the maximum level-of-detail that can be requested.
int	minimumLevel() Gets the minimum level-of-detail that can be requested.
Promise<ImageryLayerFeatureInfo[],Void>	pickFeatures(int x, int y, int level, double longitude, double latitude) Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
boolean	ready() Gets a value indicating whether or not the provider is ready for use.
Promise<Boolean,Void>	readyPromise() Gets a promise that resolves to true when the provider is ready for use.
Rectangle	rectangle() Gets the rectangle, in radians, of the imagery provided by this instance.
Promise<JsImage,Void>	requestImage(int x, int y, int level) Requests the image for a given tile.
TileDiscardPolicy	tileDiscardPolicy() Gets the tile discard policy.
int	tileHeight() Gets the width of each tile, in pixels.
int	tileWidth() Gets the width of each tile, in pixels.
TilingScheme	tilingScheme() Gets the tiling scheme used by this provider.
String	url() Gets the URL of the single, top-level imagery tile.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleTileImageryProvider

@JsConstructor
public SingleTileImageryProvider(SingleTileImageryProviderOptions options)

Provides a single, top-level imagery tile. The single image is assumed to use a GeographicTilingScheme.

Parameters:

options - Options

Method Detail

credit

@JsProperty(name="credit")
public Credit credit()

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

errorEvent

@JsProperty(name="errorEvent")
public Event errorEvent()

Gets an event that is raised when the imagery 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.

hasAlphaChannel

@JsProperty(name="hasAlphaChannel")
public boolean hasAlphaChannel()

Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel. If this property is false, an alpha channel, if present, will be ignored. If this property is true, any images without an alpha channel will be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage and texture upload time are reduced. Default: true

maximumLevel

@JsProperty(name="maximumLevel")
public int maximumLevel()

Gets the maximum level-of-detail that can be requested. This function should not be called before SingleTileImageryProvider#ready returns true.

minimumLevel

@JsProperty(name="minimumLevel")
public int minimumLevel()

Gets the minimum level-of-detail that can be requested. This function should not be called before SingleTileImageryProvider#ready returns true.

ready

@JsProperty(name="ready")
public boolean ready()

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

readyPromise

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

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

rectangle

@JsProperty(name="rectangle")
public Rectangle rectangle()

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before SingleTileImageryProvider#ready returns true.

tileDiscardPolicy

@JsProperty(name="tileDiscardPolicy")
public TileDiscardPolicy tileDiscardPolicy()

Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered. This function should not be called before SingleTileImageryProvider#ready returns true.

tileWidth

@JsProperty(name="tileWidth")
public int tileWidth()

Gets the width of each tile, in pixels. This function should not be called before SingleTileImageryProvider#ready returns true.

tileHeight

@JsProperty(name="tileHeight")
public int tileHeight()

Gets the width of each tile, in pixels. This function should not be called before SingleTileImageryProvider#ready returns true.

tilingScheme

@JsProperty(name="tilingScheme")
public TilingScheme tilingScheme()

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

url

@JsProperty(name="url")
public String url()

Gets the URL of the single, top-level imagery tile.

getTileCredits

@JsMethod
public Credit[] getTileCredits(int x,
                                         int y,
                                         int level)

Gets the credits to be displayed when a given tile is displayed.

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - The tile level;

Returns:

The credits to be displayed when the tile is displayed.

pickFeatures

@JsMethod
public Promise<ImageryLayerFeatureInfo[],Void> pickFeatures(int x,
                                                                      int y,
                                                                      int level,
                                                                      double longitude,
                                                                      double latitude)

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - The tile level.

longitude - The longitude at which to pick features.

latitude - The latitude at which to pick features.

Returns:

A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of ImageryLayerFeatureInfo instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported.

requestImage

@JsMethod
public Promise<JsImage,Void> requestImage(int x,
                                                    int y,
                                                    int level)

Requests the image for a given tile. This function should not be called before SingleTileImageryProvider#ready returns true.

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - The tile level.

Returns:

A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later. The resolved image may be either an Image or a Canvas DOM object.