org.cesiumjs.cs.scene.providers

Class IonImageryProvider

java.lang.Object

org.cesiumjs.cs.scene.providers.IonImageryProvider

All Implemented Interfaces:

ImageryProvider

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

Provides tiled imagery using the Cesium ion REST API.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
float	defaultAlpha The default alpha blending value of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.
float	defaultBrightness The default brightness of this provider. 1.0 uses the unmodified imagery color.
float	defaultContrast The default contrast of this provider. 1.0 uses the unmodified imagery color.
float	defaultGamma The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
float	defaultHue The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
Number	defaultMagnificationFilter The default texture magnification filter to apply to this provider.
Number	defaultMinificationFilter The default texture minification filter to apply to this provider.
float	defaultSaturation The default saturation of this provider. 1.0 uses the unmodified imagery color.

Constructor Summary

Constructors

Constructor and Description
IonImageryProvider(IonImageryProviderOptions options) Provides tiled imagery using the Cesium ion REST API.

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) Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile.
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 the instance.
Promise<com.google.gwt.canvas.client.Canvas,Void>	requestCanvas(int x, int y, int level, Request request) Requests the image for a given tile.
Promise<JsImage,Void>	requestImage(int x, int y, int level, Request request) Requests the image for a given tile.
TileDiscardPolicy	tileDiscardPolicy() Gets the tile discard policy.
int	tileHeight() Gets the height of each tile, in pixels.
int	tileWidth() Gets the width of each tile, in pixels.
TilingScheme	tilingScheme() Gets the tiling scheme used by the provider.

Methods inherited from class java.lang.Object

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

Field Detail

defaultAlpha

@JsProperty
public float defaultAlpha

The default alpha blending value of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque. Default: undefined

defaultBrightness

@JsProperty
public float defaultBrightness

The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter. Default: undefined

defaultContrast

@JsProperty
public float defaultContrast

The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the contrast while greater than 1.0 increases it. Default: undefined

defaultGamma

public float defaultGamma

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color. Default: undefined

defaultHue

@JsProperty
public float defaultHue

The default hue of this provider in radians. 0.0 uses the unmodified imagery color. Default: undefined

defaultMagnificationFilter

@JsProperty
public Number defaultMagnificationFilter

The default texture magnification filter to apply to this provider.

See Also:

Default: undefined

defaultMinificationFilter

@JsProperty
public Number defaultMinificationFilter

The default texture minification filter to apply to this provider.

See Also:

Default: undefined

defaultSaturation

@JsProperty
public float defaultSaturation

The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the saturation while greater than 1.0 increases it. Default: undefined

Constructor Detail

IonImageryProvider

@JsConstructor
public IonImageryProvider(IonImageryProviderOptions options)

Provides tiled imagery using the Cesium ion REST API.

Parameters:

options - IonImageryProviderOptions object.

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 IonImageryProvider#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.

maximumLevel

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

Gets the maximum level-of-detail that can be requested. This function should not be called before 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 ready() returns true. Generally, a minimum level should only be used when the rectangle of the imagery is small enough that the number of tiles at the minimum level is small. An imagery provider with more than a few tiles at the minimum level will lead to rendering problems.

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 the instance. This function should not be called before 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 ready() returns true.

tileHeight

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

Gets the height of each tile, in pixels. This function should not be called before 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 ready() returns true.

tilingScheme

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

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

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)

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before ready() returns true. This function is optional, so it may not exist on all ImageryProviders.

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,
                                                    Request request)

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

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - The tile level.

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

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.

requestCanvas

@JsMethod
public Promise<com.google.gwt.canvas.client.Canvas,Void> requestCanvas(int x,
                                                                                 int y,
                                                                                 int level,
                                                                                 Request request)

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

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - The tile level.

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

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.