@openglobus/og 0.19.3 → 0.20.0

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

@@ -0,0 +1,103 @@
+import { EventCallback, EventsHandler } from "../Events";
+import { ILayerParams, Layer, LayerEventsList } from "./Layer";
+import { Material } from "../layer/Material";
+import { NumberArray4 } from "../math/Vec4";
+import { Planet } from "../scene/Planet";
+type ApplyImageFunc = (material: HTMLCanvasElement | ImageBitmap | HTMLImageElement) => void;
+type DrawTileCallback = (material: Material, applyImage: ApplyImageFunc) => void;
+export interface ICanvasTilesParams extends ILayerParams {
+    drawTile: DrawTileCallback;
+    animated?: boolean;
+    minNativeZoom?: number;
+    maxNativeZoom?: number;
+}
+type CanvasTilesEventsList = [
+    "load",
+    "loadend"
+];
+type CanvasTilesEventsType = EventsHandler<CanvasTilesEventsList> & EventsHandler<LayerEventsList>;
+/**
+ * Layer used to rendering each tile as a separate canvas object.
+ * @class
+ * @extends {Layer}
+ * @param {String} [name="noname"] - Layer name.
+ * @param {ICanvasTilesParams} 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 {DrawTileCallback} options.drawTile - Draw tile callback.
+ * @fires EventsHandler<CanvasTilesEventsList>#load
+ * @fires EventsHandler<CanvasTilesEventsList>#loadend
+ */
+declare class CanvasTiles extends Layer {
+    static MAX_REQUESTS: number;
+    static __requestsCounter: number;
+    events: CanvasTilesEventsType;
+    animated: boolean;
+    minNativeZoom: number;
+    maxNativeZoom: number;
+    /**
+     * Current creating tiles counter.
+     * @protected
+     * @type {number}
+     */
+    protected _counter: number;
+    /**
+     * Tile pending queue that waiting for create.
+     * @protected
+     * @type {Material[]}
+     */
+    protected _pendingsQueue: Material[];
+    /**
+     * Draw tile callback.
+     * @type {DrawTileCallback}
+     * @public
+     */
+    drawTile: DrawTileCallback;
+    protected _onLoadend_: EventCallback | null;
+    constructor(name: string | null, options: ICanvasTilesParams);
+    addTo(planet: Planet): void;
+    remove(): this;
+    _onLoadend(): void;
+    get instanceName(): string;
+    get isIdle(): boolean;
+    /**
+     * Abort loading tiles.
+     * @public
+     */
+    abortLoading(): void;
+    /**
+     * Sets layer visibility.
+     * @public
+     * @param {boolean} visibility - Layer visibility.
+     */
+    setVisibility(visibility: boolean): void;
+    /**
+     * Start to load tile material.
+     * @public
+     * @virtual
+     * @param {Material} material -
+     */
+    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;
+    protected _correctCounter(): void;
+    /**
+     * Abort exact material loading.
+     * @public
+     * @param {Material} material - Segment material.
+     */
+    abortMaterialLoading(material: Material): void;
+    protected _dequeueRequest(): void;
+    protected _whilePendings(): Material | null;
+    applyMaterial(material: Material): NumberArray4;
+    clearMaterial(material: Material): void;
+}
+export { CanvasTiles };

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

@@ -0,0 +1,61 @@
+import { BaseGeoImage, IBaseGeoImageParams } from "./BaseGeoImage";
+import { Material } from "./Material";
+export interface IGeoImageParams extends IBaseGeoImageParams {
+    image?: HTMLImageElement | HTMLCanvasElement | ImageBitmap;
+    src?: string;
+}
+/**
+ * Used to load and display a single image over specific corner coordinates on the globe.
+ * @class
+ * @extends {BaseGeoImage}
+ */
+declare class GeoImage extends BaseGeoImage {
+    /**
+     * Image object.
+     * @protected
+     * @type {HTMLImageElement | HTMLCanvasElement | ImageBitmap}
+     */
+    protected _image: HTMLImageElement | HTMLCanvasElement | ImageBitmap | null;
+    /**
+     * Image source url path.
+     * @protected
+     * @type {string}
+     */
+    protected _src: string | null;
+    protected _onLoad_: ((this: HTMLImageElement, ev: Event) => void) | null;
+    constructor(name: string | null, options?: IGeoImageParams);
+    get instanceName(): string;
+    abortLoading(): void;
+    /**
+     * Sets image source url path.
+     * @public
+     * @param {string} srs - Image url path.
+     */
+    setSrc(src: string): void;
+    /**
+     * Sets image object.
+     * @public
+     * @param {Image} image - Image object.
+     */
+    setImage(image: HTMLImageElement): void;
+    /**
+     * Creates source gl texture.
+     * @virtual
+     * @protected
+     */
+    protected _createSourceTexture(): void;
+    protected _onLoad(ev: Event): void;
+    protected _applyImage(img: HTMLImageElement | HTMLCanvasElement | ImageBitmap | null): void;
+    /**
+     * Loads planet segment material. In this case - GeoImage source image.
+     * @public
+     * @param {Material} material - GeoImage planet material.
+     */
+    loadMaterial(material: Material): void;
+    /**
+     * @public
+     * @param {Material} material - GeoImage material.
+     */
+    abortMaterialLoading(material: Material): void;
+}
+export { GeoImage };

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

