All Downloads are FREE. Search and download functionalities are using the official Maven repository.

main.cesium.GoogleEarthEnterpriseMapsProvider.kt Maven / Gradle / Ivy

// Automatically generated - do not modify!

@file:JsModule("cesium")

@file:Suppress(
    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)

package cesium

/**
 * Provides tiled imagery using the Google Earth Imagery API.
 *
 * Notes: This imagery provider does not work with the public Google Earth servers. It works with the
 *        Google Earth Enterprise Server.
 *
 *        By default the Google Earth Enterprise server does not set the
 *        [Cross-Origin Resource Sharing](http://www.w3.org/TR/cors/) headers. You can either
 *        use a proxy server which adds these headers, or in the /opt/google/gehttpd/conf/gehttpd.conf
 *        and add the 'Header set Access-Control-Allow-Origin "*"' option to the '<Directory />' and
 *        '<Directory "/opt/google/gehttpd/htdocs">' directives.
 *
 *        This provider is for use with 2D Maps API as part of Google Earth Enterprise. For 3D Earth API uses, it
 *        is necessary to use [GoogleEarthEnterpriseImageryProvider]
 * ```
 * const google = new GoogleEarthEnterpriseMapsProvider({
 *     url : 'https://earth.localdomain',
 *     channel : 1008
 * });
 * ```
 * @see Online Documentation
 */
