@openglobus/og 0.12.1 → 0.13.0

package/types/layer/GeoVideo.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Used to load and display a video stream by specific corners coordinates on the globe, implements og.layer.BaseGeoImage interface.
+ * @class
+ * @extends {BaseGeoImage}
+ */
+export class GeoVideo extends BaseGeoImage {
+    /**
+     * HTML5 video element object.
+     * @private
+     * @type {Object}
+     */
+    private _video;
+    /**
+     * VIdeo source url path.
+     * @private
+     * @type {String}
+     */
+    private _src;
+    /**
+     * Sets video source url path.
+     * @public
+     * @param {String} srs - Video url path.
+     */
+    public setSrc(src: any): void;
+    /**
+     * Sets HTML5 video object.
+     * @public
+     * @param {Object} video - HTML5 video element object.
+     */
+    public setVideoElement(video: any): void;
+    /**
+     * Creates or refresh source video GL texture.
+     * @virtual
+     * @protected
+     */
+    protected _createSourceTexture(): void;
+    /**
+     * @private
+     */
+    private _onCanPlay;
+    /**
+     * @private
+     */
+    private _onError;
+    /**
+     * Loads planet segment material. In this case - GeoImage source video.
+     * @virtual
+     * @public
+     * @param {Material} material - GeoImage planet material.
+     */
+    public loadMaterial(material: Material): void;
+    _renderingProjType1(): void;
+    _renderingProjType0(): void;
+}
+import { BaseGeoImage } from "./BaseGeoImage.js";

package/types/layer/KML.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Layer to render KMLs files
+ * @class
+ * @extends {Vector}
+ */
+export class KML extends Vector {
+    _billboard: any;
+    /**
+     * @type {string}
+     */
+    _color: string;
+    /**
+     * @public
+     */
+    public _extractCoordonatesFromKml(xmlDoc: any): any[];
+    /**
+     * Creates billboards or polylines from array of lonlat.
+     * @public
+     * @param {Array} coordonates
+     * @param {string} color
+     * @returns {Array<Entity>}
+     */
+    public _convertCoordonatesIntoEntities(coordinates: any, color: string, billboard: any): Array<Entity>;
+    /**
+     * @public
+     * @returns {Document}
+     */
+    public _getXmlContent(file: any): Document;
+    /**
+     * @public
+     */
+    public _expandExtents(extent1: any, extent2: any): any;
+    /**
+     * @public
+     * @param {File[]} kmls
+     * @param {string} [color]
+     * @param {Billboard} [billboard]
+     * @returns {Promise<{entities: Entity[], extent: Extent}>}
+     */
+    public addKmlFromFiles(kmls: File[], color?: string, billboard?: Billboard): Promise<{
+        entities: Entity[];
+        extent: Extent;
+    }>;
+    /**
+     * @param {string} color
+     * @public
+     */
+    public setColor(color: string): void;
+    /**
+     * @public
+     */
+    public _getKmlFromUrl(url: any): Promise<any>;
+    /**
+     * @public
+     * @param {string} url - Url of the KML to display. './myFile.kml' or 'http://mySite/myFile.kml' for example.
+     * @param {string} [color]
+     * @param {Billboard} [billboard]
+     * @returns {Promise<{entities: Entity[], extent: Extent}>}
+     */
+    public addKmlFromUrl(url: string, color?: string, billboard?: Billboard): Promise<{
+        entities: Entity[];
+        extent: Extent;
+    }>;
+}
+import { Vector } from "./Vector.js";
+import { Entity } from "../entity/Entity.js";
+import { Billboard } from "../entity/Billboard.js";
+import { Extent } from "../Extent.js";

package/types/layer/Layer.d.ts