@@ -0,0 +1,17 @@
+import { BaseGeoImage, IBaseGeoImageParams } from './BaseGeoImage';
+import { Material } from "../layer/Material";
+import { WebGLTextureExt } from "../webgl/Handler";
+interface IGeoTexture2dParams extends IBaseGeoImageParams {
+    texture?: WebGLTextureExt;
+    frameWidth?: number;
+    frameHeight?: number;
+}
+declare class GeoTexture2d extends BaseGeoImage {
+    constructor(name: string | null, options?: IGeoTexture2dParams);
+    get instanceName(): string;
+    loadMaterial(material: Material): void;
+    bindTexture(texture: WebGLTextureExt): void;
+    setSize(width: number, height: number): void;
+    abortMaterialLoading(material: Material): void;
+}
+export { GeoTexture2d };

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

@@ -0,0 +1,68 @@
+import { BaseGeoImage, IBaseGeoImageParams } from "./BaseGeoImage";
+import { Material } from "./Material";
+export interface IGeoVideoParams extends IBaseGeoImageParams {
+    videoElement?: HTMLVideoElement;
+    src?: string;
+}
+/**
+ * Used to load and display a video stream by specific corners coordinates on the globe.
+ * @class
+ * @extends {BaseGeoImage}
+ */
+declare class GeoVideo extends BaseGeoImage {
+    /**
+     * HTML5 video element object.
+     * @protected
+     * @type {HTMLVideoElement}
+     */
+    protected _video: HTMLVideoElement | null;
+    /**
+     * Video source url path.
+     * @protected
+     * @type {string}
+     */
+    protected _src: string | null;
+    constructor(name: string | null, options?: IGeoVideoParams);
+    get instanceName(): string;
+    /**
+     * Sets video source url path.
+     * @public
+     * @param {string} src - Video url path.
+     */
+    setSrc(src: string): void;
+    /**
+     * Sets HTML5 video object.
+     * @public
+     * @param {HTMLVideoElement} video - HTML5 video element object.
+     */
+    setVideoElement(video: HTMLVideoElement): void;
+    /**
+     * Sets layer visibility.
+     * @public
+     * @param {boolean} visibility - Layer visibility.
+     */
+    setVisibility(visibility: boolean): void;
+    /**
+     * Creates or refresh source video GL texture.
+     * @virtual
+     * @protected
+     */
+    protected _createSourceTexture(): void;
+    /**
+     * @private
+     */
+    protected _onCanPlay(video: HTMLVideoElement): void;
+    protected _onError(video: HTMLVideoElement): void;
+    /**
+     * Loads planet segment material. In this case - GeoImage source video.
+     * @public
+     * @param {Material} material - GeoImage planet material.
+     */
+    loadMaterial(material: Material): void;
+    /**
+     * @virtual
+     * @param {Material} material - GeoImage material.
+     */
+    abortMaterialLoading(material: Material): void;
+}
+export { GeoVideo };

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

@@ -0,0 +1,72 @@
+import { Billboard, IBillboardParams } from "../entity/Billboard";
+import { Entity } from "../entity/Entity";
+import { Extent } from "../Extent";
+import { Vector, IVectorParams } from "./Vector";
+interface IKMLParams extends IVectorParams {
+    color?: string;
+    billboard?: IBillboardParams;
+}
+/**
+ * Layer to render KMLs files
+ * @class
+ * @extends {Vector}
+ * @param {string} name
+ * @param {*} [options]
+ */
+export declare class KML extends Vector {
+    protected _color: string;
+    protected _billboard: IBillboardParams;
+    constructor(name: string, options?: IKMLParams);
+    get instanceName(): string;
+    protected _extractCoordonatesFromKml(xmlDoc: XMLDocument): number[][][];
+    protected _AGBRtoRGBA(agbr: string): string | undefined;
+    /**
+     * @protected
+     returns array of longitude, latitude, altitude (altitude optional)
+     */
+    protected _parseKMLcoordinates(coords: Element): number[][];
+    protected _kmlPlacemarkToEntity(placemark: Element | undefined | null, extent: Extent): Entity | undefined;
+    protected _extractStyle(placemark: Element): any;
+    protected _parseKML(xml: XMLDocument, extent: Extent, entities?: Entity[]): Entity[];
+    protected _convertKMLintoEntities(xml: XMLDocument): any;
+    /**
+     * Creates billboards or polylines from array of lonlat.
+     * @protected
+     * @param {Array} coordonates
+     * @param {string} color
+     * @returns {any}
+     */
+    protected _convertCoordonatesIntoEntities(coordinates: number[][][][], color: string, billboard?: IBillboardParams): any;
+    /**
+     * @protected
+     * @returns {Document}
+     */
+    protected _getXmlContent(file: Blob): Promise<XMLDocument>;
+    protected _expandExtents(extent1: Extent | null | undefined, extent2: Extent): Extent;
+    /**
+     * @public
+     * @param {File[]} kmls
+     * @param {string} [color]
+     * @param {Billboard} [billboard]
+     * @returns {Promise<{entities: Entity[], extent: Extent}>}
+     */
+    addKmlFromFiles(kmls: Blob[], color?: string, billboard?: IBillboardParams): Promise<{
+        entities: any;
+        extent: any;
+    } | null>;
+    /**
+     * @param {string} color
+     * @public
+     */
+    setColor(color: string): void;
+    protected _getKmlFromUrl(url: string): Promise<Document>;
+    /**
+     * @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}>}
+     */
+    addKmlFromUrl(url: string, color?: string, billboard?: Billboard | IBillboardParams): Promise<any>;
+}
+export {};