@openglobus/og 0.11.8 → 0.12.4

package/types/layer/WMS.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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.
+ * @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 }
+ * );
+ *
+ * @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): 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;
+    setVersion(version: any): void;
+    _version: any;
+}
+import { XYZ } from "./XYZ.js";

package/types/layer/XYZ.d.ts

@@ -0,0 +1,119 @@
+/**
+ * Represents an imagery tiles source provider.
+ * @class
+ * @extends {Layer}
+ * @param {string} name - Layer name.
+ * @param {Object} options:
+ * @param {number} [options.opacity=1.0] - Layer opacity.
+ * @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 {string} options.textureFilter - texture gl filter. NEAREST, LINEAR, MIPMAP, ANISOTROPHIC.
+ * @param {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 extends Layer {
+    /**
+     * @param {string} name - Layer name.
+     * @param {*} options
+     */
+    constructor(name: string, options: 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 {Segment} segment - Segment to load.
+     * @param {string} url - Created url.
+     * @returns {string} - Url query string.
+     */
+    private _urlRewriteCallback;
+    /**
+     * Abort loading tiles.
+     * @public
+     */
+    public abortLoading(): 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 {Material} material - Loads current material.
+     */
+    public loadMaterial(material: Material, forceLoading: any): void;
+    /**
+     * Creates query url.
+     * @protected
+     * @virtual
+     * @param {Segment} segment - Creates specific url for current segment.
+     * @returns {String} - Returns url string.
+     */
+    protected _createUrl(segment: Segment): string;
+    _getSubdomain(): any;
+    /**
+     * Returns actual url query string.
+     * @protected
+     * @param {Segment} segment - Segment that loads image data.
+     * @returns {string} - Url string.
+     */
+    protected _getHTTPRequestString(segment: Segment): string;
+    /**
+     * Sets url rewrite callback, used for custom url rewriting for every tile laoding.
+     * @public
+     * @param {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;
+}
+import { Layer } from "./Layer.js";

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,178 @@
+/**
+ * Represents basic light source.
+ * @class
+ * @param {string} [name] - Light source name.
+ * @param {Object} [params] - Light parameters:
+ * @param {Vec3} [params.position] - Light source position if it is a point light, otherwise it is a light direction vector.
+ * @param {Vec3} [params.ambient]  - Ambient RGB color.
+ * @param {Vec3} [params.diffuse]  - Diffuse RGB color.
+ * @param {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 {RenderNode}
+     */
+    protected _renderNode: RenderNode;
+    /**
+     * Light position.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _position: Vec3;
+    /**
+     * True if the light is directional.
+     * @public
+     * @type {boolean}
+     */
+    public directional: boolean;
+    /**
+     * Ambient color.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _ambient: Vec3;
+    /**
+     * Diffuse color.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _diffuse: Vec3;
+    /**
+     * Specular color.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _specular: Vec3;
+    /**
+     * Shininess.
+     * @protected
+     * @type {number}
+     */
+    protected _shininess: number;
+    /**
+     * Light activity.
+     * @protected
+     * @type {boolean}
+     */
+    protected _active: boolean;
+    _tempAmbient: Vec3;
+    _tempDiffuse: Vec3;
+    _tempSpecular: Vec3;
+    _tempShininess: number;
+    /**
+     * Creates clone of the current light object.
+     * @todo: TODO
+     * @public
+     * @returns {LightSource}
+     */
+    public clone(): LightSource;
+    /**
+     * 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 {Vec3} position - Light position or direction vector.
+     * @returns {LightSource}
+     */
+    public setPosition3v(position: Vec3): LightSource;
+    /**
+     * Set light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @param {Vec3} position - Light position or direction vector.
+     * @returns {LightSource}
+     */
+    public setPosition(x: any, y: any, z: any): LightSource;
+    /**
+     * Returns light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @returns {Vec3} - Light source position/direction.
+     */
+    public getPosition(): Vec3;
+    /**
+     * Set ambient color.
+     * @public
+     * @param {Vec3} rgb - Ambient color.
+     * @returns {LightSource}
+     */
+    public setAmbient3v(rgb: Vec3): LightSource;
+    /**
+     * Set diffuse color.
+     * @public
+     * @param {Vec3} rgb - Diffuse color.
+     * @returns {LightSource}
+     */
+    public setDiffuse3v(rgb: Vec3): LightSource;
+    /**
+     * Set specular color.
+     * @public
+     * @param {Vec3} rgb - Specular color.
+     * @returns {LightSource}
+     */
+    public setSpecular3v(rgb: Vec3): LightSource;
+    /**
+     * Set ambient color.
+     * @public
+     * @param {Vec3} rgb - Ambient color.
+     * @returns {LightSource}
+     */
+    public setAmbient(r: any, g: any, b: any): LightSource;
+    /**
+     * Set diffuse color.
+     * @public
+     * @returns {LightSource}
+     */
+    public setDiffuse(r: any, g: any, b: any): LightSource;
+    /**
+     * Set specular color.
+     * @public
+     * @returns {LightSource}
+     */
+    public setSpecular(r: any, g: any, b: any): LightSource;
+    /**
+     * Set material shininess.
+     * @public
+     * @returns {LightSource}
+     */
+    public setShininess(shininess: any): LightSource;
+    /**
+     * Sets light to black.
+     * @public
+     * @returns {LightSource}
+     */
+    public setBlack(): LightSource;
+    /**
+     * Adds current light to the render node scene.
+     * @public
+     * @param {RenderNode} renderNode - Render node scene.
+     * @returns {LightSource}
+     */
+    public addTo(renderNode: RenderNode): LightSource;
+    /**
+     * Removes from render node scene.
+     * @public
+     */
+    public remove(): void;
+}
+import { Vec3 } from "../math/Vec3.js";

