@openglobus/og 0.11.7 → 0.12.3

package/types/scene/Planet.d.ts

@@ -0,0 +1,576 @@
+/**
+ * Main class for rendering planet
+ * @class
+ * @extends {RenderNode}
+ * @param {string} [options.name="Earth"] - Planet name(Earth by default)
+ * @param {Ellipsoid} [options.ellipsoid] - Planet ellipsoid(WGS84 by default)
+ * @param {Number} [options.maxGridSize=128] - Segment maximal grid size
+ * @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
+ * @fires og.scene.Planet#draw
+ * @fires og.scene.Planet#layeradd
+ * @fires og.scene.Planet#baselayerchange
+ * @fires og.scene.Planet#layerremove
+ * @fires og.scene.Planet#layervisibilitychange
+ * @fires og.scene.Planet#geoimageadd
+ */
+export class Planet extends RenderNode {
+    static getBearingNorthRotationQuat(cartesian: any): Quat;
+    constructor(options?: {});
+    _cameraFrustums: any;
+    /**
+     * @public
+     * @type {Ellipsoid}
+     */
+    public ellipsoid: Ellipsoid;
+    /**
+     * Squared ellipsoid radius.
+     * @protected
+     * @type {number}
+     */
+    protected _planetRadius2: number;
+    /**
+     * All layers array.
+     * @public
+     * @type {Array.<Layer>}
+     */
+    public layers: Array<Layer>;
+    /**
+     * Current visible imagery tile layers array.
+     * @public
+     * @type {Array.<Layer>}
+     */
+    public visibleTileLayers: Array<Layer>;
+    /**
+     * Current visible vector layers array.
+     * @protected
+     * @type {Array.<layer.Vector>}
+     */
+    protected visibleVectorLayers: Array<layer.Vector>;
+    _visibleTileLayerSlices: any[];
+    /**
+     * Vector layers visible nodes with collections.
+     * @protected
+     * @type {Array.<EntityCollection>}
+     */
+    protected _frustumEntityCollections: Array<EntityCollection>;
+    /**
+     * There is only one base layer on the globe when layer.isBaseLayer is true.
+     * @public
+     * @type {Layer}
+     */
+    public baseLayer: Layer;
+    /**
+     * Terrain provider.
+     * @public
+     * @type {Terrain}
+     */
+    public terrain: Terrain;
+    /**
+     * Camera is this.renderer.activeCamera pointer.
+     * @public
+     * @type {PlanetCamera}
+     */
+    public camera: PlanetCamera;
+    _minAltitude: any;
+    _maxAltitude: any;
+    maxEqualZoomAltitude: any;
+    minEqualZoomAltitude: any;
+    minEqualZoomCameraSlope: any;
+    /**
+     * Screen mouse pointer projected to planet cartesian position.
+     * @public
+     * @type {Vec3}
+     */
+    public mousePositionOnEarth: Vec3;
+    emptyTexture: any;
+    transparentTexture: any;
+    defaultTexture: any;
+    /**
+     * Current visible minimal zoom index planet segment.
+     * @public
+     * @type {number}
+     */
+    public minCurrZoom: number;
+    /**
+     * Current visible maximal zoom index planet segment.
+     * @public
+     * @type {number}
+     */
+    public maxCurrZoom: number;
+    _viewExtent: any;
+    /**
+     * @protected
+     */
+    protected _createdNodesCount: number;
+    /**
+     * Planet's segments collected for rendering frame.
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _renderedNodes: quadTree.Node;
+    _renderedNodesInFrustum: any[];
+    /**
+     * Created nodes cache
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _quadTreeNodesCacheMerc: quadTree.Node;
+    /**
+     * Current visible mercator segments tree nodes array.
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _visibleNodes: quadTree.Node;
+    /**
+     * Current visible north pole nodes tree nodes array.
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _visibleNodesNorth: quadTree.Node;
+    /**
+     * Current visible south pole nodes tree nodes array.
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _visibleNodesSouth: quadTree.Node;
+    /**
+     * Layers activity lock.
+     * @public
+     * @type {idle.Lock}
+     */
+    public layerLock: idle.Lock;
+    /**
+     * Terrain providers activity lock.
+     * @public
+     * @type {idle.Lock}
+     */
+    public terrainLock: idle.Lock;
+    /**
+     * Layer's transparent colors.
+     * @protected
+     */
+    protected _tcolorArr: any[];
+    /**
+     * Height scale factor. 1 - is normal elevation scale.
+     * @protected
+     * @type {number}
+     */
+    protected _heightFactor: number;
+    /**
+     * Precomputed indexes array for differrent grid size segments.
+     * @protected
+     * @type {Array.<Array.<number>>}
+     */
+    protected _indexesCache: Array<Array<number>>;
+    _indexesCacheToRemove: any[];
+    _indexesCacheToRemoveCounter: number;
+    /**
+     * Precomputed texture coordinates buffers for differrent grid size segments.
+     * @protected
+     * @type {Array.<Array.<number>>}
+     */
+    protected _textureCoordsBufferCache: Array<Array<number>>;
+    /**
+     * Framebuffer for relief. Is null when WEBGL_draw_buffers extension initialized.
+     * @protected
+     * @type {Object}
+     */
+    protected _heightPickingFramebuffer: any;
+    /**
+     * Mercator grid tree.
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _quadTree: quadTree.Node;
+    /**
+     * North grid tree.
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _quadTreeNorth: quadTree.Node;
+    /**
+     * South grid tree.
+     * @protected
+     * @type {quadTree.Node}
+     */
+    protected _quadTreeSouth: quadTree.Node;
+    /**
+     * Night glowing gl texture.
+     * @protected
+     */
+    protected _nightTexture: any;
+    /**
+     * Specular mask gl texture.
+     * @protected
+     */
+    protected _specularTexture: any;
+    _ambient: Float32Array;
+    _diffuse: Float32Array;
+    _specular: Float32Array;
+    /**
+     * True for rendering night glowing texture.
+     * @protected
+     * @type {boolean}
+     */
+    protected _useNightTexture: boolean;
+    /**
+     * True for rendering specular mask texture.
+     * @protected
+     * @type {boolean}
+     */
+    protected _useSpecularTexture: boolean;
+    _maxGridSize: number;
+    /**
+     * Segment multiple textures size.(4 - convinient value for the most devices)
+     * @const
+     * @public
+     */
+    public SLICE_SIZE: number;
+    SLICE_SIZE_4: number;
+    SLICE_SIZE_3: number;
+    /**
+     * Level of the visible segment detalization.
+     * @public
+     * @type {number}
+     */
+    public _lodSize: number;
+    _curLodSize: number;
+    _minLodSize: number;
+    _maxLodSize: number;
+    _pickingColorArr: Float32Array;
+    _samplerArr: Int32Array;
+    _pickingMaskArr: Int32Array;
+    /**
+     * GeoImage creator.
+     * @protected
+     * @type{utils.GeoImageCreator}
+     */
+    protected _geoImageCreator: utils.GeoImageCreator;
+    _vectorTileCreator: VectorTileCreator;
+    _normalMapCreator: NormalMapCreator;
+    _terrainWorker: TerrainWorker;
+    _plainSegmentWorker: PlainSegmentWorker;
+    _tileLoader: Loader;
+    _memKey: Key;
+    _distBeforeMemClear: number;
+    _prevCamEye: Vec3;
+    _initialized: boolean;
+    always: any[];
+    _renderCompleted: boolean;
+    /**
+     * Add the given control to the renderer of the planet scene.
+     * @param {control.Control} control - Control.
+     */
+    addControl(control: control.Control): void;
+    get lodSize(): number;
+    setLodSize(currentLodSize: any, minLodSize: any, maxLodSize: any): void;
+    _renderCompletedActivated: boolean;
+    /**
+     * Add the given controls array to the renderer of the planet.
+     * @param {Array.<control.Control>} cArr - Control array.
+     */
+    addControls(cArr: Array<control.Control>): void;
+    /**
+     * Return layer by it name
+     * @param {string} name - Name of the layer. og.Layer.prototype.name
+     * @public
+     * @returns {Layer} -
+     */
+    public getLayerByName(name: string): Layer;
+    /**
+     * Adds the given layer to the planet.
+     * @param {Layer} layer - Layer object.
+     * @public
+     */
+    public addLayer(layer: Layer): void;
+    /**
+     * Dispatch layer visibility changing event.
+     * @param {Layer} layer - Changed layer.
+     * @protected
+     */
+    protected _onLayerVisibilityChanged(layer: Layer): void;
+    /**
+     * Adds the given layers array to the planet.
+     * @param {Array.<Layer>} layers - Layers array.
+     * @public
+     */
+    public addLayers(layers: Array<Layer>): void;
+    /**
+     * Removes the given layer from the planet.
+     * @param {Layer} layer - Layer to remove.
+     * @return {Layer|undefined} The removed layer or undefined if the layer was not found.
+     * @public
+     */
+    public removeLayer(layer: Layer): Layer | undefined;
+    /**
+     *
+     * @protected
+     * @param {Layer} layer - Material layer.
+     */
+    protected _clearLayerMaterial(layer: Layer): void;
+    /**
+     * Get the collection of layers associated with this planet.
+     * @return {Array.<Layer>} Layers array.
+     * @public
+     */
+    public getLayers(): Array<Layer>;
+    /**
+     * Sets base layer coverage to the planet.
+     * @param {Layer} layer - Layer object.
+     * @public
+     */
+    public setBaseLayer(layer: Layer): void;
+    /**
+     * Sets elevation scale. 1.0 is default.
+     * @param {number} factor - Elevation scale.
+     */
+    setHeightFactor(factor: number): void;
+    /**
+     * Gets elevation scale.
+     * @returns {number} Terrain elevation scale
+     */
+    getHeightFactor(): number;
+    /**
+     * Sets terrain provider
+     * @public
+     * @param {Terrain} terrain - Terrain provider.
+     */
+    public setTerrain(terrain: Terrain): void;
+    /**
+     * @virtual
+     * @protected
+     */
+    protected _initializeShaders(): void;
+    /**
+     * @virtual
+     * @public
+     */
+    public init(): void;
+    clearIndexesCache(): void;
+    _preRender(): void;
+    _preLoad(): void;
+    _skipPreRender: boolean;
+    /**
+     * Creates default textures first for nirth pole and whole globe and second for south pole.
+     * @public
+     * @param{Object} param0 -
+     * @param{Object} param1 -
+     */
+    public createDefaultTextures(param0: any, param1: any): void;
+    /**
+     * Updates attribution lists
+     * @public
+     */
+    public updateAttributionsList(): void;
+    /**
+     * Updates visible layers.
+     * @public
+     */
+    public updateVisibleLayers(): void;
+    /**
+     * Sort visible layer - preparing for rendering.
+     * @protected
+     */
+    protected _sortLayers(): void;
+    _clearRenderedNodeList(): void;
+    /**
+     * Collects visible quad nodes.
+     * @protected
+     */
+    protected _collectRenderNodes(): void;
+    _globalPreDraw(): void;
+    /**
+     * Render node callback.
+     * @public
+     */
+    public frame(): void;
+    _checkRendercompleted(): void;
+    /**
+     * @protected
+     */
+    protected _renderScreenNodesPASS(): void;
+    /**
+     * @protected
+     */
+    protected _renderHeightPickingFramebufferPASS(): void;
+    /**
+     * @protected
+     */
+    protected _renderColorPickingFramebufferPASS(): void;
+    /**
+     * @protected
+     */
+    protected _renderDepthFramebufferPASS(): void;
+    _collectVectorLayerCollections(): void;
+    /**
+     * Vector layers picking pass.
+     * @protected
+     */
+    protected _frustumEntityCollectionPickingCallback(): void;
+    /**
+     * Starts clear memory thread.
+     * @public
+     */
+    public memClear(): void;
+    /**
+     * Returns ray vector hit ellipsoid coordinates.
+     * If the ray doesn't hit ellipsoit returns null.
+     * @public
+     * @param {Ray} ray - Ray 3d.
+     * @returns {Vec3} -
+     */
+    public getRayIntersectionEllipsoid(ray: Ray): Vec3;
+    /**
+     * Returns 2d screen coordanates projection point to the planet ellipsoid 3d coordinates.
+     * @public
+     * @param {math.Pixel} px - 2D sreen coordinates.
+     * @returns {Vec3} -
+     */
+    public getCartesianFromPixelEllipsoid(px: math.Pixel): Vec3;
+    /**
+     * Returns 2d screen coordanates projection point to the planet ellipsoid geographical coordinates.
+     * @public
+     * @param {math.Pixel} px - 2D screen coordinates.
+     * @returns {LonLat} -
+     */
+    public getLonLatFromPixelEllipsoid(px: math.Pixel): LonLat;
+    /**
+     * Returns 3d cartesian coordinates on the relief planet by mouse cursor
+     * position or null if mouse cursor is outside the planet.
+     * @public
+     * @returns {Vec3} -
+     */
+    public getCartesianFromMouseTerrain(): Vec3;
+    /**
+     * Returns 3d cartesian coordinates on the relief planet by 2d screen coordinates.
+     * position or null if input coordinates is outside the planet.
+     * @public
+     * @param {Vec2} px - Pixel screen 2d coordinates.
+     * @param {Boolean} [force=false] - Force framebuffer rendering.
+     * @returns {Vec3} -
+     */
+    public getCartesianFromPixelTerrain(px: Vec2): Vec3;
+    /**
+     * Returns geographical coordinates on the relief planet by 2d screen coordinates.
+     * position or null if input coordinates is outside the planet.
+     * @public
+     * @param {Vec2} px - Pixel screen 2d coordinates.
+     * @param {Boolean} [force=false] - Force framebuffer rendering.
+     * @returns {LonLat} -
+     */
+    public getLonLatFromPixelTerrain(px: Vec2, force?: boolean): LonLat;
+    /**
+     * Returns projected 2d screen coordinates by 3d cartesian coordiantes.
+     * @public
+     * @param {Vec3} coords - Cartesian coordinates.
+     * @returns {Vec2} -
+     */
+    public getPixelFromCartesian(coords: Vec3): Vec2;
+    /**
+     * Returns projected 2d screen coordinates by geographical coordinates.
+     * @public
+     * @param {LonLat} lonlat - Geographical coordinates.
+     * @returns {Vec2} -
+     */
+    public getPixelFromLonLat(lonlat: LonLat): Vec2;
+    /**
+     * Returns distance from active camera to the the planet ellipsoid
+     * coordiantes unprojected by 2d screen coordiantes, or null if screen coordinates outside the planet.
+     * @public
+     * @param {Vec2} px - Screen coordinates.
+     * @returns {number} -
+     */
+    public getDistanceFromPixelEllipsoid(px: Vec2): number;
+    /**
+     * Returns distance from active camera to the the relief planet coordiantes unprojected
+     * by 2d screen coordiantes, or null if screen coordinates outside the planet.
+     * If screen coordinates inside the planet but relief is not exists in the
+     * point than function returns distance to the planet ellipsoid.
+     * @public
+     * @param {Vec2} px - Screen coordinates.
+     * @param {Boolean} [force=false] - Force framebuffer rendering.
+     * @returns {number} -
+     */
+    public getDistanceFromPixel(px: Vec2): number;
+    /**
+     * Sets camera to the planet geographical extent.
+     * @public
+     * @param {Extent} extent - Geographical extent.
+     */
+    public viewExtent(extent: Extent): void;
+    /**
+     * Sets camera to the planet geographical extent.
+     * @public
+     * @param {Array.<number>} extentArr - Geographical extent array, (exactly 4 entries)
+     * where index 0 - southwest longitude, 1 - latitude southwest, 2 - longitude northeast, 3 - latitude northeast.
+     */
+    public viewExtentArr(extentArr: Array<number>): void;
+    /**
+     * Gets current viewing geographical extent.
+     * @public
+     * @returns {Extent} -
+     */
+    public getViewExtent(): Extent;
+    /**
+     * Sets camera to the planet geographical position.
+     * @public
+     * @param {LonLat} lonlat - New geographical position.
+     * @param {Vec3} [up] - Camera UP vector.
+     */
+    public viewLonLat(lonlat: LonLat, up?: Vec3): void;
+    /**
+     * Fly camera to the planet geographical extent.
+     * @public
+     * @param {Extent} extent - Geographical extent.
+     * @param {Number} [height] - Height on the end of the flight route.
+     * @param {Vec3} [up] - Camera UP vector on the end of a flying.
+     * @param {Number} [ampl] - Altitude amplitude factor.
+     * @param {cameraCallback} [startCallback] - Callback that calls after flying when flying is finished.
+     * @param {cameraCallback} [completeCallback] - Callback that calls befor the flying begins.
+     */
+    public flyExtent(extent: Extent, height?: number, up?: Vec3, ampl?: number, completeCallback?: cameraCallback, startCallback?: cameraCallback): void;
+    /**
+     * Fly camera to the new point.
+     * @public
+     * @param {Vec3} cartesian - Fly coordiantes.
+     * @param {Vec3} [look] - Camera "look at" point.
+     * @param {Vec3} [up] - Camera UP vector on the end of a flying.
+     * @param {Number} [ampl] - Altitude amplitude factor.
+     * @param [completeCallback]
+     * @param [startCallback]
+     * @param [frameCallback]
+     */
+    public flyCartesian(cartesian: Vec3, look?: Vec3, up?: Vec3, ampl?: number, completeCallback?: any, startCallback?: any, frameCallback?: any): void;
+    /**
+     * Fly camera to the new geographical position.
+     * @public
+     * @param {LonLat} lonlat - Fly geographical coordiantes.
+     * @param {Vec3} [look] - Camera "look at" point on the end of a flying.
+     * @param {Vec3} [up] - Camera UP vector on the end of a flying.
+     * @param {Number} [ampl] - Altitude amplitude factor.
+     * @param [completeCallback]
+     * @param [startCallback]
+     * @param [frameCallback]
+     */
+    public flyLonLat(lonlat: LonLat, look?: Vec3, up?: Vec3, ampl?: number, completeCallback?: any, startCallback?: any, frameCallback?: any): void;
+    /**
+     * Breaks the flight.
+     * @public
+     */
+    public stopFlying(): void;
+    getEntityTerrainPoint(entity: any, res: any): any;
+}
+import { RenderNode } from "./RenderNode.js";
+import { PlanetCamera } from "../camera/PlanetCamera.js";
+import { Vec3 } from "../math/index.js";
+import { VectorTileCreator } from "../utils/VectorTileCreator.js";
+import { NormalMapCreator } from "../utils/NormalMapCreator.js";
+import { TerrainWorker } from "../utils/TerrainWorker.js";
+import { PlainSegmentWorker } from "../utils/PlainSegmentWorker.js";
+import { Loader } from "../utils/Loader.js";
+import { Key } from "../Lock.js";
+import { LonLat } from "../LonLat.js";
+import { Extent } from "../Extent.js";
+import { Quat } from "../math/index.js";

