@openglobus/og 0.17.2 → 0.18.1

package/src/og/layer/WMS.js

@@ -1,182 +0,0 @@
-"use strict";
-
-import { Extent } from "../Extent.js";
-import { LonLat } from "../LonLat.js";
-import * as mercator from "../mercator.js";
-import { XYZ } from "./XYZ.js";
-
-/**
- * Used to display WMS services as tile layers on the globe.
- * @class
- * @extends {XYZ}
- * //TODO: WMS version, format, and custom srs cpecification.
- * @param {string} name - Layer name.
- * @param {Object} options - Options:
- * @param {number} [options.opacity=1.0] - Layer opacity.
- * @param {number} [options.minZoom=0] - Minimal visibility zoom level.
- * @param {number} [options.maxZoom=0] - Maximal visibility zoom level.
- * @param {string} [options.attribution] - Layer attribution that displayed in the attribution area on the screen.
- * @param {boolean} [options.isBaseLayer=false] - Base layer flag.
- * @param {boolean} [options.visibility=true] - Layer visibility.
- * @param {string} options.url - WMS url source.
- * @param {number} [options.width=256] - Tile width.
- * @param {number} [options.height=256] - Tile height.
- * @param {string} options.layers - WMS layers string.
- * @param {string} [options.version="1.1.1"] - WMS version.
- * @param {Object} extra  - Extra parameters (by WMS rreference or by WMS service vendors) to pass to WMS service.
- * @example:
- * new og.layer.WMS("USA States", {
- *     isBaseLayer: false,
- *     url: "http://openglobus.org/geoserver/",
- *     layers: "topp:states",
- *     opacity: 0.5,
- *     zIndex: 50,
- *     attribution: 'USA states - geoserver WMS example',
- *     version: "1.1.1",
- *     visibility: false }, {
- *     transparent: true,
- *     sld: "style.sld"}	   
- * );
- *
- * @fires og.layer.XYZ#load
- * @fires og.layer.XYZ#loadend
- */
-class WMS extends XYZ {
-
-
-    constructor(name, options, extra) {
-        super(name, options);
-
-        this._extra = new URLSearchParams(extra).toString();
-
-
-        if (!options.extent) {
-            this.setExtent(new Extent(new LonLat(-180.0, -90), new LonLat(180.0, 90)));
-        }
-
-        /**
-         * WMS layers string.
-         * @public
-         * @type {string}
-         */
-        this.layers = options.layers;
-
-        /**
-         * WMS tile width.
-         * @public
-         * @type {number}
-         */
-        this.imageWidth = options.imageWidth || 256;
-
-        /**
-         * WMS tile height.
-         * @public
-         * @type {number}
-         */
-        this.imageHeight = options.imageHeight || 256;
-
-        this._getBbox = WMS.get_bbox_v1_1_1;
-
-        this.setVersion(options.version);
-    }
-
-    static createRequestUrl(
-        url,
-        layers,
-        format = "image/png",
-        version = "1.1.1",
-        request = "GetMap",
-        srs,
-        bbox,
-        width = 256,
-        height = 256,
-        extra
-
-    ) {
-       return `${url}/?LAYERS=${layers}&FORMAT=${format}&SERVICE=WMS&VERSION=${version}&REQUEST=${request}&SRS=${srs}&BBOX=${bbox}&WIDTH=${width}&HEIGHT=${height}` +
-            (extra ? `&${extra}` : "");
-    }
-
-    static get_bbox_v1_1_1(extent) {
-        return (
-            extent.getWest() +
-            "," +
-            extent.getSouth() +
-            "," +
-            extent.getEast() +
-            "," +
-            extent.getNorth()
-        );
-    }
-
-    static get_bbox_v1_3_0(extent) {
-        return (
-            extent.getSouth() +
-            "," +
-            extent.getWest() +
-            "," +
-            extent.getNorth() +
-            "," +
-            extent.getEast()
-        );
-    }
-
-    _checkSegment(segment) {
-        return true;
-    }
-
-    get instanceName() {
-        return "WMS";
-    }
-
-    _createUrl(segment) {
-        return WMS.createRequestUrl(
-            this.url,
-            this.layers,
-            "image/png",
-            this._version,
-            "GetMap",
-            segment._projection.code,
-            this._getBbox(segment.getExtent()),
-            this.imageWidth,
-            this.imageHeight,
-            this._extra
-        );
-    }
-
-    setVersion(version) {
-        if (version) {
-            this._version = version;
-        } else {
-            this._version = "1.1.1";
-        }
-
-        if (this._version === "1.1.1") {
-            this._getBbox = WMS.get_bbox_v1_1_1;
-        } else if (version === "1.3.0") {
-            this._getBbox = WMS.get_bbox_v1_3_0;
-        }
-    }
-
-    _correctFullExtent() {
-        var e = this._extent,
-            em = this._extentMerc;
-        var ENLARGE_MERCATOR_LON = mercator.POLE + 50000;
-        var ENLARGE_MERCATOR_LAT = mercator.POLE + 50000;
-        if (e.northEast.lat === 90.0) {
-            em.northEast.lat = ENLARGE_MERCATOR_LAT;
-        }
-        if (e.northEast.lon === 180.0) {
-            em.northEast.lon = ENLARGE_MERCATOR_LON;
-        }
-        if (e.southWest.lat === -90.0) {
-            em.southWest.lat = -ENLARGE_MERCATOR_LAT;
-        }
-        if (e.southWest.lon === -180.0) {
-            em.southWest.lon = -ENLARGE_MERCATOR_LON;
-        }
-    }
-}
-
-export { WMS };
-

