@openglobus/og 0.19.3 → 0.20.0

package/lib/@openglobus/js/layer/WMS.d.ts

@@ -0,0 +1,75 @@
+import { Extent } from "../Extent";
+import { Segment } from "../segment/Segment";
+import { XYZ, IXYZParams } from "./XYZ";
+interface IWMSParams extends IXYZParams {
+    extra?: any;
+    layers: string;
+    imageWidth?: number;
+    imageHeight?: number;
+    version?: string;
+}
+/**
+ * Used to display WMS services as tile layers on the globe.
+ * @class
+ * @extends {XYZ}
+ * @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.
+ * @param {Object} extra  - Extra parameters (by WMS reference or by WMS service vendors) to pass to WMS service.
+ * @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 }, {
+ *     transparent: true,
+ *     sld: "style.sld"}
+ * );
+ */
+declare class WMS extends XYZ {
+    protected _extra: string;
+    /**
+     * WMS layers string.
+     * @public
+     * @type {string}
+     */
+    layers: string;
+    /**
+     * WMS tile width.
+     * @public
+     * @type {number}
+     */
+    imageWidth: number;
+    /**
+     * WMS tile height.
+     * @public
+     * @type {number}
+     */
+    imageHeight: number;
+    protected _getBbox: (extent: Extent) => string;
+    protected _version: string;
+    constructor(name: string | null, options: IWMSParams);
+    static createRequestUrl(url: string, layers: string, format: string | undefined, version: string | undefined, request: string | undefined, srs: string, bbox: string, width?: number, height?: number, extra?: string): string;
+    static get_bbox_v1_1_1(extent: Extent): string;
+    static get_bbox_v1_3_0(extent: Extent): string;
+    _checkSegment(segment: Segment): boolean;
+    get instanceName(): string;
+    protected _createUrl(segment: Segment): string;
+    setVersion(version?: string): void;
+    _correctFullExtent(): void;
+}
+export { WMS };

package/lib/@openglobus/js/layer/XYZ.d.ts

@@ -0,0 +1,148 @@
+import { Layer, ILayerParams, LayerEventsList } from "./Layer";
+import { Segment } from "../segment/Segment";
+import { EventsHandler } from "../Events";
+import { Material } from "./Material";
+import { NumberArray4 } from "../math/Vec4";
+export interface IXYZParams extends ILayerParams {
+    url?: string;
+    subdomains?: string[];
+    minNativeZoom?: number;
+    maxNativeZoom?: number;
+    urlRewrite?: Function;
+}
+type XYZEventsList = [
+    "load",
+    "loadend"
+];
+type XYZEventsType = EventsHandler<XYZEventsList> & EventsHandler<LayerEventsList>;
+/**
+ * Represents an imagery tiles source provider.
+ * @class
+ * @extends {Layer}
+ * @param {string} name - Layer name.
+ * @param {IXYZParams} 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, ANISOTROPIC.
+ * @param {Function} options.urlRewrite - Url rewrite function.
+ *
+ * @fires EventsHandler<XYZEventsList>#load
+ * @fires EventsHandler<XYZEventsList>#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 declare class XYZ extends Layer {
+    events: XYZEventsType;
+    /**
+     * Tile url source template.
+     * @public
+     * @type {string}
+     */
+    url: string;
+    /**
+     * @protected
+     */
+    protected _s: string[];
+    /**
+     * Minimal native zoom level when tiles are available.
+     * @public
+     * @type {number}
+     */
+    minNativeZoom: number;
+    /**
+     * Maximal native zoom level when tiles are available.
+     * @public
+     * @type {number}
+     */
+    maxNativeZoom: number;
+    /**
+     * Rewrites imagery tile url query.
+     * @private
+     * @param {Segment} segment - Segment to load.
+     * @param {string} url - Created url.
+     * @returns {string} - Url query string.
+     */
+    protected _urlRewriteCallback: Function | null;
+    protected _requestsPeerSubdomains: number;
+    protected _requestCount: number;
+    constructor(name: string | null, options?: IXYZParams);
+    /**
+     * @warning Use XYZ.isIdle in requestAnimationFrame(after setVisibility)
+     */
+    get isIdle(): boolean;
+    get instanceName(): string;
+    /**
+     * Abort loading tiles.
+     * @public
+     */
+    abortLoading(): void;
+    /**
+     * Sets layer visibility.
+     * @public
+     * @param {boolean} visibility - Layer visibility.
+     */
+    setVisibility(visibility: boolean): void;
+    remove(): this;
+    /**
+     * 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 domain.
+     */
+    setUrl(url: string): void;
+    _checkSegment(segment: Segment): boolean;
+    /**
+     * Start to load tile material.
+     * @public
+     * @virtual
+     * @param {Material} material - Loads current material.
+     * @param {boolean} [forceLoading=false] -
+     */
+    loadMaterial(material: Material, forceLoading?: boolean): 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;
+    protected _getSubdomain(): string;
+    /**
+     * Returns actual url query string.
+     * @protected
+     * @param {Segment} segment - Segment that loads image data.
+     * @returns {string} - Url string.
+     */
+    protected _getHTTPRequestString(segment: Segment): any;
+    /**
+     * Sets url rewrite callback, used for custom url rewriting for every tile loading.
+     * @public
+     * @param {Function} ur - The callback that returns tile custom created url.
+     */
+    setUrlRewriteCallback(ur: Function): void;
+    applyMaterial(material: Material, forceLoading?: boolean): NumberArray4;
+    clearMaterial(material: Material): void;
+    /**
+     * @protected
+     */
+    protected _correctFullExtent(): void;
+}
+export {};

package/lib/@openglobus/js/layer/index.d.ts

@@ -0,0 +1,12 @@
+export * from './CanvasTiles';
+export * from './GeoImage';
+export * from './GeoTexture2d';
+export * from './GeoVideo';
+export * from './KML';
+export * from './Layer';
+export * from './Vector';
+export * from './WMS';
+export * from './XYZ';
+export * from './Material';
+export * from './OpenStreetMap';
+export * from './Bing';

package/lib/@openglobus/js/light/LightSource.d.ts

@@ -0,0 +1,174 @@
+import { Vec3 } from "../math/Vec3";
+import { RenderNode } from "../scene/RenderNode";
+export interface ILightSourceParams {
+    position?: Vec3;
+    directional?: boolean;
+    ambient?: Vec3;
+    diffuse?: Vec3;
+    specular?: Vec3;
+    shininess?: number;
+}
+/**
+ * Represents basic light source.
+ * @class
+ * @param {string} [name] - Light source name.
+ * @param {ILightSourceParams} [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.
+ */
+declare class LightSource {
+    static __counter__: number;
+    /**
+     * Light name.
+     * @protected
+     * @type {string}
+     */
+    protected _name: string;
+    /**
+     * Render node where light is shines.
+     * @protected
+     * @type {RenderNode}
+     */
+    protected _renderNode: RenderNode | null;
+    /**
+     * Light position.
+     * @public
+     * @type {Vec3}
+     */
+    _position: Vec3;
+    /**
+     * True if the light is directional.
+     * @public
+     * @type {boolean}
+     */
+    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;
+    protected _tempAmbient: Vec3;
+    protected _tempDiffuse: Vec3;
+    protected _tempSpecular: Vec3;
+    protected _tempShininess: number;
+    constructor(name: string, params: ILightSourceParams);
+    /**
+     * Creates clone of the current light object.
+     * @todo: TODO
+     * @public
+     * @returns {LightSource}
+     */
+    clone(): void;
+    /**
+     * Set light activity. If activity is false the light doesn't shine.
+     * @public
+     * @param {boolean} active - Light activity.
+     */
+    setActive(active: boolean): void;
+    /**
+     * Gets light activity.
+     * @public
+     * @returns {boolean}
+     */
+    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.
+     */
+    setPosition3v(position: Vec3): void;
+    /**
+     * Set light source position, or if it is a directional type sets light direction vector.
+     * @public
+     */
+    setPosition(x: number, y: number, z: number): void;
+    /**
+     * Returns light source position, or if it is a directional type sets light direction vector.
+     * @public
+     * @returns {Vec3} - Light source position/direction.
+     */
+    getPosition(): Vec3;
+    /**
+     * Set ambient color.
+     * @public
+     * @param {Vec3} rgb - Ambient color.
+     */
+    setAmbient3v(rgb: Vec3): void;
+    /**
+     * Set diffuse color.
+     * @public
+     * @param {Vec3} rgb - Diffuse color.
+     */
+    setDiffuse3v(rgb: Vec3): void;
+    /**
+     * Set specular color.
+     * @public
+     * @param {Vec3} rgb - Specular color.
+     */
+    setSpecular3v(rgb: Vec3): void;
+    /**
+     * Set ambient color.
+     * @public
+     */
+    setAmbient(r: number, g: number, b: number): void;
+    /**
+     * Set diffuse color.
+     * @public
+     */
+    setDiffuse(r: number, g: number, b: number): void;
+    /**
+     * Set specular color.
+     * @public
+     */
+    setSpecular(r: number, g: number, b: number): void;
+    /**
+     * Set material shininess.
+     * @public
+     */
+    setShininess(shininess: number): void;
+    /**
+     * Sets light to black.
+     * @public
+     */
+    setBlack(): void;
+    /**
+     * Adds current light to the render node scene.
+     * @public
+     * @param {RenderNode} renderNode - Render node scene.
+     */
+    addTo(renderNode: RenderNode): void;
+    /**
+     * Removes from render node scene.
+     * @public
+     */
+    remove(): void;
+}
+export { LightSource };

package/lib/@openglobus/js/math/Line2.d.ts

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

package/lib/@openglobus/js/math/Line3.d.ts

@@ -0,0 +1,28 @@
+import { Sphere } from "../bv/Sphere";
+import { Vec3 } from './Vec3';
+/**
+ * @todo: write tests
+ * @class Line3
+ * Represents a line segment in 3d space.
+ * @param {Vec3} [p0] - First point of the line
+ * @param {Vec3} [p1] - Second point of the line
+ */
+export declare class Line3 {
+    /**
+     * First point of the line
+     * @public
+     * @type: Vec3
+     */
+    p0: Vec3;
+    /**
+     * Second point of the line
+     * @public
+     * @type: Vec3
+     */
+    p1: Vec3;
+    constructor(p0?: Vec3, p1?: Vec3);
+    getMagnitude(): number;
+    getSphereIntersection(sphere: Sphere): [Vec3] | [Vec3, Vec3] | [];
+    intersects(line: Line3, res: Vec3, res2?: Vec3): boolean;
+    getNearestDistancePoint(point: Vec3, res: Vec3): boolean;
+}

package/lib/@openglobus/js/math/Mat3.d.ts

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