external class GoogleEarthEnterpriseMapsProvider(options: ConstructorOptions) {
    /**
     * The default alpha blending value of this provider, with 0.0 representing fully transparent and
     * 1.0 representing fully opaque.
     * @see Online Documentation
     */
    var defaultAlpha: Double?

    /**
     * The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
     * 1.0 representing fully opaque.
     * @see Online Documentation
     */
    var defaultNightAlpha: Double?

    /**
     * The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
     * 1.0 representing fully opaque.
     * @see Online Documentation
     */
    var defaultDayAlpha: Double?

    /**
     * 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.
     * @see Online Documentation
     */
    var defaultBrightness: Double?

    /**
     * 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.
     * @see Online Documentation
     */
    var defaultContrast: Double?

    /**
     * The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
     * @see Online Documentation
     */
    var defaultHue: Double?

    /**
     * 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.
     * @see Online Documentation
     */
    var defaultSaturation: Double?

    /**
     * The default gamma correction to apply to this provider.  1.0 uses the unmodified imagery color.
     * @see Online Documentation
     */
    var defaultGamma: Double?

    /**
     * The default texture minification filter to apply to this provider.
     * @see Online Documentation
     */
    var defaultMinificationFilter: TextureMinificationFilter

    /**
     * The default texture magnification filter to apply to this provider.
     * @see Online Documentation
     */
    var defaultMagnificationFilter: TextureMagnificationFilter

    /**
     * Gets the URL of the Google Earth MapServer.
     * @see Online Documentation
     */
    val url: String

    /**
     * Gets the url path of the data on the Google Earth server.
     * @see Online Documentation
     */
    val path: String

    /**
     * Gets the proxy used by this provider.
     * @see Online Documentation
     */
    val proxy: Proxy

    /**
     * Gets the imagery channel (id) currently being used.
     * @see Online Documentation
     */
    val channel: Int

    /**
     * Gets the width of each tile, in pixels. This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val tileWidth: Int

    /**
     * Gets the height of each tile, in pixels.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val tileHeight: Int

    /**
     * Gets the maximum level-of-detail that can be requested.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val maximumLevel: Int?

    /**
     * Gets the minimum level-of-detail that can be requested.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val minimumLevel: Int

    /**
     * Gets the tiling scheme used by this provider.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val tilingScheme: TilingScheme

    /**
     * Gets the version of the data used by this provider.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val version: Double

    /**
     * Gets the type of data that is being requested from the provider.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val requestType: String

    /**
     * Gets the rectangle, in radians, of the imagery provided by this instance.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val rectangle: Rectangle

    /**
     * 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 [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val tileDiscardPolicy: TileDiscardPolicy

    /**
     * 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].
     * @see Online Documentation
     */
    val errorEvent: Event

    /**
     * Gets a value indicating whether or not the provider is ready for use.
     * @see Online Documentation
     */
    val ready: Boolean

    /**
     * Gets a promise that resolves to true when the provider is ready for use.
     * @see Online Documentation
     */
    val readyPromise: kotlin.js.Promise

    /**
     * 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 [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @see Online Documentation
     */
    val credit: Credit

    /**
     * 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.
     * @see Online Documentation
     */
    val hasAlphaChannel: Boolean

    /**
     * Gets the credits to be displayed when a given tile is displayed.
     * @param [x] The tile X coordinate.
     * @param [y] The tile Y coordinate.
     * @param [level] The tile level;
     * @return The credits to be displayed when the tile is displayed.
     * @see Online Documentation
     */
    fun getTileCredits(
        x: Double,
        y: Double,
        level: Int,
    ): Array

    /**
     * Requests the image for a given tile.  This function should
     * not be called before [GoogleEarthEnterpriseMapsProvider.ready] returns true.
     * @param [x] The tile X coordinate.
     * @param [y] The tile Y coordinate.
     * @param [level] The tile level.
     * @param [request] The request object. Intended for internal use only.
     * @return 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.
     * @see Online Documentation
     */
    fun requestImage(
        x: Double,
        y: Double,
        level: Int,
        request: Request? = definedExternally,
    ): kotlin.js.Promise?

    /**
     * Picking features is not currently supported by this imagery provider, so this function simply returns
     * undefined.
     * @param [x] The tile X coordinate.
     * @param [y] The tile Y coordinate.
     * @param [level] The tile level.
     * @param [longitude] The longitude at which to pick features.
     * @param [latitude] The latitude at which to pick features.
     * @return 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.
     * @see Online Documentation
     */
    fun pickFeatures(
        x: Double,
        y: Double,
        level: Int,
        longitude: Double,
        latitude: Double,
    ): kotlin.js.Promise>?

    /**
     * Initialization options for the GoogleEarthEnterpriseMapsProvider constructor
     * @property [url] The url of the Google Earth server hosting the imagery.
     * @property [channel] The channel (id) to be used when requesting data from the server.
     *   The channel number can be found by looking at the json file located at:
     *   earth.localdomain/default_map/query?request=Json&vars=geeServerDefs The /default_map path may
     *   differ depending on your Google Earth Enterprise server configuration. Look for the "id" that
     *   is associated with a "ImageryMaps" requestType. There may be more than one id available.
     *   Example:
     *   {
     *   layers: [
     *   {
     *   id: 1002,
     *   requestType: "ImageryMaps"
     *   },
     *   {
     *   id: 1007,
     *   requestType: "VectorMapsRaster"
     *   }
     *   ]
     *   }
     * @property [path] The path of the Google Earth server hosting the imagery.
     *   Default value - `"/default_map"`
     * @property [maximumLevel] The maximum level-of-detail supported by the Google Earth
     *   Enterprise server, or undefined if there is no limit.
     * @property [tileDiscardPolicy] The policy that determines if a tile
     *   is invalid and should be discarded. To ensure that no tiles are discarded, construct and pass
     *   a [NeverTileDiscardPolicy] for this parameter.
     * @property [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
     * @see Online Documentation
     */
    interface ConstructorOptions {
        var url: Resource
        var channel: Int
        var path: String?
        var maximumLevel: Int?
        var tileDiscardPolicy: TileDiscardPolicy?
        var ellipsoid: Ellipsoid?
    }

    companion object {
        /**
         * Gets or sets the URL to the Google Earth logo for display in the credit.
         * @see Online Documentation
         */
        var logoUrl: String
    }
}

inline fun GoogleEarthEnterpriseMapsProvider(
    block: GoogleEarthEnterpriseMapsProvider.ConstructorOptions.() -> Unit,
): GoogleEarthEnterpriseMapsProvider {
    val options: GoogleEarthEnterpriseMapsProvider.ConstructorOptions = js("({})")
    block(options)
    return GoogleEarthEnterpriseMapsProvider(options)
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy