@openglobus/og 0.18.0 → 0.18.1

package/{src/layer/XYZ.ts → lib/js/layer/XYZ.js}

@@ -1,28 +1,7 @@
 import * as mercator from "../mercator";
-import {Layer, ILayerParams, LayerEventsList} from "./Layer";
-import {RENDERING} from "../quadTree/quadTree";
-import {Segment} from "../segment/Segment";
-import {stringTemplate} from "../utils/shared";
-import {EventsHandler} from "../Events";
-import {Material} from "./Material";
-import {NumberArray4} from "../math/Vec4";
-import {IResponse} from "../utils/Loader";
-
-export interface IXYZParams extends ILayerParams {
-    url?: string;
-    subdomains?: string[];
-    minNativeZoom?: number;
-    maxNativeZoom?: number;
-    urlRewrite?: Function;
-}
-
-type XYZEventsList = [
-    "load",
-    "loadend"
-];
-
-type XYZEventsType = EventsHandler<XYZEventsList> & EventsHandler<LayerEventsList>;
-
+import { Layer } from "./Layer";
+import { RENDERING } from "../quadTree/quadTree";
+import { stringTemplate } from "../utils/shared";
 /**
  * Represents an imagery tiles source provider.
  * @class
@@ -54,98 +33,43 @@ type XYZEventsType = EventsHandler<XYZEventsList> & EventsHandler<LayerEventsLis
  *     attribution: 'Data @ <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="http://www.openstreetmap.org/copyright">ODbL</a>'
  * });
  */