package/src/og/layer/XYZ.js

@@ -1,374 +0,0 @@
-"use strict";
-
-import * as mercator from "../mercator.js";
-import { RENDERING } from "../quadTree/quadTree.js";
-import { stringTemplate } from "../utils/shared.js";
-import { Layer } from "./Layer.js";
-
-/**
- * Represents an imagery tiles source provider.
- * @class
- * @extends {Layer}
- * @param {string} name - Layer name.
- * @param {Object} options:
- * @param {number} [options.opacity=1.0] - Layer opacity.
- * @param {Array.<string>} [options.subdomains=['a','b','c']] - Subdomains of the tile service.
- * @param {number} [options.minZoom=0] - Minimal visibility zoom level.
- * @param {number} [options.maxZoom=0] - Maximal visibility zoom level.
- * @param {number} [options.minNativeZoom=0] - Minimal available zoom level.
- * @param {number} [options.maxNativeZoom=19] - Maximal available zoom level.
- * @param {string} [options.attribution] - Layer attribution that displayed in the attribution area on the screen.
- * @param {boolean} [options.isBaseLayer=false] - Base layer flag.
- * @param {boolean} [options.visibility=true] - Layer visibility.
- * @param {string} [options.crossOrigin=true] - If true, all tiles will have their crossOrigin attribute set to ''.
- * @param {string} options.url - Tile url source template(see example below).
- * @param {string} options.textureFilter - texture gl filter. NEAREST, LINEAR, MIPMAP, ANISOTROPHIC.
- * @param {layer.XYZ~_urlRewriteCallback} options.urlRewrite - Url rewrite function.
- * @fires og.layer.XYZ#load
- * @fires og.layer.XYZ#loadend
- *
- * @example <caption>Creates OpenStreetMap base tile layer</caption>
- * new og.layer.XYZ("OpenStreetMap", {
- *     isBaseLayer: true,
- *     url: "http://b.tile.openstreetmap.org/{z}/{x}/{y}.png",
- *     visibility: true,
- *     attribution: 'Data @ <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="http://www.openstreetmap.org/copyright">ODbL</a>'
- * });
- */
-class XYZ extends Layer {
-    /**
-     * @param {string} name - Layer name.
-     * @param {*} options
-     */
-    constructor(name, options = {}) {
-        super(name, options);
-
-        this.events.registerNames(EVENT_NAMES);
-
-        /**
-         * Tile url source template.
-         * @public
-         * @type {string}
-         */
-        this.url = options.url || "";
-
-        /**
-         * @protected
-         */
-        this._s = options.subdomains || ["a", "b", "c"];
-
-        /**
-         * Minimal native zoom level when tiles are available.
-         * @public
-         * @type {number}
-         */
-        this.minNativeZoom = options.minNativeZoom || 0;
-
-        /**
-         * Maximal native zoom level when tiles are available.
-         * @public
-         * @type {number}
-         */
-        this.maxNativeZoom = options.maxNativeZoom || 19;
-
-        /**
-         * Rewrites imagery tile url query.
-         * @private
-         * @callback og.layer.XYZ~_urlRewriteCallback
-         * @param {Segment} segment - Segment to load.
-         * @param {string} url - Created url.
-         * @returns {string} - Url query string.
-         */
-        this._urlRewriteCallback = options.urlRewrite || null;
-
-        this._requestsPeerSubdomian = 4;
-        this._requestCount = 0;
-    }
-
-    /**
-     * @warning Use XYZ.isIdle in requesAnimationFrame(after setVisibility)
-     */
-    get isIdle() {
-        return super.isIdle && this._planet._tileLoader.getRequestCounter(this) === 0;
-    }
-
-    get instanceName() {
-        return "XYZ";
-    }
-
-    /**
-     * Abort loading tiles.
-     * @public
-     */
-    abortLoading() {
-        if (this._planet) {
-            this._planet._tileLoader.abort(this);
-        }
-    }
-
-    /**
-     * Sets layer visibility.
-     * @public
-     * @param {boolean} visibility - Layer visibility.
-     */
-    setVisibility(visibility) {
-        if (visibility !== this._visibility) {
-            super.setVisibility(visibility);
-            if (!visibility) {
-                this.abortLoading();
-            }
-        }
-    }
-
-    remove() {
-        this.abortLoading();
-        super.remove();
-    }
-
-    /**
-     * Sets imagery tiles url source template.
-     * @public
-     * @param {string} url - Url template.
-     * @example
-     * http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
-     * where {z}, {x} and {y} - replaces by current tile values, {s} - random domen.
-     */
-    setUrl(url) {
-        this.url = url;
-    }
-
-    _checkSegment(segment) {
-        return segment._projection.id === this._planet.quadTreeStrategy.projection.id;// EPSG4326.id;// EPSG3857.id;
-    }
-
-    /**
-     * Start to load tile material.
-     * @public
-     * @virtual
-     * @param {Material} material - Loads current material.
-     */
-    loadMaterial(material, forceLoading) {
-
-        let seg = material.segment;
-
-        if (this._isBaseLayer) {
-            material.texture = seg.getDefaultTexture();
-        } else {
-            material.texture = seg.planet.transparentTexture;
-        }
-
-        // Q: Maybe we should change "<2" to material.segment.tileZoom < (material.layer.minZoom + 1)
-        if (this._planet.layerLock.isFree() || material.segment.tileZoom < 2) {
-            material.isReady = false;
-            material.isLoading = true;
-
-            if (this._checkSegment(seg)) {
-                material.loadingAttempts++;
-
-                this._planet._tileLoader.load(
-                    {
-                        sender: this,
-                        src: this._getHTTPRequestString(material.segment),
-                        type: "imageBitmap",
-                        filter: () =>
-                            (seg.initialized && seg.node.getState() === RENDERING) || forceLoading,
-                        options: {}
-                    },
-                    (response) => {
-                        if (response.status === "ready") {
-                            if (material.isLoading) {
-                                let e = this.events.load;
-                                if (e.handlers.length) {
-                                    this.events.dispatch(e, material);
-                                }
-                                material.applyImage(response.data);
-                                response.data = null;
-                            }
-                        } else if (response.status === "abort") {
-                            material.isLoading = false;
-                        } else if (response.status === "error") {
-                            if (material.isLoading) {
-                                material.textureNotExists();
-                            }
-                        }
-                    },
-                    this._id
-                );
-            } else {
-                material.textureNotExists();
-            }
-        }
-    }
-
-    /**
-     * Creates query url.
-     * @protected
-     * @virtual
-     * @param {Segment} segment - Creates specific url for current segment.
-     * @returns {String} - Returns url string.
-     */
-    _createUrl(segment) {
-        return stringTemplate(this.url, {
-            s: this._getSubdomain(),
-            x: segment.tileX.toString(),
-            y: segment.tileY.toString(),
-            z: segment.tileZoom.toString()
-        });
-    }
-
-    _getSubdomain() {
-        this._requestCount++;
-        return this._s[Math.floor(this._requestCount % (this._requestsPeerSubdomian * this._s.length) / this._requestsPeerSubdomian)];
-
-    }
-
-    /**
-     * Returns actual url query string.
-     * @protected
-     * @param {Segment} segment - Segment that loads image data.
-     * @returns {string} - Url string.
-     */
-    _getHTTPRequestString(segment) {
-        return this._urlRewriteCallback
-            ? this._urlRewriteCallback(segment, this.url)
-            : this._createUrl(segment);
-    }
-
-    /**
-     * Sets url rewrite callback, used for custom url rewriting for every tile laoding.
-     * @public
-     * @param {layer.XYZ~_urlRewriteCallback} ur - The callback that returns tile custom created url.
-     */
-    setUrlRewriteCallback(ur) {
-        this._urlRewriteCallback = ur;
-    }
-
-    applyMaterial(material, forceLoading) {
-        if (material.isReady) {
-            return material.texOffset;
-        } else if (material.segment.tileZoom < this.minNativeZoom) {
-            material.textureNotExists();
-        } else {
-
-            let segment = material.segment,
-                pn = segment.node,
-                notEmpty = false;
-
-            let mId = this._id;
-            let psegm = material;
-            while (pn.parentNode) {
-                pn = pn.parentNode;
-                psegm = pn.segment.materials[mId];
-                if (psegm && psegm.textureExists) {
-                    notEmpty = true;
-                    break;
-                }
-            }
-
-            if (segment.passReady) {
-                let maxNativeZoom = material.layer.maxNativeZoom;
-                if (pn.segment.tileZoom === maxNativeZoom) {
-                    material.textureNotExists();
-                } else if (material.segment.tileZoom <= maxNativeZoom) {
-                    !material.isLoading && !material.isReady && this.loadMaterial(material, forceLoading);
-                } else {
-                    let pn = segment.node;
-                    while (pn.segment.tileZoom > material.layer.maxNativeZoom) {
-                        pn = pn.parentNode;
-                    }
-                    let pnm = pn.segment.materials[material.layer._id];
-                    if (pnm) {
-                        !pnm.isLoading && !pnm.isReady && this.loadMaterial(pnm, true);
-                    } else {
-                        pnm = pn.segment.materials[material.layer._id] = material.layer.createMaterial(
-                            pn.segment
-                        );
-                        this.loadMaterial(pnm, true);
-                    }
-                }
-            }
-
-            if (notEmpty) {
-                material.appliedNode = pn;
-                material.appliedNodeId = pn.nodeId;
-                material.texture = psegm.texture;
-                let dZ2 = 1.0 / (2 << (segment.tileZoom - pn.segment.tileZoom - 1));
-                material.texOffset[0] = segment.tileX * dZ2 - pn.segment.tileX;
-                material.texOffset[1] = segment.tileY * dZ2 - pn.segment.tileY;
-                material.texOffset[2] = dZ2;
-                material.texOffset[3] = dZ2;
-            } else {
-                material.texture = segment.planet.transparentTexture;
-                material.texOffset[0] = 0.0;
-                material.texOffset[1] = 0.0;
-                material.texOffset[2] = 1.0;
-                material.texOffset[3] = 1.0;
-            }
-        }
-
-        return material.texOffset;
-    }
-
-    clearMaterial(material) {
-        if (material.isReady && material.textureExists) {
-            !material.texture.default &&
-            material.segment.handler.gl.deleteTexture(material.texture);
-            material.texture = null;
-
-            if (material.image) {
-                material.image.src = "";
-                material.image = null;
-            }
-        }
-
-        material.isReady = false;
-        material.textureExists = false;
-        material.isLoading = false;
-    }
-
-    /**
-     * @protected
-     */
-    _correctFullExtent() {
-        var e = this._extent,
-            em = this._extentMerc;
-        var ENLARGE_MERCATOR_LON = mercator.POLE + 50000;
-        var ENLARGE_MERCATOR_LAT = mercator.POLE + 50000;
-        if (e.northEast.lat === 90.0) {
-            em.northEast.lat = ENLARGE_MERCATOR_LAT;
-        }
-        if (e.northEast.lon === 180.0) {
-            em.northEast.lon = ENLARGE_MERCATOR_LON;
-        }
-        if (e.southWest.lat === -90.0) {
-            em.southWest.lat = -ENLARGE_MERCATOR_LAT;
-        }
-        if (e.southWest.lon === -180.0) {
-            em.southWest.lon = -ENLARGE_MERCATOR_LON;
-        }
-
-        if (e.northEast.lat >= mercator.MAX_LAT) {
-            e.northEast.lat = mercator.MAX_LAT;
-        }
-
-        if (e.northEast.lat <= mercator.MIN_LAT) {
-            e.northEast.lat = mercator.MIN_LAT;
-        }
-    }
-}
-
-const EVENT_NAMES = [
-    /**
-     * Triggered when current tile image has loaded before rendereing.
-     * @event og.layer.XYZ#load
-     */
-    "load",
-
-    /**
-     * Triggered when all tiles have loaded or loading has stopped.
-     * @event og.layer.XYZ#loadend
-     */
-    "loadend"
-];
-
-export { XYZ };

package/src/og/layer/index.js

@@ -1,11 +0,0 @@
-import { CanvasTiles } from './CanvasTiles.js';
-import { GeoImage } from './GeoImage.js';
-import { GeoTexture2d } from './GeoTexture2d.js';
-import { GeoVideo } from './GeoVideo.js';
-import { KML } from './KML.js';
-import { Layer } from './Layer.js';
-import { Vector } from './Vector.js';
-import { WMS } from './WMS.js';
-import { XYZ } from './XYZ.js';
-
-export { CanvasTiles, GeoImage, GeoTexture2d, GeoVideo, KML, Layer, Vector, WMS, XYZ };