@openglobus/og 0.12.1 → 0.13.0

package/types/Clock.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Class represents application timer that stores custom current julian datetime, and time speed multiplier.
+ * @class
+ * @param {Object} [params] - Clock parameters:
+ * @param {number} [params.startDate=0.0] - Julian start date.
+ * @param {number} [params.endDate=0.0] - Julian end date.
+ * @param {number} [params.currentDate] - Julian current date. Default: current date.
+ * @param {number} [params.multiplier=1.0] - Time speed multiolier.
+ */
+export class Clock {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    /**
+     *
+     * @param {Object} [params] - Clock parameters:
+     */
+    constructor(params?: any);
+    _id: number;
+    /**
+     * Clock name.
+     * @public
+     * @type {string}
+     */
+    public name: string;
+    /**
+     * Clock events.
+     * @public
+     * @type {Events}
+     */
+    public events: Events;
+    /**
+     * Start julian date clock loop.
+     * @public
+     * @type {number}
+     */
+    public startDate: number;
+    /**
+     * End julian date clock loop.
+     * @public
+     * @type {number}
+     */
+    public endDate: number;
+    /**
+     * Current julian datetime.
+     * @public
+     * @type {number}
+     */
+    public currentDate: number;
+    /**
+     * Timer speed multiplier.
+     * @public
+     * @type {number}
+     */
+    public multiplier: number;
+    /**
+     * Animation frame delta time.
+     * @public
+     * @readonly
+     * @type {number}
+     */
+    public readonly deltaTicks: number;
+    /**
+     * Timer activity.
+     * @public
+     * @type {boolean}
+     */
+    public active: boolean;
+    _intervalDelay: number;
+    _intervalStart: number;
+    _intervalCallback: any;
+    clearInterval(): void;
+    setInterval(delay: any, callback: any): void;
+    /**
+     * Sets current clock datetime.
+     * @public
+     * @param {Object} date - JavaScript Date object.
+     */
+    public setDate(date: any): void;
+    /**
+     * Returns current application date.
+     * @public
+     * @returns {Date} - Current date.
+     */
+    public getDate(): Date;
+    reset(): void;
+    _tick(dt: any): void;
+    /**
+     * @public
+     * @param {Clock} clock - Clock instance to compare.
+     * @returns {boolean} - Returns true if a clock is the same instance.
+     */
+    public equal(clock: Clock): boolean;
+}
+import { Events } from "./Events.js";

package/types/Deferred.d.ts

@@ -0,0 +1,6 @@
+export function Deferred(): void;
+export class Deferred {
+    resolve: any;
+    reject: any;
+    promise: Promise<any>;
+}

package/types/Events.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Base events class to handle custom events.
+ * @class
+ */
+export class Events {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    /**
+     *
+     * @param {Array.<string>} [eventNames] - Event names that could be dispatched.
+     * @param {*} [sender]
+     */
+    constructor(eventNames?: Array<string>, sender?: any);
+    /**
+     * Registered event names.
+     * @protected
+     * @type {Array.<string>}
+     */
+    protected _eventNames: Array<string>;
+    _sender: any;
+    /**
+     * Stop propagation flag
+     * @protected
+     * @type {boolean}
+     */
+    protected _stopPropagation: boolean;
+    _stampCache: {};
+    __id: number;
+    bindSender(sender: any): void;
+    /**
+     * Function that creates event object properties that would be dispatched.
+     * @public
+     * @param {Array.<string>} eventNames - Specified event names list.
+     */
+    public registerNames(eventNames: Array<string>): void;
+    _getStamp(name: any, id: any, ogid: any): string;
+    /**
+     * Returns true if event callback has stamped.
+     * @protected
+     * @param {Object} name - Event identifier.
+     * @param {Object} obj - Event callback.
+     * @return {boolean} -
+     */
+    protected _stamp(name: any, obj: any): boolean;
+    /**
+     * Attach listener.
+     * @public
+     * @param {string} name - Event name to listen.
+     * @param {eventCallback} callback - Event callback function.
+     * @param {Object} sender - Event callback function owner.
+     */
+    public on(name: string, callback: eventCallback, sender: any, priority?: number): void;
+    /**
+     * Stop listening event name with specified callback function.
+     * @public
+     * @param {string} name - Event name.
+     * @param {eventCallback} callback - Attached  event callback.
+     */
+    public off(name: string, callback: eventCallback): void;
+    /**
+     * Dispatch event.
+     * @public
+     * @param {Object} event - Event instance property that created by event name.
+     * @param {Object} [obj] - Event object.
+     */
+    public dispatch(event: any, ...args: any[]): boolean;
+    /**
+     * Brakes events propagation.
+     * @public
+     */
+    public stopPropagation(): void;
+    /**
+     * Removes all events.
+     * @public
+     */
+    public clear(): void;
+}

