@openglobus/og 0.11.7 → 0.12.3

package/types/entity/index.d.ts

@@ -0,0 +1,8 @@
+import { Entity } from "./Entity.js";
+import { EntityCollection } from "./EntityCollection.js";
+import { Billboard } from "./Billboard.js";
+import { Geometry } from "./Geometry.js";
+import { Label } from "./Label.js";
+import { PointCloud } from "./PointCloud.js";
+import { Polyline } from "./Polyline.js";
+export { Entity, EntityCollection, Billboard, Geometry, Label, PointCloud, Polyline };

package/types/index.core.d.ts

@@ -0,0 +1,65 @@
+export namespace bv {
+    export { Box };
+    export { Sphere };
+}
+import * as jd from "./astro/jd.js";
+import * as math from "./math.js";
+import * as utils from "./utils/shared.js";
+import { input } from "./input/input.js";
+import { Control } from "./control/Control.js";
+export namespace control {
+    export { DebugInfo };
+    export { SimpleNavigation };
+    export { ShowFps };
+}
+export namespace webgl {
+    export { Framebuffer };
+    export { Handler };
+    export { Multisample };
+    export { types };
+    export { Program };
+}
+import { Camera } from "./camera/Camera.js";
+import { LightSource } from "./light/LightSource.js";
+import { EntityCollection } from "./entity/EntityCollection.js";
+import { Handler } from "./webgl/Handler.js";
+import { Renderer } from "./renderer/Renderer.js";
+import { Clock } from "./Clock.js";
+import { Events } from "./Events.js";
+export namespace scene {
+    export { Axes };
+}
+import { RenderNode } from "./scene/RenderNode.js";
+import { Line2 } from "./math/Line2.js";
+import { Line3 } from "./math/Line3.js";
+import { Mat3 } from "./math/Mat3.js";
+import { Mat4 } from "./math/Mat4.js";
+import { Plane } from "./math/Plane.js";
+import { Quat } from "./math/Quat.js";
+import { Ray } from "./math/Ray.js";
+import { TextureAtlas } from "./utils/TextureAtlas.js";
+import { Vec2 } from "./math/Vec2.js";
+import { Vec3 } from "./math/Vec3.js";
+import { Vec4 } from "./math/Vec4.js";
+export namespace entity {
+    export { Billboard };
+    export { Label };
+    export { PointCloud };
+    export { Polyline };
+}
+import { Entity } from "./entity/Entity.js";
+import { Box } from "./bv/Box.js";
+import { Sphere } from "./bv/Sphere.js";
+import { DebugInfo } from "./control/DebugInfo";
+import { SimpleNavigation } from "./control/SimpleNavigation.js";
+import { ShowFps } from "./control/ShowFps.js";
+import { Framebuffer } from "./webgl/Framebuffer.js";
+import { Multisample } from "./webgl/Multisample.js";
+import { types } from "./webgl/types.js";
+import { Program } from "./webgl/Program.js";
+import { Axes } from "./scene/Axes.js";
+import { Billboard } from "./entity/Billboard.js";
+import { Label } from "./entity/Label.js";
+import { PointCloud } from "./entity/PointCloud.js";
+import { Polyline } from "./entity/Polyline.js";
+export { jd, math, utils, input, Control, Camera, LightSource, EntityCollection, Handler, Renderer, Clock, Events, RenderNode, Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, TextureAtlas, Vec2, Vec3, Vec4, Entity };

package/types/index.d.ts

@@ -0,0 +1,45 @@
+export namespace version {
+    const version: any;
+}
+import * as bv from "./bv/index.js";
+import * as jd from "./astro/jd.js";
+import * as math from "./math.js";
+import * as mercator from "./mercator.js";
+import * as utils from "./utils/shared.js";
+import { input } from "./input/input.js";
+export const Layer: typeof layer.Layer;
+import * as layer from "./layer/index.js";
+import * as terrain from "./terrain/index.js";
+export const Control: typeof control.Control;
+import * as control from "./control/index.js";
+import * as webgl from "./webgl/index.js";
+import { wgs84 } from "./ellipsoid/index.js";
+import { Camera } from "./camera/index.js";
+import { Ellipsoid } from "./ellipsoid/index.js";
+import { PlanetCamera } from "./camera/index.js";
+import { Globe } from "./Globe.js";
+import { LightSource } from "./light/LightSource.js";
+export const EntityCollection: typeof entity.EntityCollection;
+export const Handler: typeof webgl.Handler;
+import { Renderer } from "./renderer/Renderer.js";
+import { Clock } from "./Clock.js";
+import { Events } from "./Events.js";
+import { Extent } from "./Extent.js";
+import { LonLat } from "./LonLat.js";
+import * as scene from "./scene/index.js";
+import { RenderNode } from "./scene/RenderNode.js";
+import { Line2 } from "./math/index.js";
+import { Line3 } from "./math/index.js";
+import { Mat3 } from "./math/index.js";
+import { Mat4 } from "./math/index.js";
+import { Plane } from "./math/index.js";
+import { Quat } from "./math/index.js";
+import { Ray } from "./math/index.js";
+import { Vec2 } from "./math/index.js";
+import { Vec3 } from "./math/index.js";
+import { Vec4 } from "./math/index.js";
+import * as entity from "./entity/index.js";
+export const Entity: typeof entity.Entity;
+import { Geoid } from "./terrain/Geoid.js";
+import { Popup } from "./Popup.js";
+export { bv, jd, math, mercator, utils, input, layer, terrain, control, webgl, wgs84, Camera, Ellipsoid, PlanetCamera, Globe, LightSource, Renderer, Clock, Events, Extent, LonLat, scene, RenderNode, Line2, Line3, Mat3, Mat4, Plane, Quat, Ray, Vec2, Vec3, Vec4, entity, Geoid, Popup };