@@ -0,0 +1,315 @@
+export const FADING_FACTOR: 0.29;
+/**
+ * @classdesc
+ * Base class; normally only used for creating subclasses and not instantiated in apps.
+ * A visual representation of raster or vector map data well known as a layer.
+ * @class
+ * @param {String} [name="noname"] - Layer name.
+ * @param {Object} [options] - Layer 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] - This is a base layer.
+ * @param {boolean} [options.visibility=true] - Layer visibility.
+ * @param {boolean} [options.isSRGB=false] - Layer image webgl nternal format.
+ * @param {Extent} [options.extent=[[-180.0, -90.0], [180.0, 90.0]]] - Visible extent.
+ * @param {string} [options.textureFilter="anisotropic"] - Image texture filter. Available values: "nearest", "linear", "mipmap" and "anisotropic".
+ *
+ * @fires og.Layer#visibilitychange
+ * @fires og.Layer#add
+ * @fires og.Layer#remove
+ * @fires og.layer.Vector#mousemove
+ * @fires og.layer.Vector#mouseenter
+ * @fires og.layer.Vector#mouseleave
+ * @fires og.layer.Vector#lclick
+ * @fires og.layer.Vector#rclick
+ * @fires og.layer.Vector#mclick
+ * @fires og.layer.Vector#ldblclick
+ * @fires og.layer.Vector#rdblclick
+ * @fires og.layer.Vector#mdblclick
+ * @fires og.layer.Vector#lup
+ * @fires og.layer.Vector#rup
+ * @fires og.layer.Vector#mup
+ * @fires og.layer.Vector#ldown
+ * @fires og.layer.Vector#rdown
+ * @fires og.layer.Vector#mdown
+ * @fires og.layer.Vector#lhold
+ * @fires og.layer.Vector#rhold
+ * @fires og.layer.Vector#mhold
+ * @fires og.layer.Vector#mousewheel
+ * @fires og.layer.Vector#touchmove
+ * @fires og.layer.Vector#touchstart
+ * @fires og.layer.Vector#touchend
+ * @fires og.layer.Vector#doubletouch
+ */
+export class Layer {
+    static getTMS(x: any, y: any, z: any): {
+        x: any;
+        y: number;
+        z: any;
+    };
+    static getTileIndex(...arr: any[]): string;
+    static set __layersCounter(arg: any);
+    static get __layersCounter(): any;
+    static set __requestsCounter(arg: any);
+    static get __requestsCounter(): any;
+    /**
+     * Maximum loading queries at one time.
+     * @const
+     * @type {number}
+     */
+    static get MAX_REQUESTS(): number;
+    constructor(name: any, options?: {});
+    /**
+     * Layer user name.
+     * @public
+     * @type {string}
+     */
+    public name: string;
+    _labelMaxLetters: any;
+    displayInLayerSwitcher: any;
+    _hasImageryTiles: boolean;
+    /**
+     * Layer global opacity.
+     * @public
+     * @type {number}
+     */
+    public _opacity: number;
+    /**
+     * Minimal zoom level when layer is visibile.
+     * @public
+     * @type {number}
+     */
+    public minZoom: number;
+    /**
+     * Maximal zoom level when layer is visibile.
+     * @public
+     * @type {number}
+     */
+    public maxZoom: number;
+    /**
+     * Planet node.
+     * @protected
+     * @type {Planet}
+     */
+    protected _planet: Planet;
+    /**
+     * Unic identifier.
+     * @protected
+     * @type {number}
+     */
+    protected _id: number;
+    /**
+     * Layer attribution.
+     * @protected
+     * @type {string}
+     */
+    protected _attribution: string;
+    /**
+     * Layer z-index.
+     * @protected
+     * @type {number}
+     */
+    protected _zIndex: number;
+    /**
+     * Base layer type flag.
+     * @protected
+     * @type {boolean}
+     */
+    protected _isBaseLayer: boolean;
+    _defaultTextures: any;
+    /**
+     * Layer visibility.
+     * @protected
+     * @type {boolean}
+     */
+    protected _visibility: boolean;
+    _fading: any;
+    _fadingFactor: number;
+    _fadingOpacity: number;
+    /**
+     * Height over the ground.
+     * @protected
+     * @type {number}
+     */
+    protected _height: number;
+    /**
+     * Visible degrees extent.
+     * @protected
+     * @type {Extent}
+     */
+    protected _extent: Extent;
+    createTexture: any;
+    _textureFilter: any;
+    _isSRGB: any;
+    _internalFormat: any;
+    /**
+     * Visible mercator extent.
+     * @protected
+     * @type {Extent}
+     */
+    protected _extentMerc: Extent;
+    /**
+     * Layer picking color. Assign when added to the planet.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _pickingColor: Vec3;
+    _pickingEnabled: any;
+    _isPreloadDone: boolean;
+    _preLoadZoomLevels: any;
+    /**
+     * Events handler.
+     * @public
+     * @type {Events}
+     */
+    public events: Events;
+    get instanceName(): string;
+    get rendererEvents(): Events;
+    set opacity(arg: number);
+    get opacity(): number;
+    set pickingEnabled(arg: boolean);
+    get pickingEnabled(): boolean;
+    /**
+     * Returns true if a layer has imagery tiles.
+     * @public
+     * @virtual
+     * @returns {boolean} - Imagery tiles flag.
+     */
+    public hasImageryTiles(): boolean;
+    /**
+     * Gets layer identifier.
+     * @public
+     * @returns {string} - Layer object id.
+     */
+    public getID(): string;
+    /**
+     * Compares layers instances.
+     * @public
+     * @param {Layer} layer - Layer instance to compare.
+     * @returns {boolean} - Returns true if the layers is the same instance of the input.
+     */
+    public isEqual(layer: Layer): boolean;
+    /**
+     * Assign the planet.
+     * @protected
+     * @virtual
+     * @param {Planet} planet - Planet render node.
+     */
+    protected _assignPlanet(planet: Planet): void;
+    /**
+     * Assign picking color to the layer.
+     * @protected
+     * @virtual
+     */
+    protected _bindPicking(): void;
+    /**
+     * Adds layer to the planet.
+     * @public
+     * @param {Planet} planet - Adds layer to the planet.
+     */
+    public addTo(planet: Planet): Layer;
+    /**
+     * Removes from planet.
+     * @public
+     * @returns {Layer} -This layer.
+     */
+    public remove(): Layer;
+    /**
+     * Clears layer material.
+     * @virtual
+     */
+    clear(): void;
+    /**
+     * Returns planet instance.
+     * @virtual
+     */
+    get planet(): Planet;
+    /**
+     * Sets layer attribution text.
+     * @public
+     * @param {string} html - HTML code that represents layer attribution, it could be just a text.
+     */
+    public setAttribution(html: string): void;
+    /**
+     * Sets height over the ground.
+     * @public
+     * @param {number} height - Layer height.
+     */
+    public setHeight(height: number): void;
+    /**
+     * Gets layer height.
+     * @public
+     * @returns {number} -
+     */
+    public getHeight(): number;
+    /**
+     * Sets z-index.
+     * @public
+     * @param {number} zIndex - Layer z-index.
+     */
+    public setZIndex(zIndex: number): void;
+    /**
+     * Gets z-index.
+     * @public
+     * @returns {number} -
+     */
+    public getZIndex(): number;
+    /**
+     * Set zIndex to the maximal value depend on other layers on the planet.
+     * @public
+     */
+    public bringToFront(): void;
+    /**
+     * Returns true if the layer is a base.
+     * @public
+     * @returns {boolean} - Base layer flag.
+     */
+    public isBaseLayer(): boolean;
+    /**
+     * Sets base layer type true.
+     * @public
+     * @param {boolean} flag - Base layer flag.
+     */
+    public setBaseLayer(flag: boolean): void;
+    /**
+     * Sets layer visibility.
+     * @public
+     * @virtual
+     * @param {boolean} visibility - Layer visibility.
+     */
+    public setVisibility(visibility: boolean): void;
+    _forceMaterialApply(segment: any): void;
+    _preLoadRecursive(node: any, maxZoom: any): void;
+    _preLoad(): void;
+    /**
+     * Gets layer visibility.
+     * @public
+     * @returns {boolean} - Layer visibility.
+     */
+    public getVisibility(): boolean;
+    /**
+     * Sets visible geographical extent.
+     * @public
+     * @param {Extent} extent - Layer visible geographical extent.
+     */
+    public setExtent(extent: Extent): void;
+    /**
+     * Gets layer extent.
+     * @public
+     * @return {Extent} - Layer geodetic extent.
+     */
+    public getExtent(): Extent;
+    /**
+     * Special correction of the whole globe extent.
+     * @protected
+     */
+    protected _correctFullExtent(): void;
+    _refreshFadingOpacity(): boolean;
+    createMaterial(segment: any): Material;
+}
+import { Extent } from "../Extent.js";
+import { Vec3 } from "../math/Vec3.js";
+import { Events } from "../Events.js";
+import { Material } from "./Material.js";