package/types/Extent.d.ts

@@ -0,0 +1,166 @@
+/**
+ * Represents geographical coordinates extent.
+ * @class
+ * @param {LonLat} [sw] - South West extent corner coordiantes.
+ * @param {LonLat} [ne] - North East extent corner coordiantes.
+ */
+export class Extent {
+    /**
+     * Whole mercator extent.
+     * @const
+     */
+    static get FULL_MERC(): Extent;
+    /**
+     * Degrees extent from north mercator limit to north pole.
+     * @const
+     */
+    static get NORTH_POLE_DEG(): Extent;
+    /**
+     * Degrees extent from south pole to south mercator limit.
+     * @const
+     */
+    static get SOUTH_POLE_DEG(): Extent;
+    /**
+     * Creates extent instance from values in array.
+     * @static
+     * @param {Array.<number>} arr - South west and north east longitude and latidudes packed in array. (exactly 4 entries)
+     * @return {Extent} Extent object.
+     */
+    static createFromArray(arr: Array<number>): Extent;
+    /**
+     * Creates bound extent instance by coordinate array.
+     * @static
+     * @param {Array.<LonLat>} arr - Coordinate array.
+     * @return {Extent} Extent object.
+     */
+    static createByCoordinates(arr: Array<LonLat>): Extent;
+    /**
+     * Creates bound extent instance by coordinate array.
+     * @static
+     * @param {Array.<Array<number>>} arr - Coordinate array. (exactly 2 entries)
+     * @return {Extent} Extent object.
+     */
+    static createByCoordinatesArr(arr: Array<Array<number>>): Extent;
+    /**
+     * Creates extent by meractor grid tile coordinates.
+     * @static
+     * @param {number} x -
+     * @param {number} y -
+     * @param {number} z -
+     * @param {number} width -
+     * @param {number} height -
+     * @returns {Extent} -
+     */
+    static fromTile(x: number, y: number, z: number, width: number, height: number): Extent;
+    /**
+     * @param {LonLat} [sw] - South West extent corner coordiantes.
+     * @param {LonLat} [ne] - North East extent corner coordiantes.
+     */
+    constructor(sw?: LonLat, ne?: LonLat);
+    /**
+     * @public
+     */
+    public southWest: LonLat;
+    /**
+     * @public
+     */
+    public northEast: LonLat;
+    /**
+     * Sets current bounding extent object by coordinate array.
+     * @public
+     * @param {Array.<LonLat>} arr - Coordinate array.
+     * @return {Extent} Current extent.
+     */
+    public setByCoordinates(arr: Array<LonLat>): Extent;
+    /**
+     * Determines if point inside extent.
+     * @public
+     * @param {LonLat} lonlat - Coordinate point.
+     * @return {boolean} Returns true if point inside extent.
+     */
+    public isInside(lonlat: LonLat): boolean;
+    /**
+     * Returns true if two extent overlap each other.
+     * @public
+     * @param {Extent} e - Another extent.
+     * @return {boolean} -
+     */
+    public overlaps(e: Extent): boolean;
+    /**
+     * Gets extent width.
+     * @public
+     * @return {number} Extent width.
+     */
+    public getWidth(): number;
+    /**
+     * Gets extent height.
+     * @public
+     * @return {number} Extent height.
+     */
+    public getHeight(): number;
+    /**
+     * Creates clone instance of the current extent.
+     * @public
+     * @return {Extent} Extent clone.
+     */
+    public clone(): Extent;
+    /**
+     * Gets the center coordinate of the extent.
+     * @public
+     * @return {number} Center coordinate.
+     */
+    public getCenter(): number;
+    /**
+     * @public
+     */
+    public getNorthWest(): LonLat;
+    /**
+     * @public
+     */
+    public getNorthEast(): LonLat;
+    getSouthWest(): LonLat;
+    /**
+     * @public
+     */
+    public getSouthEast(): LonLat;
+    /**
+     * @public
+     */
+    public getNorth(): number;
+    getEast(): number;
+    /**
+     * @public
+     */
+    public getWest(): number;
+    /**
+     * @public
+     */
+    public getSouth(): number;
+    /**
+     * Returns extents are equals.
+     * @param {Extent} extent - Extent.
+     * @returns {boolean} -
+     */
+    equals(extent: Extent): boolean;
+    /**
+     * Converts extent coordinates to mercator projection coordinates.
+     * @public
+     * @return {Extent} New instance of the current extent.
+     */
+    public forwardMercator(): Extent;
+    /**
+     * Converts extent coordinates from mercator projection to degrees.
+     * @public
+     * @return {Extent} New instance of the current extent.
+     */
+    public inverseMercator(): Extent;
+    /**
+     * Gets cartesian bounding bounds of the current ellipsoid.
+     * @public
+     * @param {Ellipsoid} ellipsoid - Ellipsoid.
+     * @return {Array.<number>} Cartesian 3d coordinate array. (exactly 6 entries)
+     */
+    public getCartesianBounds(ellipsoid: Ellipsoid): Array<number>;
+    toString(): string;
+}
+import { LonLat } from "./LonLat.js";