package/types/index.webgl.d.ts

@@ -0,0 +1,7 @@
+import { Handler } from "./webgl/Handler.js";
+import { Framebuffer } from "./webgl/Framebuffer.js";
+import { Multisample } from "./webgl/Multisample.js";
+import { types } from "./webgl/types.js";
+import { Program } from "./webgl/Program.js";
+import { TextureAtlas } from "./utils/TextureAtlas.js";
+export { Handler, Framebuffer, Multisample, types, Program, TextureAtlas };

package/types/input/KeyboardHandler.d.ts

@@ -0,0 +1,10 @@
+export class KeyboardHandler {
+    removeEvent: (events: any, callback: any) => void;
+    setActivity: (activity: any) => void;
+    releaseKeys: () => void;
+    addEvent: (event: any, sender: any, callback: any, keyCode: any, priority: any) => void;
+    isKeyPressed: (keyCode: any) => any;
+    handleKeyDown: () => void;
+    handleKeyUp: () => void;
+    handleEvents: () => void;
+}

package/types/input/MouseHandler.d.ts

@@ -0,0 +1,5 @@
+export class MouseHandler {
+    constructor(htmlObject: any);
+    _htmlObject: any;
+    setEvent(event: any, sender: any, callback: any): void;
+}

package/types/input/TouchHandler.d.ts

@@ -0,0 +1,5 @@
+export class TouchHandler {
+    constructor(htmlObject: any);
+    _htmlObject: any;
+    setEvent(event: any, sender: any, callback: any): void;
+}

package/types/input/input.d.ts

@@ -0,0 +1,34 @@
+export namespace input {
+    const KEY_CTRL: number;
+    const KEY_ALT: number;
+    const KEY_SHIFT: number;
+    const KEY_SPACE: number;
+    const KEY_LEFT: number;
+    const KEY_UP: number;
+    const KEY_RIGHT: number;
+    const KEY_DOWN: number;
+    const KEY_PRINTSCREEN: number;
+    const KEY_A: number;
+    const KEY_C: number;
+    const KEY_D: number;
+    const KEY_E: number;
+    const KEY_F: number;
+    const KEY_H: number;
+    const KEY_I: number;
+    const KEY_K: number;
+    const KEY_L: number;
+    const KEY_O: number;
+    const KEY_P: number;
+    const KEY_Q: number;
+    const KEY_R: number;
+    const KEY_S: number;
+    const KEY_V: number;
+    const KEY_W: number;
+    const KEY_X: number;
+    const KEY_Z: number;
+    const KEY_F1: number;
+    const KEY_APOSTROPHE: number;
+    const MB_LEFT: number;
+    const MB_RIGHT: number;
+    const MB_MIDDLE: number;
+}

