@openglobus/og 0.11.1 → 0.11.6

package/types/layer/BaseGeoImage.d.ts

@@ -1,9 +1,9 @@
 /**
  * BaseGeoImage layer represents square imagery layer that could be an static image, or animated video or webgl buffer object displayed on the globe.
  * @class
- * @extends {og.Layer}
+ * @extends {Layer}
  */
-export class BaseGeoImage {
+export class BaseGeoImage extends Layer {
     constructor(name: any, options: any);
     _projType: number;
     _frameWidth: number;
@@ -12,7 +12,7 @@ export class BaseGeoImage {
     _sourceTexture: any;
     _materialTexture: any;
     _gridBuffer: any;
-    _extentWgs84Params: any[];
+    _extentWgs84Params: number[];
     _refreshFrame: boolean;
     _frameCreated: boolean;
     _sourceCreated: boolean;
@@ -21,75 +21,61 @@ export class BaseGeoImage {
     _creationProceeding: boolean;
     _isRendering: boolean;
     _extentWgs84: Extent;
-    _cornersWgs84: any[];
+    _cornersWgs84: number[] | LonLat[];
     rendering: any;
-    get instanceName(): string;
     /**
      * Gets corners coordinates.
      * @public
-     * @return {Array.<og.LonLat,og.LonLat,og.LonLat,og.LonLat>} -
+     * @return {Array.<LonLat>} - (exactly 4 entries)
      */
-    public getCornersLonLat(): Array<any, any, any, any>;
+    public getCornersLonLat(): Array<LonLat>;
     /**
      * Gets corners coordinates.
      * @public
-     * @return {Array.<Array<number,number,number>>} -
+     * @return {Array.<Array<number>>} - (exactly 3 entries)
      */
-    public getCorners(): Array<Array<number, number, number>>;
+    public getCorners(): Array<Array<number>>;
     /**
      * Sets geoImage geographical corners coordinates.
      * @public
-     * @param {Array.<Array.<number,number,number>>} corners - GeoImage corners coordinates. Where first coordinate
+     * @param {Array.<Array.<number>>} corners - GeoImage corners coordinates. Where first coordinate (exactly 3 entries)
      * coincedents to the left top image corner, secont to the right top image corner, third to the right bottom
      * and fourth - left bottom image corner.
      */
-    public setCorners(corners: Array<Array<number, number, number>>): void;
+    public setCorners(corners: Array<Array<number>>): void;
     /**
      * Sets geoImage geographical corners coordinates.
      * @public
-     * @param {Array.<og.LonLat, og.LonLat, og.LonLat, og.LonLat>} corners - GeoImage corners coordinates. Where first coordinate
+     * @param {Array.<LonLat>} corners - GeoImage corners coordinates. Where first coordinate
      * coincedents to the left top image corner, secont to the right top image corner, third to the right bottom
-     * and fourth - left bottom image corner.
+     * and fourth - left bottom image corner. (exactly 4 entries)
      */
-    public setCornersLonLat(corners: Array<any, any, any, any>): void;
+    public setCornersLonLat(corners: Array<LonLat>): void;
     /**
      * Creates geoImage frame.
      * @protected
      */
     protected _createFrame(): void;
     _cornersMerc: any[];
-    _extentMerc: Extent;
-    _extentMercParams: any[];
-    /**
-     * @virtual
-     * @param {og.planetSegment.Material} material - GeoImage material.
-     */
-    abortMaterialLoading(material: any): void;
+    _extentMercParams: number[];
     /**
-     * Clear layer material.
-     * @virtual
-     */
-    clear(): void;
-    /**
-     * Sets layer visibility.
-     * @public
      * @virtual
-     * @param {boolean} visibility - GeoImage visibility.
+     * @param {Material} material - GeoImage material.
      */
-    public setVisibility(visibility: boolean): void;
+    abortMaterialLoading(material: Material): void;
     /**
      * @virtual
      * @protected
-     * @param {og.planetSegment.Material} material - GeoImage material.
+     * @param {Material} material - GeoImage material.
      */
-    protected clearMaterial(material: any): void;
+    protected clearMaterial(material: Material): void;
     /**
      * @virtual
      * @protected
-     * @param {og.planetSegment.Material} material - GeoImage material.
-     * @returns {Array<Number, Number, Number, Number> } -
+     * @param {Material} material - GeoImage material.
+     * @returns {Array<number> } -
      */
-    protected applyMaterial(material: any): Array<number, number, number, number>;
+    protected applyMaterial(material: Material): Array<number>;
     /**
      * Gets frame width size in pixels.
      * @public
@@ -103,4 +89,6 @@ export class BaseGeoImage {
      */
     public get getFrameHeight(): number;
 }
+import { Layer } from "./Layer.js";
 import { Extent } from "../Extent.js";
+import { LonLat } from "../LonLat.js";

package/types/layer/CanvasTiles.d.ts

@@ -1,22 +1,22 @@
 /**
  * Layer used to rendering each tile as a separate canvas object.
  * @class
- * @extends {og.Layer}
+ * @extends {Layer}
  * //TODO: make asynchronous handler.
  * @param {String} [name="noname"] - Layer name.
  * @param {Object} options:
  * @param {number} [options.opacity=1.0] - Layer opacity.
- * @param {Array.<number,number,number>} [options.transparentColor=[-1,-1,-1]] - RGB color that defines transparent color.
+ * @param {Array.<number>} [options.transparentColor=[-1,-1,-1]] - RGB color that defines transparent color. (exactly 3 entries)
  * @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 {og.layer.CanvasTiles~drawTileCallback} [options.drawTile] - Draw tile callback.
+ * @param {layer.CanvasTiles~drawTileCallback} [options.drawTile] - Draw tile callback.
  * @fires og.layer.CanvasTiles#load
  * @fires og.layer.CanvasTiles#loadend
  */
-export class CanvasTiles {
+export class CanvasTiles extends Layer {
     constructor(name: any, options: any);
     /**
      * Current creating tiles couter.
@@ -27,49 +27,42 @@ export class CanvasTiles {
     /**
      * Tile pending queue that waiting for create.
      * @protected
-     * @type {Array.<og.planetSegment.Material>}
+     * @type {Array.<planetSegment.Material>}
      */
-    protected _pendingsQueue: Array<any>;
+    protected _pendingsQueue: Array<planetSegment.Material>;
     /**
      * Draw tile callback.
-     * @type {og.layer.CanvasTiles~drawTileCallback}
+     * @type {layer.CanvasTiles~drawTileCallback}
      * @public
      */
-    public drawTile: any;
-    get instanceName(): string;
+    public drawTile: layer.CanvasTiles;
     /**
      * Abort loading tiles.
      * @public
      */
     public abortLoading(): void;
-    /**
-     * Sets layer visibility.
-     * @public
-     * @param {boolean} visibility - Layer visibility.
-     */
-    public setVisibility(visibility: boolean): void;
-    _visibility: any;
     /**
      * Start to load tile material.
      * @public
      * @virtual
-     * @param {og.planetSegment.Material} material -
+     * @param {Material} material -
      */
-    public loadMaterial(material: any): void;
+    public loadMaterial(material: Material): void;
     /**
      * Loads material image and apply it to the planet segment.
      * @protected
-     * @param {og.planetSegment.Material} material - Loads material image.
+     * @param {Material} material - Loads material image.
      */
-    protected _exec(material: any): void;
+    protected _exec(material: Material): void;
     /**
      * Abort exact material loading.
      * @public
-     * @param {og.planetSegment.Material} material - Segment material.
+     * @param {Material} material - Segment material.
      */
-    public abortMaterialLoading(material: any): void;
+    public abortMaterialLoading(material: Material): void;
     _dequeueRequest(): void;
     _whilePendings(): any;
     applyMaterial(material: any): number[];
     clearMaterial(material: any): void;
 }
+import { Layer } from "./Layer.js";

package/types/layer/GeoImage.d.ts

@@ -1,10 +1,9 @@
 /**
  * Used to load and display a single image over specific corner coordinates on the globe, implements og.layer.BaseGeoImage interface.
  * @class
- * @extends {og.layer.BaseGeoImage}
+ * @extends {BaseGeoImage}
  */
-export class GeoImage {
-    constructor(name: any, options: any);
+export class GeoImage extends BaseGeoImage {
     /**
      * Image object.
      * @private
@@ -17,14 +16,12 @@ export class GeoImage {
      * @type {String}
      */
     private _src;
-    get instanceName(): string;
     /**
      * Sets image source url path.
      * @public
      * @param {String} srs - Image url path.
      */
     public setSrc(src: any): void;
-    _sourceReady: boolean;
     /**
      * Sets image object.
      * @public
@@ -37,29 +34,19 @@ export class GeoImage {
      * @protected
      */
     protected _createSourceTexture(): void;
-    _sourceTexture: any;
-    _sourceCreated: boolean;
     /**
      * @private
      * @param {Image} img
      */
     private _onLoad;
-    _frameWidth: any;
-    _frameHeight: any;
     /**
      * Loads planet segment material. In this case - GeoImage source image.
      * @virtual
      * @public
-     * @param {og.planetSegment.Material} material - GeoImage planet material.
+     * @param {Material} material - GeoImage planet material.
      */
-    public loadMaterial(material: any): void;
-    _creationProceeding: boolean;
-    /**
-     * @virtual
-     * @param {og.planetSegment.Material} material - GeoImage material.
-     */
-    abortMaterialLoading(material: any): void;
+    public loadMaterial(material: Material): void;
     _renderingProjType1(): void;
-    _ready: boolean;
     _renderingProjType0(): void;
 }
+import { BaseGeoImage } from "./BaseGeoImage.js";

package/types/layer/GeoVideo.d.ts

@@ -1,16 +1,9 @@
 /**
  * Used to load and display a video stream by specific corners coordinates on the globe, implements og.layer.BaseGeoImage interface.
  * @class
- * @extends {og.layer.BaseGeoImage}
+ * @extends {BaseGeoImage}
  */
-export class GeoVideo {
-    constructor(name: any, options: any);
-    /**
-     * @protected
-     * @const
-     * @type {Boolean}
-     */
-    protected _animate: boolean;
+export class GeoVideo extends BaseGeoImage {
     /**
      * HTML5 video element object.
      * @private
@@ -23,40 +16,28 @@ export class GeoVideo {
      * @type {String}
      */
     private _src;
-    get instanceName(): string;
     /**
      * Sets video source url path.
      * @public
      * @param {String} srs - Video url path.
      */
     public setSrc(src: any): void;
-    _sourceReady: boolean;
     /**
      * Sets HTML5 video object.
      * @public
      * @param {Object} video - HTML5 video element object.
      */
     public setVideoElement(video: any): void;
-    /**
-     * Sets layer visibility.
-     * @public
-     * @param {boolean} visibility - Layer visibility.
-     */
-    public setVisibility(visibility: boolean): void;
     /**
      * Creates or refresh source video GL texture.
      * @virtual
      * @protected
      */
     protected _createSourceTexture(): void;
-    _sourceTexture: any;
-    _sourceCreated: boolean;
     /**
      * @private
      */
     private _onCanPlay;
-    _frameWidth: any;
-    _frameHeight: any;
     /**
      * @private
      */
@@ -65,16 +46,10 @@ export class GeoVideo {
      * Loads planet segment material. In this case - GeoImage source video.
      * @virtual
      * @public
-     * @param {og.planetSegment.Material} material - GeoImage planet material.
-     */
-    public loadMaterial(material: any): void;
-    _creationProceeding: boolean;
-    /**
-     * @virtual
-     * @param {og.planetSegment.Material} material - GeoImage material.
+     * @param {Material} material - GeoImage planet material.
      */
-    abortMaterialLoading(material: any): void;
+    public loadMaterial(material: Material): void;
     _renderingProjType1(): void;
-    _ready: boolean;
     _renderingProjType0(): void;
 }
+import { BaseGeoImage } from "./BaseGeoImage.js";

package/types/layer/KML.d.ts

@@ -1,19 +1,14 @@
 /**
  * Layer to render KMLs files
  * @class
- * @extends {og.Vector}
+ * @extends {Vector}
  */
-export class KML {
+export class KML extends Vector {
+    _billboard: any;
     /**
-     *
-     * @param {string} name
-     * @param {*} [options]
+     * @type {string}
      */
-    constructor(name: string, options?: any);
-    _extent: any;
-    _billboard: any;
-    _color: any;
-    get instanceName(): string;
+    _color: string;
     /**
      * @private
      */
@@ -23,11 +18,12 @@ export class KML {
      * @private
      * @param {Array} coordonates
      * @param {string} color
-     * @returns {Array<og.Entity>}
+     * @returns {Array<Entity>}
      */
     private _convertCoordonatesIntoEntities;
     /**
      * @private
+     * @returns {Document}
      */
     private _getXmlContent;
     /**
@@ -37,9 +33,12 @@ export class KML {
     /**
      * @public
      * @param {File[]} kmls
-     * @returns {Promise}
+     * @returns {Promise<{entities: Entity[], extent: Extent}>}
      */
-    public addKmlFromFiles(kmls: File[]): Promise<any>;
+    public addKmlFromFiles(kmls: File[]): Promise<{
+        entities: Entity[];
+        extent: Extent;
+    }>;
     /**
      * @param {string} color
      * @public
@@ -52,7 +51,13 @@ export class KML {
     /**
      * @public
      * @param {string} url - Url of the KML to display. './myFile.kml' or 'http://mySite/myFile.kml' for example.
-     * @returns {Promise}
+     * @returns {Promise<{entities: Entity[], extent: Extent}>}
      */
-    public addKmlFromUrl(url: string): Promise<any>;
+    public addKmlFromUrl(url: string): Promise<{
+        entities: Entity[];
+        extent: Extent;
+    }>;
 }
+import { Vector } from "./Vector.js";
+import { Entity } from "../entity/Entity.js";
+import { Extent } from "../Extent.js";