package/types/Globe.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Creates a WebGL context with globe.
+ * @class
+ *
+ * @example <caption>Basic initialization</caption>
+ * globus = new og.Globe({
+ *     'atmosphere': false,
+ *     'target': 'globus',
+ *     'name': 'Earth',
+ *     'controls': [
+ *          new og.control.MouseNavigation({ autoActivate: true }),
+ *          new og.control.KeyboardNavigation({ autoActivate: true }),
+ *          new og.control.EarthCoordinates({ autoActivate: true, center: false }),
+ *          new og.control.LayerSwitcher({ autoActivate: true }),
+ *          new og.control.ZoomControl({ autoActivate: true }),
+ *          new og.control.TouchNavigation({ autoActivate: true }),
+ *          new og.control.Sun({ autoActivate: true })
+ *      ],
+ *     'terrain': new og.terrain.GlobusTerrain(),
+ *     'layers': [
+ *          new og.layer.XYZ("OpenStreetMap", { isBaseLayer: true, url: "http://b.tile.openstreetmap.org/{z}/{x}/{y}.png", visibility: true, attribution: 'Data @ <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="http://www.openstreetmap.org/copyright">ODbL</a>' })
+ *      ],
+ *     'autoActivate': true
+ * });
+ *
+ * @param {object} options - Options:
+ * @param {string} options.target - HTML element id where planet canvas have to be created.
+ * @param {RenderNode} [options.skybox] - Render skybox. null - default.
+ * @param {string} [options.name] - Planet name. Default is unic identifier.
+ * @param {Terrain} [options.terrain] - Terrain provider. Default no terrain - og.terrain.EmptyTerrain.
+ * @param {Array.<control.Control>} [options.controls] - Renderer controls array.
+ * @param {Array.<Layer>} [options.layers] - Planet layers.
+ * @param {Extent} [options.viewExtent] - Viewable starting extent.
+ * @param {boolean} [options.autoActivate] - Globe rendering auto activation flag. True is default.
+ * @param {DOMElement} [options.attributionContainer] - Container for attribution list.
+ * @param {Number} [options.maxGridSize] = Maximal segment grid size. 128 is default
+ * @param {boolean} [options.useSpecularTexture] - use specular water mask
+ * @param {boolean} [options.useNightTexture] - show night cities
+ * @param {Number} [options.maxAltitude=15000000.0] - Maximal camera altitude above terrain
+ * @param {Number} [options.minAltitude=1.0] - Minimal camera altitude above terrain
+ * @param {Number} [options.maxEqualZoomAltitude=15000000.0] - Maximal altitude since segments on the screen bacame the same zoom level
+ * @param {Number} [options.minEqualZoomAltitude=10000.0] - Minimal altitude since segments on the screen bacame the same zoom level
+ * @param {Number} [options.minEqualZoomCameraSlope=0.8] - Minimal camera slope above te globe where segments on the screen bacame the same zoom level
+ * @param {Number} [options.loadingBatchSize=12] -
+ */
+export class Globe {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    /**
+     * @param {*} options
+     */
+    constructor(options: any);
+    _canvas: HTMLCanvasElement;
+    div: any;
+    /**
+     * Interface for the renderer context(events, input states, renderer nodes etc.)
+     * @public
+     * @type {Renderer}
+     */
+    public renderer: Renderer;
+    /**
+     * Planet node name. Access with this.renderer.<name>
+     * @private
+     * @type {String}
+     */
+    private _planetName;
+    planet: Planet;
+    sun: any;
+    _opacityCounter: number;
+    _fadeHandler: any;
+    _stopHandler: any;
+    /**
+     * Starts screen brightness fading in effect by the duration time.
+     * @public
+     */
+    public fadeIn(): void;
+    /**
+     * Starts screen brightness fading out effect by the duration time.
+     * @public
+     * @param {number} duration - Fadeout duration time.
+     */
+    public fadeOut(): void;
+}
+import { Renderer } from "./renderer/Renderer.js";
+import { Planet } from "./scene/Planet.js";