package/types/scene/RenderNode.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Render node is a logical part of a render mechanism. Represents scene rendering.
+ * Forexample one scene node for rendering the Earth, another one for rendering the Moon, another node for rendering stars etc.
+ * Each render node has own model view space defined with matrices(scale, rotation, translation, transformation).
+ * There are collections of ligh sources, entities and so on in the node.
+ * Access to the node is renderer.renderNodes["Earth"]
+ * @class
+ * @extends {RenderNode}
+ * @param {string} name - Node name.
+ */
+export class RenderNode {
+    /**
+     * Renderer that calls frame() callback.
+     * @public
+     * @type {Renderer}
+     */
+    public renderer: Renderer;
+    drawMode: number;
+    /** Show rendering.
+     * @public
+     */
+    public show: boolean;
+    _isActive: boolean;
+    /**
+     * Lighting calculations.
+     * @public
+     * @type {boolean}
+     */
+    public lightEnabled: boolean;
+    /**
+     * Point light array.
+     * @private
+     * @type {Array.<LightSource>}
+     */
+    private _lights;
+    _lightsTransformedPositions: any[];
+    _lightsParamsv: any[];
+    _lightsParamsf: any[];
+    _lightsNames: any[];
+    /**
+     * Entity collection array.
+     * @public
+     * @type {Array.<EntityCollection>}
+     */
+    public entityCollections: Array<EntityCollection>;
+    _pickingId: number;
+    events: Events;
+    /**
+     * Adds node to the current hierarchy.
+     * @public
+     * @type {RenderNode}
+     */
+    public addNode(node: any): void;
+    /**
+     * Assign render node with renderer.
+     * @public
+     * @param {Renderer} renderer - Redner node's renderer.
+     */
+    public assign(renderer: Renderer): void;
+    onremove(): void;
+    remove(): void;
+    /**
+     * Adds entity collection.
+     * @public
+     * @param {EntityCollection} entityCollection - Entity collection.
+     * @param {boolean} [isHidden] - If it's true that this collection has specific rendering.
+     * @returns {RenderNode} -
+     */
+    public addEntityCollection(entityCollection: EntityCollection, isHidden?: boolean): RenderNode;
+    /**
+     * Removes entity collection.
+     * @public
+     * @param {EntityCollection} entityCollection - Entity collection for remove.
+     */
+    public removeEntityCollection(entityCollection: EntityCollection): void;
+    /**
+     * Adds point light source.
+     * @public
+     * @param {LightSource} light - Light source.
+     * @returns {RenderNode}
+     */
+    public addLight(light: LightSource): RenderNode;
+    /**
+     * Gets light object by its name.
+     * @public
+     * @param {string} name - Point light name.
+     * @returns {LightSource}
+     */
+    public getLightByName(name: string): LightSource;
+    /**
+     * Removes light source.
+     * @public
+     * @param {LightSource} light - Light source object.
+     */
+    public removeLight(light: LightSource): void;
+    /**
+     * Calls render frame node's callback. Used in renderer.
+     * @public
+     */
+    public drawNode(frustum: any, frustumIndex: any): void;
+    /**
+     * Gets render node activity.
+     * @public
+     * @returns {Boolean} -
+     */
+    public isActive(): boolean;
+    /**
+     * Rendering activation.
+     * @public
+     * @param {boolean} isActive - Activation flag.
+     */
+    public setActive(isActive: boolean): void;
+    /**
+     * Sets draw mode
+     * @public
+     * @param {Number} mode - Draw mode, such as gl.TRIANGLES, gl.TRIANGLE_STRIP, gl.LINES etc.
+     */
+    public setDrawMode(mode: number): void;
+    /**
+     * IMPORTANT: This function have to be called manualy in each render node frame callback, before drawing scene geometry.
+     * @public
+     */
+    public transformLights(): void;
+    updateBillboardsTexCoords(): void;
+    /**
+     * @private
+     */
+    private _drawNodes;
+    drawEntityCollections(ec: any): void;
+    /**
+     * Draw entity collections picking frame.
+     * @public
+     * @param {Array<og.EntityCollection>} ec - Entity collection array.
+     */
+    public drawPickingEntityCollections(ec: Array<og.EntityCollection>): void;
+    /**
+     * Picking entity frame callback
+     * @private
+     */
+    private _entityCollectionPickingCallback;
+}
+import { Events } from "../Events.js";