package/types/layer/Material.d.ts

@@ -0,0 +1,45 @@
+export class Material {
+    /**
+     *
+     * @param {*} segment
+     * @param {*} layer
+     */
+    constructor(segment: any, layer: any);
+    segment: any;
+    layer: any;
+    isReady: boolean;
+    isLoading: boolean;
+    texture: any;
+    pickingMask: any;
+    textureExists: boolean;
+    appliedNodeId: number;
+    texOffset: number[];
+    loadingAttempts: number;
+    _updateTexture: any;
+    _updatePickingMask: any;
+    pickingReady: boolean;
+    /**
+     *
+     */
+    abortLoading(): void;
+    _createTexture(img: any): any;
+    /**
+     *
+     * @param {*} img
+     */
+    applyImage(img: any): void;
+    /**
+     *
+     * @param {*} texture
+     * @param {*} pickingMask
+     */
+    applyTexture(texture: any, pickingMask: any): void;
+    /**
+     *
+     */
+    textureNotExists(): void;
+    /**
+     *
+     */
+    clear(): void;
+}

package/types/layer/Vector.d.ts

@@ -0,0 +1,201 @@
+/**
+ * Vector layer represents alternative entities store. Used for geospatial data rendering like
+ * points, lines, polygons, geometry objects etc.
+ * @class
+ * @extends {Layer}
+ * @param {string} [name="noname"] - Layer name.
+ * @param {Object} [options] - Layer options:
+ * @param {number} [options.minZoom=0] - Minimal visible zoom. 0 is default
+ * @param {number} [options.maxZoom=50] - Maximal visible zoom. 50 is default.
+ * @param {string} [options.attribution] - Layer attribution.
+ * @param {string} [options.zIndex=0] - Layer Z-order index. 0 is default.
+ * @param {boolean} [options.visibility=true] - Layer visibility. True is default.
+ * @param {boolean} [options.isBaseLayer=false] - Layer base layer. False is default.
+ * @param {Array.<Entity>} [options.entities] - Entities array.
+ * @param {Array.<number>} [options.scaleByDistance] - Scale by distance parameters. (exactly 3 entries)
+ *      First index - near distance to the entity, after entity becomes full scale.
+ *      Second index - far distance to the entity, when entity becomes zero scale.
+ *      Third index - far distance to the entity, when entity becomes invisible.
+ * @param {number} [options.nodeCapacity=30] - Maximum entities quantity in the tree node. Rendering optimization parameter. 30 is default.
+ * @param {boolean} [options.async=true] - Asynchronous vector data handling before rendering. True for optimization huge data.
+ * @param {boolean} [options.clampToGround = false] - Clamp vector data to the ground.
+ * @param {boolean} [options.relativeToGround = false] - Place vector data relative to the ground relief.
+ * @param {Number} [options.polygonOffsetUnits=0.0] - The multiplier by which an implementation-specific value is multiplied with to create a constant depth offset.
+ *
+ * @fires og.layer.Vector#entitymove
+ * @fires og.layer.Vector#draw
+ * @fires og.layer.Vector#add
+ * @fires og.layer.Vector#remove
+ * @fires og.layer.Vector#entityadd
+ * @fires og.layer.Vector#entityremove
+ * @fires og.layer.Vector#visibilitychange
+ */
+export class Vector extends Layer {
+    /**
+     * @param {string} name
+     * @param {*} [options]
+     */
+    constructor(name: string, options?: any);
+    isVector: boolean;
+    /**
+     * First index - near distance to the entity, after that entity becomes full scale.
+     * Second index - far distance to the entity, when entity becomes zero scale.
+     * Third index - far distance to the entity, when entity becomes invisible.
+     * @public
+     * @type {Array.<number>} - (exactly 3 entries)
+     */
+    public scaleByDistance: Array<number>;
+    pickingScale: any;
+    /**
+     * Asynchronous data handling before rendering.
+     * @public
+     * @type {boolean}
+     */
+    public async: boolean;
+    /**
+     * Vector data clamp to ground flag.
+     * @public
+     * @type {boolean}
+     */
+    public clampToGround: boolean;
+    /**
+     * Sets vector data relative to the ground relief.
+     * @public
+     * @type {boolean}
+     */
+    public relativeToGround: boolean;
+    /**
+     * Maximum entities quantity in the tree node.
+     * @private
+     */
+    private _nodeCapacity;
+    /**
+     * Stored entities.
+     * @private
+     */
+    private _entities;
+    _stripEntityCollection: EntityCollection;
+    _polylineEntityCollection: EntityCollection;
+    _geometryHandler: GeometryHandler;
+    _entityCollectionsTree: EntityCollectionNode;
+    _entityCollectionsTreeNorth: EntityCollectionNodeWGS84;
+    _entityCollectionsTreeSouth: EntityCollectionNodeWGS84;
+    _renderingNodes: {};
+    _renderingNodesNorth: {};
+    _renderingNodesSouth: {};
+    _counter: number;
+    _deferredEntitiesPendingQueue: QueueArray;
+    _pendingsQueue: any[];
+    /**
+     * Specifies the scale Units for gl.polygonOffset function to calculate depth values, 0.0 is default.
+     * @public
+     * @type {Number}
+     */
+    public polygonOffsetUnits: number;
+    /**
+     * Returns stored entities.
+     * @public
+     * @returns {Array.<Entity>} -
+     */
+    public getEntities(): Array<Entity>;
+    /**
+     * Adds entity to the layer.
+     * @public
+     * @param {Entity} entity - Entity.
+     * @param {boolean} [rightNow] - Entity insertion option. False is deafult.
+     * @returns {layer.Vector} - Returns this layer.
+     */
+    public add(entity: Entity, rightNow?: boolean): layer.Vector;
+    /**
+     * Adds entity to the layer in the index position.
+     * @public
+     * @param {Entity} entity - Entity.
+     * @param {Number} index - Index position.
+     * @param {boolean} [rightNow] - Entity insertion option. False is deafult.
+     * @returns {layer.Vector} - Returns this layer.
+     */
+    public insert(entity: Entity, index: number, rightNow?: boolean): layer.Vector;
+    _proceedEntity(entity: any, rightNow: any): void;
+    /**
+     * Adds entity array to the layer.
+     * @public
+     * @param {Array.<Entity>} entities - Entities array.
+     * @param {boolean} [rightNow] - Entity insertion option. False is deafult.
+     * @returns {layer.Vector} - Returns this layer.
+     */
+    public addEntities(entities: Array<Entity>, rightNow?: boolean): layer.Vector;
+    /**
+     * Remove entity from layer.
+     * TODO: memory leaks.
+     * @public
+     * @param {Entity} entity - Entity to remove.
+     * @returns {layer.Vector} - Returns this layer.
+     */
+    public removeEntity(entity: Entity): layer.Vector;
+    /**
+     * Refresh collected entities indexes from startIndex entitytes collection array position.
+     * @public
+     * @param {number} startIndex - Entity array index.
+     */
+    public _reindexEntitiesArray(startIndex: number): void;
+    /**
+     * Removes entities from layer.
+     * @public
+     * @param {Array.<Entity>} entities - Entity array.
+     * @returns {layer.Vector} - Returns this layer.
+     */
+    public removeEntities(entities: Array<Entity>): layer.Vector;
+    /**
+     * Sets scale by distance parameters.
+     * @public
+     * @param {number} near - Full scale entity distance.
+     * @param {number} far - Zerol scale entity distance.
+     * @param {number} [farInvisible] - Entity visibility distance.
+     * @returns {layer.Vector} -
+     */
+    public setScaleByDistance(near: number, far: number, farInvisible?: number): layer.Vector;
+    /**
+     * Safety entities loop.
+     * @public
+     * @param {callback} callback - Entity callback.
+     */
+    public each(callback: any): void;
+    /**
+     * Removes current entities from layer and adds new entities.
+     * @public
+     * @param {Array.<Entity>} entities - New entity array.
+     * @returns {layer.Vector} - Returns layer instance.
+     */
+    public setEntities(entities: Array<Entity>): layer.Vector;
+    _createEntityCollectionsTree(entitiesForTree: any): void;
+    _bindEventsDefault(entityCollection: any): void;
+    _collectStripCollectionPASS(outArr: any): void;
+    _collectPolylineCollectionPASS(outArr: any): void;
+    collectVisibleCollections(outArr: any): void;
+    _secondPASS: any[];
+    _queueDeferredNode(node: any): void;
+    _execDeferredNode(node: any): void;
+    /**
+     * Start to load tile material.
+     * @public
+     * @virtual
+     * @param {Segment.Material} material - Current material.
+     */
+    public loadMaterial(material: Segment.Material): void;
+    /**
+     * Abort exact material loading.
+     * @public
+     * @param {Material} material - Segment material.
+     */
+    public abortMaterialLoading(material: Material): void;
+    applyMaterial(material: any): number[];
+    clearMaterial(material: any): void;
+    update(): void;
+}
+import { Layer } from "./Layer.js";
+import { EntityCollection } from "../entity/EntityCollection.js";
+import { GeometryHandler } from "../entity/GeometryHandler.js";
+import { EntityCollectionNode } from "../quadTree/EntityCollectionNode.js";
+import { EntityCollectionNodeWGS84 } from "../quadTree/EntityCollectionNode.js";
+import { QueueArray } from "../QueueArray.js";
+import { Entity } from "../entity/Entity.js";