package/types/ImageCanvas.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Usefull class for working with JS canvas object.
+ * @class
+ */
+export class ImageCanvas {
+    /**
+     * @param {number} [width] - Canvas width. Default 256.
+     * @param {number} [height] - Canvas height. Default 256.
+     */
+    constructor(width?: number, height?: number);
+    /**
+     * Canvas object.
+     * @protected
+     * @type {Object}
+     */
+    protected _canvas: any;
+    /**
+     * Canvas context.
+     * @protected
+     * @type {Object}
+     */
+    protected _context: any;
+    /**
+     * Returns canvas object.
+     * @public
+     * @returns {Object}
+     */
+    public getCanvas(): any;
+    /**
+     * Returns canvas context pointer.
+     * @public
+     * @returns {Object}
+     */
+    public getContext(): any;
+    /**
+     * Fills canvas RGBA with zeroes.
+     * @public
+     */
+    public fillEmpty(): void;
+    /**
+     * Gets canvas pixels RGBA data.
+     * @public
+     * @returns {Array.<number>}
+     */
+    public getData(): Array<number>;
+    /**
+     * Fill the canvas by color.
+     * @public
+     * @param {string} color - CSS string color.
+     */
+    public fillColor(color: string): void;
+    /**
+     * Sets RGBA pixel data.
+     * @public
+     * @param {Array.<number>} data - Array RGBA data.
+     */
+    public setData(data: Array<number>): void;
+    /**
+     * Resize canvas.
+     * @public
+     * @param {number} width - Width.
+     * @param {number} height - Height.
+     */
+    public resize(width: number, height: number): void;
+    /**
+     * Draw an image on the canvas.
+     * @public
+     * @param {Image} img - Draw image.
+     * @param {number} [x] - Left top image corner X coordinate on the canvas.
+     * @param {number} [y] - Left top image corner Y coordinate on the canvas.
+     * @param {number} [width] - Image width slice. Image width is default.
+     * @param {number} [height] - Image height slice. Image height is default.
+     */
+    public drawImage(img: new (width?: number, height?: number) => HTMLImageElement, x?: number, y?: number, width?: number, height?: number): void;
+    /**
+     * Converts canvas to JS image object.
+     * @public
+     * @returns {Image}
+     */
+    public getImage(): new (width?: number, height?: number) => HTMLImageElement;
+    /**
+     * Get measured text width.
+     * @public
+     * @param {string} text - Measured text.
+     * @returns {number}
+     */
+    public getTextWidth(text: string): number;
+    /**
+     * Draw a text on the canvas.
+     * @public
+     * @param {string} text - Text.
+     * @param {number} [x] - Canvas X - coordinate. 0 - default.
+     * @param {number} [y] - Canvas Y - coordinate. 0 - default.
+     * @param {string} [font] - Font style. 'normal 14px Verdana' - is default.
+     * @param {string} [color] - Css font color.
+     */
+    public drawText(text: string, x?: number, y?: number, font?: string, color?: string): void;
+    /**
+     * Gets canvas width.
+     * @public
+     * @returns {number}
+     */
+    public getWidth(): number;
+    /**
+     * Gets canvas height.
+     * @public
+     * @returns {number}
+     */
+    public getHeight(): number;
+    /**
+     * Load image to canvas.
+     * @public
+     * @param {string} url - Image url.
+     * @pararm {imageCallback} [callback] - Image onload callback.
+     */
+    public load(url: string, callback: any): void;
+    /**
+     * Open canvas image in the new window.
+     * @public
+     */
+    public openImage(): void;
+    destroy(): void;
+}

