@openglobus/og 0.17.2 → 0.18.0

package/types/layer/Layer.d.ts

@@ -1,320 +0,0 @@
-/**
- * @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.displayInLayerSwitcher=true] - Presence of layer in dialog window of LayerSwitcher control.
- * @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.Layer#mousemove
- * @fires og.layer.Layer#mouseenter
- * @fires og.layer.Layer#mouseleave
- * @fires og.layer.Layer#lclick
- * @fires og.layer.Layer#rclick
- * @fires og.layer.Layer#mclick
- * @fires og.layer.Layer#ldblclick
- * @fires og.layer.Layer#rdblclick
- * @fires og.layer.Layer#mdblclick
- * @fires og.layer.Layer#lup
- * @fires og.layer.Layer#rup
- * @fires og.layer.Layer#mup
- * @fires og.layer.Layer#ldown
- * @fires og.layer.Layer#rdown
- * @fires og.layer.Layer#mdown
- * @fires og.layer.Layer#lhold
- * @fires og.layer.Layer#rhold
- * @fires og.layer.Layer#mhold
- * @fires og.layer.Layer#mousewheel
- * @fires og.layer.Layer#touchmove
- * @fires og.layer.Layer#touchstart
- * @fires og.layer.Layer#touchend
- * @fires og.layer.Layer#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;
-    constructor(name: any, options?: {});
-    /**
-     * Layer user name.
-     * @public
-     * @type {string}
-     */
-    public name: string;
-    properties: any;
-    _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;
-    _ambient: Float32Array;
-    _diffuse: Float32Array;
-    _specular: Float32Array;
-    nightTextureCoefficient: any;
-    set diffuse(arg: any);
-    set ambient(arg: any);
-    set specular(arg: any);
-    set shininess(arg: any);
-    get normalMapCreator(): any;
-    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;
-    get isIdle(): any;
-    /**
-     * 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): void;
-    /**
-     * 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;
-    get screenOpacity(): number;
-    _refreshFadingOpacity(): boolean;
-    createMaterial(segment: any): Material;
-    redraw(): void;
-}
-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

@@ -1,45 +0,0 @@
-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

@@ -1,211 +0,0 @@
-/**
- * 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;
-    _geoObjectEntityCollection: 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;
-    /**
-     * Adds layer to the planet.
-     * @public
-     * @param {Planet} planet - Planet scene object.
-     * @returns {layer.Vector} -
-     */
-    public addTo(planet: Planet): layer.Vector;
-    remove(): void;
-    /**
-     * 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 default.
-     * @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 default.
-     * @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 default.
-     * @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;
-    _collectGeoObjectCollectionPASS(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";

package/types/layer/WMS.d.ts

@@ -1,66 +0,0 @@
-/**
- * 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
- */
-export class WMS extends XYZ {
-    static createRequestUrl(url: any, layers: any, format: string, version: string, request: string, srs: any, bbox: any, width: number, height: number, extra: any): string;
-    static get_bbox_v1_1_1(extent: any): string;
-    static get_bbox_v1_3_0(extent: any): string;
-    constructor(name: any, options: any, extra: any);
-    _extra: string;
-    /**
-     * WMS layers string.
-     * @public
-     * @type {string}
-     */
-    public layers: string;
-    /**
-     * WMS tile width.
-     * @public
-     * @type {number}
-     */
-    public imageWidth: number;
-    /**
-     * WMS tile height.
-     * @public
-     * @type {number}
-     */
-    public imageHeight: number;
-    _getBbox: typeof WMS.get_bbox_v1_1_1;
-    _createUrl(segment: any): string;
-    setVersion(version: any): void;
-    _version: any;
-}
-import { XYZ } from "./XYZ.js";