package/types/layer/BaseGeoImage.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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 {Layer}
+ */
+export class BaseGeoImage extends Layer {
+    constructor(name: any, options: any);
+    _projType: number;
+    _frameWidth: number;
+    _frameHeight: number;
+    _sourceReady: boolean;
+    _sourceTexture: any;
+    _materialTexture: any;
+    _gridBuffer: any;
+    _extentWgs84Params: number[];
+    _refreshFrame: boolean;
+    _frameCreated: boolean;
+    _sourceCreated: boolean;
+    _animate: boolean;
+    _ready: boolean;
+    _creationProceeding: boolean;
+    _isRendering: boolean;
+    _extentWgs84: Extent;
+    _cornersWgs84: number[] | LonLat[];
+    rendering: any;
+    /**
+     * Gets corners coordinates.
+     * @public
+     * @return {Array.<LonLat>} - (exactly 4 entries)
+     */
+    public getCornersLonLat(): Array<LonLat>;
+    /**
+     * Gets corners coordinates.
+     * @public
+     * @return {Array.<Array<number>>} - (exactly 3 entries)
+     */
+    public getCorners(): Array<Array<number>>;
+    /**
+     * Sets geoImage geographical corners coordinates.
+     * @public
+     * @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>>): void;
+    /**
+     * Sets geoImage geographical corners coordinates.
+     * @public
+     * @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. (exactly 4 entries)
+     */
+    public setCornersLonLat(corners: Array<LonLat>): void;
+    /**
+     * Creates geoImage frame.
+     * @protected
+     */
+    protected _createFrame(): void;
+    _cornersMerc: any[];
+    _extentMercParams: number[];
+    /**
+     * @virtual
+     * @param {Material} material - GeoImage material.
+     */
+    abortMaterialLoading(material: Material): void;
+    /**
+     * @virtual
+     * @protected
+     * @param {Material} material - GeoImage material.
+     */
+    protected clearMaterial(material: Material): void;
+    /**
+     * @virtual
+     * @protected
+     * @param {Material} material - GeoImage material.
+     * @returns {Array<number> } -
+     */
+    protected applyMaterial(material: Material): Array<number>;
+    /**
+     * Gets frame width size in pixels.
+     * @public
+     * @returns {Number} Frame width.
+     */
+    public get getFrameWidth(): number;
+    /**
+     * Gets frame height size in pixels.
+     * @public
+     * @returns {Number} Frame height.
+     */
+    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

@@ -0,0 +1,67 @@
+/**
+ * Layer used to rendering each tile as a separate canvas object.
+ * @class
+ * @extends {Layer}
+ * //TODO: make asynchronous handler.
+ * @param {String} [name="noname"] - Layer name.
+ * @param {Object} 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 {layer.CanvasTiles~drawTileCallback} [options.drawTile] - Draw tile callback.
+ * @fires og.layer.CanvasTiles#load
+ * @fires og.layer.CanvasTiles#loadend
+ */
+export class CanvasTiles extends Layer {
+    constructor(name: any, options: any);
+    /**
+     * Current creating tiles couter.
+     * @protected
+     * @type {number}
+     */
+    protected _counter: number;
+    /**
+     * Tile pending queue that waiting for create.
+     * @protected
+     * @type {Array.<planetSegment.Material>}
+     */
+    protected _pendingsQueue: Array<planetSegment.Material>;
+    /**
+     * Draw tile callback.
+     * @type {layer.CanvasTiles~drawTileCallback}
+     * @public
+     */
+    public drawTile: layer.CanvasTiles;
+    /**
+     * Abort loading tiles.
+     * @public
+     */
+    public abortLoading(): void;
+    /**
+     * Start to load tile material.
+     * @public
+     * @virtual
+     * @param {Material} material -
+     */
+    public loadMaterial(material: Material): void;
+    /**
+     * Loads material image and apply it to the planet segment.
+     * @protected
+     * @param {Material} material - Loads material image.
+     */
+    protected _exec(material: Material): void;
+    /**
+     * Abort exact material loading.
+     * @public
+     * @param {Material} material - Segment material.
+     */
+    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

@@ -0,0 +1,52 @@
+/**
+ * Used to load and display a single image over specific corner coordinates on the globe, implements og.layer.BaseGeoImage interface.
+ * @class
+ * @extends {BaseGeoImage}
+ */
+export class GeoImage extends BaseGeoImage {
+    /**
+     * Image object.
+     * @private
+     * @type {Image}
+     */
+    private _image;
+    /**
+     * Image source url path.
+     * @private
+     * @type {String}
+     */
+    private _src;
+    /**
+     * Sets image source url path.
+     * @public
+     * @param {String} srs - Image url path.
+     */
+    public setSrc(src: any): void;
+    /**
+     * Sets image object.
+     * @public
+     * @param {Image} image - Image object.
+     */
+    public setImage(image: new (width?: number, height?: number) => HTMLImageElement): void;
+    /**
+     * Creates source gl texture.
+     * @virtual
+     * @protected
+     */
+    protected _createSourceTexture(): void;
+    /**
+     * @private
+     * @param {Image} img
+     */
+    private _onLoad;
+    /**
+     * Loads planet segment material. In this case - GeoImage source image.
+     * @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/GeoTexture2d.d.ts

@@ -0,0 +1,8 @@
+export class GeoTexture2d extends BaseGeoImage {
+    loadMaterial(material: any): void;
+    bindTexture(texture: any): void;
+    setSize(width: any, height: any): void;
+    _renderingProjType1(): void;
+    _renderingProjType0(): void;
+}
+import { BaseGeoImage } from "./BaseGeoImage.js";

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;
+    /**
+     * @private
+     */
+    private _extractCoordonatesFromKml;
+    /**
+     * Creates billboards or polylines from array of lonlat.
+     * @private
+     * @param {Array} coordonates
+     * @param {string} color
+     * @returns {Array<Entity>}
+     */
+    private _convertCoordonatesIntoEntities;
+    /**
+     * @private
+     * @returns {Document}
+     */
+    private _getXmlContent;
+    /**
+     * @private
+     */
+    private _expandExtents;
+    /**
+     * @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;
+    /**
+     * @private
+     */
+    private _getKmlFromUrl;
+    /**
+     * @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 { Billboard } from "../entity/Billboard.js";
+import { Entity } from "../entity/Entity.js";
+import { Extent } from "../Extent.js";