package/types/Lock.d.ts

@@ -0,0 +1,12 @@
+export class Lock {
+    _lock: number;
+    lock(key: any): void;
+    free(key: any): void;
+    isFree(): boolean;
+    isLocked(): boolean;
+}
+export class Key {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    _id: number;
+}

package/types/LonLat.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Represents a geographical point with a certain latitude, longitude and height.
+ * @class
+ * @param {number} [lon] - Longitude.
+ * @param {number} [lat] - Latitude.
+ * @param {number} [height] - Height over the surface.
+ */
+export class LonLat {
+    /**
+     * Creates coordinates array.
+     * @static
+     * @param{Array.<Array<number>>} arr - Coordinates array data. (exactly 3 entries)
+     * @return{Array.<LonLat>} the same coordinates array but each element is LonLat instance.
+     */
+    static join(arr: Array<Array<number>>): Array<LonLat>;
+    /**
+     * Creates an object by coordinate array.
+     * @static
+     * @param {Array.<number>} arr - Coordiante array, where first is longitude, second is latitude and third is a height. (exactly 3 entries)
+     * @returns {LonLat} -
+     */
+    static createFromArray(arr: Array<number>): LonLat;
+    /**
+     * Converts degrees to mercator coordinates.
+     * @static
+     * @param {number} lon - Degrees longitude.
+     * @param {number} lat - Degrees latitude.
+     * @param {number} [height] - Height.
+     * @returns {LonLat} -
+     */
+    static forwardMercator(lon: number, lat: number, height?: number): LonLat;
+    /**
+     * Converts mercator to degrees coordinates.
+     * @static
+     * @param {number} x - Mercator longitude.
+     * @param {number} y - Mercator latitude.
+     * @param {number} [height] - Height.
+     * @returns {LonLat} -
+     */
+    static inverseMercator(x: number, y: number, height?: number): LonLat;
+    /**
+     * @param {number} [lon] - Longitude.
+     * @param {number} [lat] - Latitude.
+     * @param {number} [height] - Height over the surface.
+     */
+    constructor(lon?: number, lat?: number, height?: number);
+    /**
+     * Longitude.
+     * @public
+     * @type {number}
+     */
+    public lon: number;
+    /**
+     * Latitude.
+     * @public
+     * @type {number}
+     */
+    public lat: number;
+    /**
+     * Height.
+     * @public
+     * @type {number}
+     */
+    public height: number;
+    isZero(): boolean;
+    /**
+     * Sets coordinates.
+     * @public
+     * @param {number} [lon] - Longitude.
+     * @param {number} [lat] - Latitude.
+     * @param {number} [height] - Height.
+     * @returns {LonLat} -
+     */
+    public set(lon?: number, lat?: number, height?: number): LonLat;
+    /**
+     * Copy coordinates.
+     * @public
+     * @param {LonLat} [lonLat] - Coordinates to copy.
+     * @returns {LonLat} -
+     */
+    public copy(lonLat?: LonLat): LonLat;
+    /**
+     * Clone the coordiante.
+     * @public
+     * @returns {LonLat} -
+     */
+    public clone(): LonLat;
+    /**
+     * Converts to mercator coordinates.
+     * @public
+     * @returns {LonLat} -
+     */
+    public forwardMercator(): LonLat;
+    forwardMercatorEPS01(): LonLat;
+    /**
+     * Converts from mercator coordinates.
+     * @public
+     * @returns {LonLat} -
+     */
+    public inverseMercator(): LonLat;
+    /**
+     * Compares coordinates.
+     * @public
+     * @param {LonLat} b - Coordinate to compare with.
+     * @returns {boolean} -
+     */
+    public equal(b: LonLat): boolean;
+}