@openglobus/og 0.10.6 → 0.11.1

package/types/layer/GeoVideo.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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}
+ */
+export class GeoVideo {
+    constructor(name: any, options: any);
+    /**
+     * @protected
+     * @const
+     * @type {Boolean}
+     */
+    protected _animate: boolean;
+    /**
+     * HTML5 video element object.
+     * @private
+     * @type {Object}
+     */
+    private _video;
+    /**
+     * VIdeo source url path.
+     * @private
+     * @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
+     */
+    private _onError;
+    /**
+     * 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.
+     */
+    abortMaterialLoading(material: any): void;
+    _renderingProjType1(): void;
+    _ready: boolean;
+    _renderingProjType0(): void;
+}

package/types/layer/KML.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Layer to render KMLs files
+ * @class
+ * @extends {og.Vector}
+ */
+export class KML {
+    /**
+     *
+     * @param {string} name
+     * @param {*} [options]
+     */
+    constructor(name: string, options?: any);
+    _extent: any;
+    _billboard: any;
+    _color: any;
+    get instanceName(): string;
+    /**
+     * @private
+     */
+    private _extractCoordonatesFromKml;
+    /**
+     * Creates billboards or polylines from array of lonlat.
+     * @private
+     * @param {Array} coordonates
+     * @param {string} color
+     * @returns {Array<og.Entity>}
+     */
+    private _convertCoordonatesIntoEntities;
+    /**
+     * @private
+     */
+    private _getXmlContent;
+    /**
+     * @private
+     */
+    private _expandExtents;
+    /**
+     * @public
+     * @param {File[]} kmls
+     * @returns {Promise}
+     */
+    public addKmlFromFiles(kmls: File[]): Promise<any>;
+    /**
+     * @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.
+     * @returns {Promise}
+     */
+    public addKmlFromUrl(url: string): Promise<any>;
+}