-class XYZ extends Layer {
-
-    public override events: XYZEventsType;
-
-    /**
-     * Tile url source template.
-     * @public
-     * @type {string}
-     */
-    public url: string;
-
-    /**
-     * @protected
-     */
-    protected _s: string[];
-
-    /**
-     * Minimal native zoom level when tiles are available.
-     * @public
-     * @type {number}
-     */
-    public minNativeZoom: number;
-
-    /**
-     * Maximal native zoom level when tiles are available.
-     * @public
-     * @type {number}
-     */
-    public maxNativeZoom: number;
-
-    /**
-     * 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.
-     */
-    protected _urlRewriteCallback: Function | null;
-
-    protected _requestsPeerSubdomains: number;
-
-    protected _requestCount: number;
-
-    constructor(name: string | null, options: IXYZParams = {}) {
+export class XYZ extends Layer {
+    constructor(name, options = {}) {
         super(name, options);
-
         //@ts-ignore
         this.events = this.events.registerNames(XYZ_EVENTS);
-
         this.url = options.url || "";
-
         this._s = options.subdomains || ["a", "b", "c"];
-
         this.minNativeZoom = options.minNativeZoom || 0;
-
         this.maxNativeZoom = options.maxNativeZoom || 19;
-
         this._urlRewriteCallback = options.urlRewrite || null;
-
         this._requestsPeerSubdomains = 4;
-
         this._requestCount = 0;
     }
-
     /**
      * @warning Use XYZ.isIdle in requestAnimationFrame(after setVisibility)
      */
-    public override get isIdle(): boolean {
-        return super.isIdle && this._planet!._tileLoader.getRequestCounter(this) === 0;
+    get isIdle() {
+        return super.isIdle && this._planet._tileLoader.getRequestCounter(this) === 0;
     }
-
-    public override get instanceName(): string {
+    get instanceName() {
         return "XYZ";
     }
-
     /**
      * Abort loading tiles.
      * @public
      */
-    public override abortLoading() {
+    abortLoading() {
         if (this._planet) {
             this._planet._tileLoader.abort(this);
         }
     }
-
     /**
      * Sets layer visibility.
      * @public
      * @param {boolean} visibility - Layer visibility.
      */
-    public override setVisibility(visibility: boolean) {
+    setVisibility(visibility) {
         if (visibility !== this._visibility) {
             super.setVisibility(visibility);
             if (!visibility) {
@@ -153,13 +77,11 @@ class XYZ extends Layer {
             }
         }
     }
-
-    public override remove(): this {
+    remove() {
         this.abortLoading();
         super.remove();
         return this;
     }
-
     /**
      * Sets imagery tiles url source template.
      * @public
@@ -168,14 +90,12 @@ class XYZ extends Layer {
      * http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
      * where {z}, {x} and {y} - replaces by current tile values, {s} - random domain.
      */
-    public setUrl(url: string) {
+    setUrl(url) {
         this.url = url;
     }
-
-    public _checkSegment(segment: Segment) {
-        return segment._projection.id === this._planet!.quadTreeStrategy.projection.id;// EPSG4326.id;// EPSG3857.id;
+    _checkSegment(segment) {
+        return segment._projection.id === this._planet.quadTreeStrategy.projection.id; // EPSG4326.id;// EPSG3857.id;
     }
-
     /**
      * Start to load tile material.
      * @public
@@ -183,57 +103,54 @@ class XYZ extends Layer {
      * @param {Material} material - Loads current material.
      * @param {boolean} [forceLoading=false] -
      */
-    public override loadMaterial(material: Material, forceLoading: boolean = false) {
-
+    loadMaterial(material, forceLoading = false) {
         let seg = material.segment;
-
         if (this._isBaseLayer) {
             material.texture = seg.getDefaultTexture();
-        } else {
+        }
+        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) {
+        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: IResponse) => {
-                        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._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;
                         }
                     }
-                    //,this.__id
+                    else if (response.status === "abort") {
+                        material.isLoading = false;
+                    }
+                    else if (response.status === "error") {
+                        if (material.isLoading) {
+                            material.textureNotExists();
+                        }
+                    }
+                }
+                //,this.__id
                 );
-            } else {
+            }
+            else {
                 material.textureNotExists();
             }
         }
     }
-
     /**
      * Creates query url.
      * @protected
@@ -241,7 +158,7 @@ class XYZ extends Layer {
      * @param {Segment} segment - Creates specific url for current segment.
      * @returns {string} - Returns url string.
      */
-    protected _createUrl(segment: Segment): string {
+    _createUrl(segment) {
         return stringTemplate(this.url, {
             s: this._getSubdomain(),
             x: segment.tileX.toString(),
@@ -249,42 +166,36 @@ class XYZ extends Layer {
             z: segment.tileZoom.toString()
         });
     }
-
-    protected _getSubdomain(): string {
+    _getSubdomain() {
         this._requestCount++;
         return this._s[Math.floor(this._requestCount % (this._requestsPeerSubdomains * this._s.length) / this._requestsPeerSubdomains)];
     }
-
     /**
      * Returns actual url query string.
      * @protected
      * @param {Segment} segment - Segment that loads image data.
      * @returns {string} - Url string.
      */
-    protected _getHTTPRequestString(segment: Segment) {
+    _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 loading.
      * @public
      * @param {Function} ur - The callback that returns tile custom created url.
      */
-    public setUrlRewriteCallback(ur: Function) {
+    setUrlRewriteCallback(ur) {
         this._urlRewriteCallback = ur;
     }
-
-    public override applyMaterial(material: Material, forceLoading: boolean = false): NumberArray4 {
+    applyMaterial(material, forceLoading = false) {
         if (material.isReady) {
             return material.texOffset;
-        } else if (material.segment.tileZoom < this.minNativeZoom) {
+        }
+        else if (material.segment.tileZoom < this.minNativeZoom) {
             material.textureNotExists();
-        } else {
-
-            let segment = material.segment,
-                pn = segment.node,
-                notEmpty = false;
-
+        }
+        else {
+            let segment = material.segment, pn = segment.node, notEmpty = false;
             let mId = this.__id;
             let psegm = material;
             while (pn.parentNode) {
@@ -295,30 +206,29 @@ class XYZ extends Layer {
                     break;
                 }
             }
-
             if (segment.passReady) {
-                let maxNativeZoom = (material.layer as XYZ).maxNativeZoom;
+                let maxNativeZoom = material.layer.maxNativeZoom;
                 if (pn.segment.tileZoom === maxNativeZoom) {
                     material.textureNotExists();
-                } else if (material.segment.tileZoom <= maxNativeZoom) {
+                }
+                else if (material.segment.tileZoom <= maxNativeZoom) {
                     !material.isLoading && !material.isReady && this.loadMaterial(material, forceLoading);
-                } else {
+                }
+                else {
                     let pn = segment.node;
-                    while (pn.segment.tileZoom > (material.layer as XYZ).maxNativeZoom) {
-                        pn = pn.parentNode!;
+                    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
-                        );
+                    }
+                    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;
@@ -328,7 +238,8 @@ class XYZ extends Layer {
                 material.texOffset[1] = segment.tileY * dZ2 - pn.segment.tileY;
                 material.texOffset[2] = dZ2;
                 material.texOffset[3] = dZ2;
-            } else {
+            }
+            else {
                 material.texture = segment.planet.transparentTexture;
                 material.texOffset[0] = 0.0;
                 material.texOffset[1] = 0.0;
@@ -336,27 +247,22 @@ class XYZ extends Layer {
                 material.texOffset[3] = 1.0;
             }
         }
-
         return material.texOffset;
     }
-
-    public override clearMaterial(material: Material) {
+    clearMaterial(material) {
         if (material.isReady && material.textureExists) {
-            !material.texture!.default && material.segment.handler.gl!.deleteTexture(material.texture!);
+            !material.texture.default && material.segment.handler.gl.deleteTexture(material.texture);
             material.texture = null;
         }
-
         material.isReady = false;
         material.textureExists = false;
         material.isLoading = false;
     }
-
     /**
      * @protected
      */
-    protected override _correctFullExtent() {
-        let e = this._extent,
-            em = this._extentMerc;
+    _correctFullExtent() {
+        let e = this._extent, em = this._extentMerc;
         let ENLARGE_MERCATOR_LON = mercator.POLE + 50000;
         let ENLARGE_MERCATOR_LAT = mercator.POLE + 50000;
         if (e.northEast.lat === 90.0) {
@@ -371,29 +277,23 @@ class XYZ extends Layer {
         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 XYZ_EVENTS: XYZEventsList = [
+const XYZ_EVENTS = [
     /**
      * Triggered when current tile image has loaded before rendering.
      * @event #load
      */
     "load",
-
     /**
      * Triggered when all tiles have loaded or loading has stopped.
      * @event #loadend
      */
     "loadend"
 ];
-
-export {XYZ};

package/lib/js/layer/index.d.ts

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

package/lib/js/layer/index.js

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

package/lib/js/light/LightSource.d.ts

@@ -0,0 +1,174 @@
+import { Vec3 } from "../math/Vec3";
+import { RenderNode } from "../scene/RenderNode";
+export interface ILightSourceParams {
+    position?: Vec3;
+    directional?: boolean;
+    ambient?: Vec3;
+    diffuse?: Vec3;
+    specular?: Vec3;
+    shininess?: number;
+}
+/**
+ * Represents basic light source.
+ * @class
+ * @param {string} [name] - Light source name.
+ * @param {ILightSourceParams} [params] - Light parameters:
+ * @param {Vec3} [params.position] - Light source position if it is a point light, otherwise it is a light direction vector.
+ * @param {Vec3} [params.ambient]  - Ambient RGB color.
+ * @param {Vec3} [params.diffuse]  - Diffuse RGB color.
+ * @param {Vec3} [params.specular]  - Specular RGB color.
+ * @param {number} [params.shininess]  - Specular shininess.
+ */
+declare class LightSource {
+    static __counter__: number;
+    /**
+     * Light name.
+     * @protected
+     * @type {string}
+     */
+    protected _name: string;
+    /**
+     * Render node where light is shines.
+     * @protected
+     * @type {RenderNode}
+     */
+    protected _renderNode: RenderNode | null;
+    /**
+     * Light position.
+     * @public
+     * @type {Vec3}
+     */
+    _position: Vec3;
+    /**
+     * True if the light is directional.
+     * @public
+     * @type {boolean}
+     */
+    directional: boolean;
+    /**
+     * Ambient color.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _ambient: Vec3;
+    /**
+     * Diffuse color.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _diffuse: Vec3;
+    /**
+     * Specular color.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _specular: Vec3;
+    /**
+     * Shininess.
+     * @protected
+     * @type {number}
+     */
+    protected _shininess: number;
+    /**
+     * Light activity.
+     * @protected
+     * @type {boolean}
+     */
+    protected _active: boolean;
+    protected _tempAmbient: Vec3;
+    protected _tempDiffuse: Vec3;
+    protected _tempSpecular: Vec3;
+    protected _tempShininess: number;
+    constructor(name: string, params: ILightSourceParams);
+    /**
+     * Creates clone of the current light object.
+     * @todo: TODO
+     * @public
+     * @returns {LightSource}
+     */
+    clone(): void;
+    /**
+     * Set light activity. If activity is false the light doesn't shine.
+     * @public
+     * @param {boolean} active - Light activity.
+     */
+    setActive(active: boolean): void;
+    /**
+     * Gets light activity.
+     * @public
+     * @returns {boolean}
+     */
+    isActive(): boolean;
+    /**
+     * Set light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @param {Vec3} position - Light position or direction vector.
+     */
+    setPosition3v(position: Vec3): void;
+    /**
+     * Set light source position, or if it is a directional type sets light direction vector.
+     * @public
+     */
+    setPosition(x: number, y: number, z: number): void;
+    /**
+     * Returns light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @returns {Vec3} - Light source position/direction.
+     */
+    getPosition(): Vec3;
+    /**
+     * Set ambient color.
+     * @public
+     * @param {Vec3} rgb - Ambient color.
+     */
+    setAmbient3v(rgb: Vec3): void;
+    /**
+     * Set diffuse color.
+     * @public
+     * @param {Vec3} rgb - Diffuse color.
+     */
+    setDiffuse3v(rgb: Vec3): void;
+    /**
+     * Set specular color.
+     * @public
+     * @param {Vec3} rgb - Specular color.
+     */
+    setSpecular3v(rgb: Vec3): void;
+    /**
+     * Set ambient color.
+     * @public
+     */
+    setAmbient(r: number, g: number, b: number): void;
+    /**
+     * Set diffuse color.
+     * @public
+     */
+    setDiffuse(r: number, g: number, b: number): void;
+    /**
+     * Set specular color.
+     * @public
+     */
+    setSpecular(r: number, g: number, b: number): void;
+    /**
+     * Set material shininess.
+     * @public
+     */
+    setShininess(shininess: number): void;
+    /**
+     * Sets light to black.
+     * @public
+     */
+    setBlack(): void;
+    /**
+     * Adds current light to the render node scene.
+     * @public
+     * @param {RenderNode} renderNode - Render node scene.
+     */
+    addTo(renderNode: RenderNode): void;
+    /**
+     * Removes from render node scene.
+     * @public
+     */
+    remove(): void;
+}
+export { LightSource };