package/types/math/Line2.d.ts

@@ -0,0 +1,11 @@
+export class Line2 {
+    static get(p0: any, p1: any): Line2;
+    static getParallel(l: any, p: any): Line2;
+    static getIntersection(L0: any, L1: any): Vec2;
+    constructor(a: any, b: any, c: any);
+    a: any;
+    b: any;
+    c: any;
+    intersects(l: any): Vec2;
+}
+import { Vec2 } from "./Vec2.js";

package/types/math/Line3.d.ts

@@ -0,0 +1,10 @@
+export class Line3 {
+    constructor(p0: any, p1: any);
+    p0: any;
+    p1: any;
+    getMagnitude(): any;
+    getSphereIntersection(sphere: any): Vec3 | Vec3[];
+    intersects(line: any, res: any, res2: any): boolean;
+    getNearestDistancePoint(point: any, res: any): boolean;
+}
+import { Vec3 } from "./Vec3.js";

package/types/math/Mat3.d.ts

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

package/types/math/Mat4.d.ts

@@ -0,0 +1,176 @@
+/**
+ * Mat4 factory.
+ * @static
+ * @returns {Mat4} -
+ */
+export function mat4(): Mat4;
+/**
+ * Class represents a 4x4 matrix.
+ * @class
+ */
+export class Mat4 {
+    /**
+     * Returns identity matrix instance.
+     * @static
+     * @returns {Mat4} -
+     */
+    static identity(): Mat4;
+    /**
+     * A 4x4 matrix, indexable as a column-major order array.
+     * @public
+     * @type {Array.<number>}
+     */
+    public _m: Array<number>;
+    /**
+     * Sets column-major order array matrix.
+     * @public
+     * @param {Array.<number>} m - Matrix array.
+     * @returns {Mat4} -
+     */
+    public set(m: Array<number>): Mat4;
+    /**
+     * Duplicates a Matrix3 instance.
+     * @public
+     * @returns {Mat4} -
+     */
+    public clone(): Mat4;
+    /**
+     * Copy matrix.
+     * @public
+     * @param {Mat3} a - Matrix to copy.
+     */
+    public copy(a: Mat3): void;
+    /**
+     * Converts to 3x3 matrix.
+     * @public
+     * @returns {Mat3} -
+     */
+    public toMatrix3(): Mat3;
+    /**
+     * Multiply to 3d vector.
+     * @public
+     * @param {Vec3} p - 3d vector.
+     * @returns {Vec3} -
+     */
+    public mulVec3(p: Vec3): Vec3;
+    /**
+     * Multiply to 4d vector.
+     * @public
+     * @param {Vec4} p - 4d vector.
+     * @returns {Vec4} -
+     */
+    public mulVec4(p: Vec4): Vec4;
+    /**
+     * Creates an inversed 3x3 matrix of the current.
+     * @public
+     * @returns {Mat3} -
+     */
+    public toInverseMatrix3(): Mat3;
+    /**
+     * Creates an inversed matrix of the current.
+     * @public
+     * @returns {Mat4} -
+     */
+    public inverseTo(res: any): Mat4;
+    /**
+     * Creates a trasposed matrix of the current.
+     * @public
+     * @returns {Mat4} -
+     */
+    public transposeTo(): Mat4;
+    /**
+     * Sets matrix to identity.
+     * @public
+     * @returns {Mat4} -
+     */
+    public setIdentity(): Mat4;
+    /**
+     * Computes the product of two matrices.
+     * @public
+     * @param {Mat4} mx - Matrix to multiply.
+     * @returns {Mat4} -
+     */
+    public mul(mx: Mat4): Mat4;
+    /**
+     * Add translation vector to the current matrix.
+     * @public
+     * @param {Vec3} v - Translate vector.
+     * @returns {Mat4} -
+     */
+    public translate(v: Vec3): Mat4;
+    /**
+     * Sets translation matrix to the position.
+     * @public
+     * @param {Vec3} v - Translate to position.
+     * @returns {Mat4} -
+     */
+    public translateToPosition(v: Vec3): Mat4;
+    /**
+     * Rotate currrent matrix around the aligned axis and angle.
+     * @public
+     * @param {Vec3} u - Aligned axis.
+     * @param {number} angle - Aligned axis angle in radians.
+     * @returns {Mat4} -
+     * @todo: OPTIMIZE: reveal multiplication
+     */
+    public rotate(u: Vec3, angle: number): Mat4;
+    /**
+     * Sets current rotation matrix around the aligned axis and angle.
+     * @public
+     * @param {Vec3} u - Aligned axis.
+     * @param {number} angle - Aligned axis angle in radians.
+     * @returns {Mat4} -
+     */
+    public setRotation(u: Vec3, angle: number): Mat4;
+    /**
+     * Gets the rotation matrix from one vector to another.
+     * @public
+     * @param {Vec3} a - Firtst vector.
+     * @param {Vec3} b - Second vector.
+     * @returns {Mat4} -
+     */
+    public rotateBetweenVectors(a: Vec3, b: Vec3): Mat4;
+    /**
+     * Scale current matrix to the vector values.
+     * @public
+     * @param {Vec3} v - Scale vector.
+     * @returns {Mat4} -
+     */
+    public scale(v: Vec3): Mat4;
+    /**
+     * Sets perspective projection matrix frustum values.
+     * @public
+     * @param {number} left -
+     * @param {number} right -
+     * @param {number} bottom -
+     * @param {number} top -
+     * @param {number} near -
+     * @param {number} far -
+     * @returns {Mat4} -
+     */
+    public setPerspective(left: number, right: number, bottom: number, top: number, near: number, far: number): Mat4;
+    /**
+     * Creates current orthographic projection matrix.
+     * @public
+     * @param {number} left -
+     * @param {number} right -
+     * @param {number} bottom -
+     * @param {number} top -
+     * @param {number} near -
+     * @param {number} far -
+     * @return {Mat4} -
+     */
+    public setOrtho(left: number, right: number, bottom: number, top: number, near: number, far: number): Mat4;
+    /**
+     * Sets current rotation matrix by euler's angles.
+     * @public
+     * @param {number} ax - Rotation angle in radians arond X axis.
+     * @param {number} ay - Rotation angle in radians arond Y axis.
+     * @param {number} az - Rotation angle in radians arond Z axis.
+     * @returns {Mat4} -
+     */
+    public eulerToMatrix(ax: number, ay: number, az: number): Mat4;
+}
+import { Mat3 } from "./Mat3.js";
+import { Vec3 } from "./Vec3.js";
+import { Vec4 } from "./Vec4.js";

package/types/math/Plane.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Plane class.
+ * @constructor
+ * @param {Vec3} [p] - Plane point.
+ * @param {Vec3} [n] - Planet normal.
+ */
+export class Plane {
+    constructor(p: any, n: any);
+    p: any;
+    n: any;
+    set(p: any, n: any): void;
+    getNormal(): any;
+    distance(p: any): any;
+    getProjection(v: any, def: any): Vec3;
+    getProjectionPoint(p: any, vh: any): any;
+    getIntersection(Pn1: any, Pn2: any, L: any): 1 | 0 | 2;
+}
+import { Vec3 } from "./Vec3.js";