package/types/layer/WMS.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Used to display WMS services as tile layers on the globe.
+ * @class
+ * @extends {og.layer.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 {Array.<number,number,number>} [options.transparentColor=[-1,-1,-1]] - RGB color that defines transparent color.
+ * @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.
+ * @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',
+ *     transparentColor: [1.0, 1.0, 1.0],
+ *     version: "1.1.1",
+ *     visibility: false }
+ * );
+ *
+ * @fires og.layer.XYZ#load
+ * @fires og.layer.XYZ#loadend
+ */
+export class WMS {
+    static createRequestUrl(url: any, layers: any, format: string, version: string, request: string, srs: any, bbox: any, width?: number, height?: number): string;
+    static get_bbox_v1_1_1(extent: any): string;
+    static get_bbox_v1_3_0(extent: any): string;
+    constructor(name: any, options: any);
+    /**
+     * 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;
+    _checkSegment(segment: any): boolean;
+    get instanceName(): string;
+    _createUrl(segment: any): string;
+    setVersion(version: any): void;
+    _version: any;
+    _correctFullExtent(): void;
+}

package/types/layer/XYZ.d.ts

@@ -0,0 +1,126 @@
+/**
+ * Represents an imagery tiles source provider.
+ * @class
+ * @extends {og.Layer}
+ * @param {string} name - 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.<string>} [options.subdomains=['a','b','c']] - Subdomains of the tile service.
+ * @param {number} [options.minZoom=0] - Minimal visibility zoom level.
+ * @param {number} [options.maxZoom=0] - Maximal visibility zoom level.
+ * @param {number} [options.minNativeZoom=0] - Minimal available zoom level.
+ * @param {number} [options.maxNativeZoom=19] - Maximal available 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.crossOrigin=true] - If true, all tiles will have their crossOrigin attribute set to ''.
+ * @param {string} options.url - Tile url source template(see example below).
+ * @param {og.layer.XYZ~_urlRewriteCallback} options.urlRewrite - Url rewrite function.
+ * @fires og.layer.XYZ#load
+ * @fires og.layer.XYZ#loadend
+ *
+ * @example <caption>Creates OpenStreetMap base tile layer</caption>
+ * 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>'
+ * });
+ */
+export class XYZ {
+    constructor(name: any, options: any);
+    transparentColor: any;
+    /**
+     * Tile url source template.
+     * @public
+     * @type {string}
+     */
+    public url: string;
+    /**
+     * @protected
+     */
+    protected _s: any;
+    /**
+     * Minimal native zoom level when tiles are available.
+     * @public
+     * @type {number}
+     */
+    public minNativeZoom: number;
+    /**
+     * Maximal native zoom level when tiles are available.
+     * @public
+     * @type {number}
+     */
+    public maxNativeZoom: number;
+    /**
+     * @protected
+     */
+    protected _crossOrigin: any;
+    /**
+     * Rewrites imagery tile url query.
+     * @private
+     * @callback og.layer.XYZ~_urlRewriteCallback
+     * @param {og.planetSegment.Segment} segment - Segment to load.
+     * @param {string} url - Created url.
+     * @returns {string} - Url query string.
+     */
+    private _urlRewriteCallback;
+    get instanceName(): string;
+    /**
+     * Abort loading tiles.
+     * @public
+     */
+    public abortLoading(): void;
+    /**
+     * Sets layer visibility.
+     * @public
+     * @param {boolean} visibility - Layer visibility.
+     */
+    public setVisibility(visibility: boolean): void;
+    /**
+     * Sets imagery tiles url source template.
+     * @public
+     * @param {string} url - Url template.
+     * @example
+     * http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
+     * where {z}, {x} and {y} - replaces by current tile values, {s} - random domen.
+     */
+    public setUrl(url: string): void;
+    _checkSegment(segment: any): boolean;
+    /**
+     * Start to load tile material.
+     * @public
+     * @virtual
+     * @param {og.planetSegment.Material} material - Loads current material.
+     */
+    public loadMaterial(material: any, forceLoading: any): void;
+    /**
+     * Creates query url.
+     * @protected
+     * @virtual
+     * @param {og.planetSegment.Segment} segment - Creates specific url for current segment.
+     * @returns {String} - Returns url string.
+     */
+    protected _createUrl(segment: any): string;
+    _getSubdomain(): any;
+    /**
+     * Returns actual url query string.
+     * @protected
+     * @param {og.planetSegment.Segment} segment - Segment that loads image data.
+     * @returns {string} - Url string.
+     */
+    protected _getHTTPRequestString(segment: any): string;
+    /**
+     * Sets url rewrite callback, used for custom url rewriting for every tile laoding.
+     * @public
+     * @param {og.layer.XYZ~_urlRewriteCallback} ur - The callback that returns tile custom created url.
+     */
+    public setUrlRewriteCallback(ur: any): void;
+    applyMaterial(material: any): any;
+    clearMaterial(material: any): void;
+    /**
+     * @protected
+     */
+    protected _correctFullExtent(): void;
+}

package/types/layer/index.d.ts

@@ -0,0 +1,10 @@
+import { CanvasTiles } from "./CanvasTiles.js";
+import { GeoImage } from "./GeoImage.js";
+import { GeoTexture2d } from "./GeoTexture2d.js";
+import { GeoVideo } from "./GeoVideo.js";
+import { KML } from "./KML.js";
+import { Layer } from "./Layer.js";
+import { Vector } from "./Vector.js";
+import { WMS } from "./WMS.js";
+import { XYZ } from "./XYZ.js";
+export { CanvasTiles, GeoImage, GeoTexture2d, GeoVideo, KML, Layer, Vector, WMS, XYZ };

package/types/light/LightSource.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Represents basic light source.
+ * @class
+ * @param {string} [name] - Light source name.
+ * @param {Object} [params] - Light parameters:
+ * @param {og.Vec3} [params.position] - Light source position if it is a point light, otherwise it is a light direction vector.
+ * @param {og.Vec3} [params.ambient]  - Ambient RGB color.
+ * @param {og.Vec3} [params.diffuse]  - Diffuse RGB color.
+ * @param {og.Vec3} [params.specular]  - Specular RGB color.
+ * @param {number} [params.shininess]  - Specular shininess.
+ */
+export class LightSource {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(name: any, params: any);
+    /**
+     * Light name.
+     * @protected
+     * @type {string}
+     */
+    protected _name: string;
+    /**
+     * Render node where light is shines.
+     * @protected
+     * @type {og.scene.RenderNode}
+     */
+    protected _renderNode: any;
+    /**
+     * Light position.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _position: any;
+    /**
+     * True if the light is directional.
+     * @public
+     * @type {boolean}
+     */
+    public directional: boolean;
+    /**
+     * Ambient color.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _ambient: any;
+    /**
+     * Diffuse color.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _diffuse: any;
+    /**
+     * Specular color.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _specular: any;
+    /**
+     * Shininess.
+     * @protected
+     * @type {number}
+     */
+    protected _shininess: number;
+    /**
+     * Light activity.
+     * @protected
+     * @type {boolean}
+     */
+    protected _active: boolean;
+    _tempAmbient: any;
+    _tempDiffuse: any;
+    _tempSpecular: any;
+    _tempShininess: number;
+    /**
+     * Creates clone of the current light object.
+     * @todo: TODO
+     * @public
+     * @returns {og.LightSource}
+     */
+    public clone(): any;
+    /**
+     * Set light activity. If activity is false the light doesn't shine.
+     * @public
+     * @param {boolean} active - Light activity.
+     */
+    public setActive(active: boolean): void;
+    /**
+     * Gets light activity.
+     * @public
+     * @returns {boolean}
+     */
+    public isActive(): boolean;
+    /**
+     * Set light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @param {og.Vec3} position - Light position or direction vector.
+     * @returns {og.LightSource}
+     */
+    public setPosition3v(position: any): any;
+    /**
+     * Set light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @param {og.Vec3} position - Light position or direction vector.
+     * @returns {og.LightSource}
+     */
+    public setPosition(x: any, y: any, z: any): any;
+    /**
+     * Returns light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @returns {og.Vec3} - Light source position/direction.
+     */
+    public getPosition(): any;
+    /**
+     * Set ambient color.
+     * @public
+     * @param {og.Vec3} rgb - Ambient color.
+     * @returns {og.LightSource}
+     */
+    public setAmbient3v(rgb: any): any;
+    /**
+     * Set diffuse color.
+     * @public
+     * @param {og.Vec3} rgb - Diffuse color.
+     * @returns {og.LightSource}
+     */
+    public setDiffuse3v(rgb: any): any;
+    /**
+     * Set specular color.
+     * @public
+     * @param {og.Vec3} rgb - Specular color.
+     * @returns {og.LightSource}
+     */
+    public setSpecular3v(rgb: any): any;
+    /**
+ * Set ambient color.
+ * @public
+ * @param {og.Vec3} rgb - Ambient color.
+ * @returns {og.LightSource}
+ */
+    public setAmbient(r: any, g: any, b: any): any;
+    /**
+     * Set diffuse color.
+     * @public
+     * @returns {og.LightSource}
+     */
+    public setDiffuse(r: any, g: any, b: any): any;
+    /**
+     * Set specular color.
+     * @public
+     * @returns {og.LightSource}
+     */
+    public setSpecular(r: any, g: any, b: any): any;
+    /**
+     * Set material shininess.
+     * @public
+     * @returns {og.LightSource}
+     */
+    public setShininess(shininess: any): any;
+    /**
+     * Sets light to black.
+     * @public
+     * @returns {og.LightSource}
+     */
+    public setBlack(): any;
+    /**
+     * Adds current light to the render node scene.
+     * @public
+     * @param {og.scene.RenderNode} renderNode - Render node scene.
+     * @returns {og.LightSource}
+     */
+    public addTo(renderNode: any): any;
+    /**
+     * Removes from render node scene.
+     * @public
+     */
+    public remove(): void;
+}

package/types/math/Mat3.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Mat3 factory.
+ * @static
+ * @return {og.Mat3}
+ */
+export function mat3(): any;
+export class Mat3 {
+    /**
+     * Sets column-major order array matrix.
+     * @public
+     * @param {Array.<number>} m - Matrix array.
+     * @returns {og.Mat3}
+     */
+    public set(m: Array<number>): any;
+    /**
+     * Duplicates a Mat3 instance.
+     * @public
+     * @returns {og.Mat3}
+     */
+    public clone(): any;
+    /**
+     * Copy matrix.
+     * @public
+     * @param {og.Mat3} a - Matrix to copy.
+     * @returns {og.Mat3}
+     */
+    public copy(a: any): any;
+    /**
+     * Creates trasposed matrix from the current.
+     * @public
+     * @returns {og.Mat3}
+     */
+    public transposeTo(): any;
+    /**
+     * Sets matrix to identity.
+     * @public
+     * @returns {og.Mat3}
+     */
+    public setIdentity(): any;
+    /**
+     * Multiply to 3d vector.
+     * @public
+     * @params {og.Vec3} p - 3d vector.
+     * @returns {og.Vec3}
+     */
+    public mulVec(p: any): any;
+    /**
+     * Converts to 4x4 matrix.
+     * @public
+     * @returns {og.Mat4}
+     */
+    public toMatrix4(): any;
+}