@openglobus/og 0.11.7 → 0.12.3

package/types/entity/EntityCollection.d.ts

@@ -0,0 +1,317 @@
+/**
+ * An observable collection of og.Entity instances where each entity has a unique id.
+ * Entity collection provide handlers for an each type of entity like billboard, label or 3ds object.
+ * @constructor
+ * @param {Object} [options] - Entity options:
+ * @param {Array.<Entity>} [options.entities] - Entities array.
+ * @param {boolean} [options.visibility=true] - Entity visibility.
+ * @param {Array.<number>} [options.scaleByDistance] - Entity scale by distance parameters. (exactly 3 entries)
+ * First index - near distance to the entity, after entity becomes full scale.
+ * Second index - far distance to the entity, when entity becomes zero scale.
+ * Third index - far distance to the entity, when entity becomes invisible.
+ * @param {number} [options.opacity] - Entity global opacity.
+ * @param {boolean} [options.pickingEnabled=true] - Entity picking enable.
+ * @param {Number} [options.polygonOffsetFactor=0.0] - The scale factor for the variable depth offset. The default value is 0.
+ * @param {Number} [options.polygonOffsetUnits=0.0] - The multiplier by which an implementation-specific value is multiplied with to create a constant depth offset. The default value is 0.
+ * @fires og.EntityCollection#entitymove
+ * @fires og.EntityCollection#draw
+ * @fires og.EntityCollection#drawend
+ * @fires og.EntityCollection#add
+ * @fires og.EntityCollection#remove
+ * @fires og.EntityCollection#entityadd
+ * @fires og.EntityCollection#entityremove
+ * @fires og.EntityCollection#visibilitychange
+ * @fires og.EntityCollection#mousemove
+ * @fires og.EntityCollection#mouseenter
+ * @fires og.EntityCollection#mouseleave
+ * @fires og.EntityCollection#lclick
+ * @fires og.EntityCollection#rclick
+ * @fires og.EntityCollection#mclick
+ * @fires og.EntityCollection#ldblclick
+ * @fires og.EntityCollection#rdblclick
+ * @fires og.EntityCollection#mdblclick
+ * @fires og.EntityCollection#lup
+ * @fires og.EntityCollection#rup
+ * @fires og.EntityCollection#mup
+ * @fires og.EntityCollection#ldown
+ * @fires og.EntityCollection#rdown
+ * @fires og.EntityCollection#mdown
+ * @fires og.EntityCollection#lhold
+ * @fires og.EntityCollection#rhold
+ * @fires og.EntityCollection#mhold
+ * @fires og.EntityCollection#mousewheel
+ * @fires og.EntityCollection#touchmove
+ * @fires og.EntityCollection#touchstart
+ * @fires og.EntityCollection#touchend
+ * @fires og.EntityCollection#doubletouch
+ * @fires og.EntityCollection#touchleave
+ * @fires og.EntityCollection#touchenter
+ */
+export class EntityCollection {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(options: any);
+    /**
+     * Unic identifier.
+     * @public
+     * @readonly
+     */
+    public readonly id: number;
+    /**
+     * Render node collections array index.
+     * @protected
+     * @type {number}
+     */
+    protected _renderNodeIndex: number;
+    /**
+     * Render node context.
+     * @public
+     * @type {RenderNode}
+     */
+    public renderNode: RenderNode;
+    /**
+     * Visibility option.
+     * @protected
+     * @type {boolean}
+     */
+    protected _visibility: boolean;
+    /**
+     * Specifies the scale factor for gl.polygonOffset function to calculate depth values, 0.0 is default.
+     * @public
+     * @type {Number}
+     */
+    public polygonOffsetFactor: number;
+    /**
+     * Specifies the scale Units for gl.polygonOffset function to calculate depth values, 0.0 is default.
+     * @public
+     * @type {Number}
+     */
+    public polygonOffsetUnits: number;
+    /**
+     * Billboards handler
+     * @public
+     * @type {BillboardHandler}
+     */
+    public billboardHandler: BillboardHandler;
+    /**
+     * Labels handler
+     * @public
+     * @type {LabelHandler}
+     */
+    public labelHandler: LabelHandler;
+    /**
+     * Shape handler
+     * @public
+     * @type {ShapeHandler}
+     */
+    public shapeHandler: ShapeHandler;
+    /**
+     * Polyline handler
+     * @public
+     * @type {PolylineHandler}
+     */
+    public polylineHandler: PolylineHandler;
+    /**
+     * Ray handler
+     * @public
+     * @type {RayHandler}
+     */
+    public rayHandler: RayHandler;
+    /**
+     * PointCloud handler
+     * @public
+     * @type {PointCloudHandler}
+     */
+    public pointCloudHandler: PointCloudHandler;
+    /**
+     * Strip handler
+     * @public
+     * @type {StripHandler}
+     */
+    public stripHandler: StripHandler;
+    /**
+     * Geo object handler
+     * @public
+     * @type {og.GeoObjectHandler}
+     */
+    public geoObjectHandler: og.GeoObjectHandler;
+    /**
+     * Entities array.
+     * @protected
+     * @type {Array.<Entity>}
+     */
+    protected _entities: Array<Entity>;
+    /**
+     * First index - near distance to the entity, after entity becomes full scale.
+     * Second index - far distance to the entity, when entity becomes zero scale.
+     * Third index - far distance to the entity, when entity becomes invisible.
+     * @public
+     * @type {Array.<number>} - (exactly 3 entries)
+     */
+    public scaleByDistance: Array<number>;
+    pickingScale: any;
+    /**
+     * Global opacity.
+     * @protected
+     * @type {number}
+     */
+    protected _opacity: number;
+    /**
+     * Opacity state during the animated opacity.
+     * @protected
+     * @type {number}
+     */
+    protected _fadingOpacity: number;
+    /**
+     * Entity collection events handler.
+     * @public
+     * @type {Events}
+     */
+    public events: Events;
+    rendererEvents: Events;
+    setPolygonOffset(factor: any, units: any): void;
+    /**
+     * Sets collection visibility.
+     * @public
+     * @param {boolean} visibility - Visibility flag.
+     */
+    public setVisibility(visibility: boolean): void;
+    /**
+     * Returns collection visibility.
+     * @public
+     * @returns {boolean} -
+     */
+    public getVisibility(): boolean;
+    /**
+     * Sets collection opacity.
+     * @public
+     * @param {number} opacity - Opacity.
+     */
+    public setOpacity(opacity: number): void;
+    /**
+     * Sets collection picking ability.
+     * @public
+     * @param {boolean} enable - Picking enable flag.
+     */
+    public setPickingEnabled(enable: boolean): void;
+    /**
+     * Gets collection opacity.
+     * @public
+     * @returns {number} -
+     */
+    public getOpacity(): number;
+    /**
+     * Sets scale by distance parameters.
+     * @public
+     * @param {number} near - Full scale entity distance.
+     * @param {number} far - Zerol scale entity distance.
+     * @param {number} [farInvisible] - Entity visibility distance.
+     */
+    public setScaleByDistance(near: number, far: number, farInvisible?: number): void;
+    _addRecursively(entity: any): void;
+    /**
+     * Adds entity to the collection and returns collection.
+     * @public
+     * @param {Entity} entity - Entity.
+     * @returns {EntityCollection} -
+     */
+    public add(entity: Entity): EntityCollection;
+    /**
+     * Adds entities array to the collection and returns collection.
+     * @public
+     * @param {Array.<Entity>} entities - Entities array.
+     * @returns {EntityCollection} -
+     */
+    public addEntities(entities: Array<Entity>): EntityCollection;
+    /**
+     * Returns true if the entity belongs this collection, otherwise returns false.
+     * @public
+     * @param {Entity} entity - Entity.
+     * @returns {boolean} -
+     */
+    public belongs(entity: Entity): boolean;
+    _removeRecursively(entity: any): void;
+    /**
+     * Removes entity from this collection.
+     * @public
+     * @param {Entity} entity - Entity to remove.
+     */
+    public removeEntity(entity: Entity): void;
+    _removeEntitySilent(entity: any): void;
+    /**
+     * Creates or refresh collected entities picking color.
+     * @public
+     */
+    public createPickingColors(): void;
+    /**
+     * Refresh collected entities indexes from startIndex entitytes collection array position.
+     * @public
+     * @param {number} startIndex - Entities collection array index.
+     */
+    public reindexEntitiesArray(startIndex: number): void;
+    /**
+     * Adds this collection to render node.
+     * @public
+     * @param {RenderNode} renderNode - Render node.
+     * @param {boolean} [isHidden] - Uses in vector layers that render in planet render specific function.
+     * @returns {EntityCollection} -
+     */
+    public addTo(renderNode: RenderNode, isHidden?: boolean): EntityCollection;
+    /**
+     * This function is called in the RenderNode assign function.
+     * @param {RenderNode} renderNode
+     */
+    bindRenderNode(renderNode: RenderNode): void;
+    /**
+     * Updates coordiantes all lonLat entities in collection after collecction attached to the planet node.
+     * @private
+     * @param {Ellipsoid} ellipsoid - Globe ellipsoid.
+     */
+    private _updateGeodeticCoordinates;
+    /**
+     * Updates billboard texture atlas.
+     * @public
+     */
+    public updateBillboardsTextureAtlas(): void;
+    /**
+     * Updates labels font atlas.
+     * @public
+     */
+    public updateLabelsFontAtlas(): void;
+    /**
+     * Removes collection from render node.
+     * @public
+     */
+    public remove(): void;
+    /**
+     * Gets entity array.
+     * @public
+     * @returns {Array.<Entity>} -
+     */
+    public getEntities(): Array<Entity>;
+    /**
+     * Safety entities loop.
+     * @public
+     * @param {function} callback - Entity callback.
+     */
+    public each(callback: Function): void;
+    /**
+     * Removes all entities from colection and clear handlers.
+     * @public
+     */
+    public clear(): void;
+    /**
+     * Clears entity recursevely.
+     * @private
+     * @param {Entity} entity - Entity to clear.
+     */
+    private _clearEntity;
+}
+import { BillboardHandler } from "./BillboardHandler.js";
+import { LabelHandler } from "./LabelHandler.js";
+import { ShapeHandler } from "./ShapeHandler.js";
+import { PolylineHandler } from "./PolylineHandler.js";
+import { RayHandler } from "./RayHandler.js";
+import { PointCloudHandler } from "./PointCloudHandler.js";
+import { StripHandler } from "./StripHandler.js";
+import { Events } from "../Events.js";

package/types/entity/GeoObject.d.ts

@@ -0,0 +1,111 @@
+/**
+ * @class
+ * @param {Object} options -  Geo object parameters:
+ * @param {og.Vec3} [options.position] - Geo object position.
+ */
+export class GeoObject {
+    constructor(options: any);
+    scale: any;
+    scaleByDistance: Float32Array;
+    /**
+     * Geo object center cartesian position.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _position: og.Vec3;
+    _positionHigh: Vec3;
+    _positionLow: Vec3;
+    _pitch: any;
+    _yaw: any;
+    _roll: any;
+    _planet: any;
+    _lonLatAlt: LonLat;
+    /**
+     * RGBA color.
+     * @protected
+     * @type {og.Vec4}
+     */
+    protected _color: og.Vec4;
+    _direction: Vec3;
+    _handler: any;
+    _handlerIndex: number;
+    _vertices: any;
+    _normals: any;
+    _indices: any;
+    instanced: any;
+    tag: any;
+    _indicesCount: any;
+    _verticesCount: number;
+    get planet(): any;
+    get renderer(): any;
+    /**
+     * Sets geo object opacity.
+     * @public
+     * @param {number} a - Billboard opacity.
+     */
+    public setOpacity(a: number): void;
+    /**
+     * Sets RGBA color. Each channel from 0.0 to 1.0.
+     * @public
+     * @param {number} r - Red.
+     * @param {number} g - Green.
+     * @param {number} b - Blue.
+     * @param {number} a - Alpha.
+     */
+    public setColor(r: number, g: number, b: number, a: number): void;
+    /**
+     * Sets RGBA color. Each channel from 0.0 to 1.0.
+     * @public
+     * @param {og.Vec4} color - RGBA vector.
+     */
+    public setColor4v(color: og.Vec4): void;
+    /**
+     * Sets geo object visibility.
+     * @public
+     * @param {boolean} visibility - Visibility flag.
+     */
+    public setVisibility(visibility: boolean): void;
+    _visibility: boolean;
+    /**
+     * Returns  geo object visibility.
+     * @public
+     * @returns {boolean}
+     */
+    public getVisibility(): boolean;
+    setLonLat(lon: any, lat: any, alt: any): void;
+    /**
+     * Sets geoObject position.
+     * @public
+     * @param {number} x - X coordinate.
+     * @param {number} y - Y coordinate.
+     * @param {number} z - Z coordinate.
+     */
+    public setPosition(x: number, y: number, z: number): void;
+    /**
+     * Sets billboard position.
+     * @public
+     * @param {og.Vec3} position - Cartesian coordinates.
+     */
+    public setPosition3v(position: og.Vec3): void;
+    setYaw(yaw: any): void;
+    setPitch(pitch: any): void;
+    setRoll(roll: any): void;
+    setScale(scale: any): void;
+    /**
+     * Removes geo object from handler.
+     * @public
+     */
+    public remove(): void;
+    _entity: any;
+    /**
+     * Sets billboard picking color.
+     * @public
+     * @param {og.Vec3} color - Picking color.
+     */
+    public setPickingColor3v(color: og.Vec3): void;
+    updateDirection(): void;
+    _qNorthFrame: Quat;
+}
+import { Vec3 } from "../math/index.js";
+import { LonLat } from "../LonLat.js";
+import { Quat } from "../math/index.js";

package/types/entity/GeoObjectHandler.d.ts

@@ -0,0 +1,81 @@
+export class GeoObjectHandler {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(entityCollection: any);
+    /**
+     * Picking rendering option.
+     * @public
+     * @type {boolean}
+     */
+    public pickingEnabled: boolean;
+    _entityCollection: any;
+    _renderer: any;
+    _planet: any;
+    _geoObjects: any[];
+    _pitchRollArr: any[][];
+    _sizeArr: any[][];
+    _vertexArr: any[][];
+    _positionHighArr: any[][];
+    _positionLowArr: any[][];
+    _directionArr: any[][];
+    _rgbaArr: any[][];
+    _normalsArr: any[][];
+    _indicesArr: any[][];
+    _pickingColorArr: any[][];
+    _vehicleVisibleArr: any[][];
+    _pitchRollBuffer: any[];
+    _sizeBuffer: any[];
+    _vertexBuffer: any[];
+    _positionHighBuffer: any[];
+    _positionLowBuffer: any[];
+    _directionBuffer: any[];
+    _rgbaBuffer: any[];
+    _normalsBuffer: any[];
+    _indicesBuffer: any[];
+    _pickingColorBuffer: any[];
+    _vehicleVisibleBuffer: any[];
+    __staticId: number;
+    _buffersUpdateCallbacks: (() => void)[];
+    _changedBuffers: any[];
+    _instancedTags: Map<any, any>;
+    getObjectByIndex(index: any): any;
+    createVertexBuffer(): void;
+    createPitchRollBuffer(): void;
+    createVisibleBuffer(): void;
+    createSizeBuffer(): void;
+    createPositionBuffer(): void;
+    createRgbaBuffer(): void;
+    createDirectionBuffer(): void;
+    createNormalsBuffer(): void;
+    createIndicesBuffer(): void;
+    createPickingColorBuffer(): void;
+    initProgram(): void;
+    setRenderNode(renderNode: any): void;
+    setRenderer(planet: any): void;
+    _addGeoObjectToArray(geoObject: any): void;
+    _displayPASS(): void;
+    drawPicking(): void;
+    _pickingPASS(): void;
+    _recalculateIndices(startIndex: any): void;
+    _addIndices(g: any): void;
+    _removeIndices(geoObject: any): void;
+    setDirectionArr(index: any, direction: any): void;
+    setVisibility(index: any, visibility: any): void;
+    setPositionArr(index: any, positionHigh: any, positionLow: any): void;
+    setRgbaArr(index: any, rgba: any): void;
+    getTagIndexByObjectIndex(index: any): any;
+    getTagDataByObjectIndex(index: any): any;
+    setPickingColorArr(index: any, color: any): void;
+    setPitchRollArr(index: any, pitch: any, roll: any): void;
+    setScaleArr(index: any, scale: any): void;
+    refresh(): void;
+    _removeGeoObjects(): void;
+    clear(): void;
+    _deleteBuffers(): void;
+    update(): void;
+    draw(): void;
+    _reindexGeoObjects(startIndex: any, tag: any): void;
+    add(geoObject: any): void;
+    remove(geoObject: any): void;
+    _removeGeoObject(geoObject: any): void;
+}

package/types/entity/Geometry.d.ts

@@ -0,0 +1,74 @@
+export class Geometry {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    static getType(typeStr: any): any;
+    /**
+     * Returns geometry feature extent.
+     @static
+     @param {Object} geometryObj - GeoJSON style geometry feature.
+     @param {LonLat[]} outCoordinates - Geometry feature coordinates clone.
+     @returns {Extent} -
+     */
+    static getExtent(geometryObj: any, outCoordinates: LonLat[]): Extent;
+    constructor(options: any);
+    _id: number;
+    /**
+     * Entity instance that holds this geometry.
+     * @protected
+     * @type {Entity}
+     */
+    protected _entity: Entity;
+    _handler: any;
+    _handlerIndex: number;
+    _polyVerticesHighMerc: any[];
+    _polyVerticesLowMerc: any[];
+    _polyVerticesLength: number;
+    _polyIndexesLength: number;
+    _polyVerticesHandlerIndex: number;
+    _polyIndexesHandlerIndex: number;
+    _lineVerticesHighMerc: any[];
+    _lineVerticesLowMerc: any[];
+    _lineVerticesLength: number;
+    _lineOrdersLength: number;
+    _lineIndexesLength: number;
+    _lineColorsLength: number;
+    _lineThicknessLength: number;
+    _lineVerticesHandlerIndex: number;
+    _lineOrdersHandlerIndex: number;
+    _lineIndexesHandlerIndex: number;
+    _lineThicknessHandlerIndex: number;
+    _lineColorsHandlerIndex: number;
+    _type: any;
+    _coordinates: any[];
+    _extent: Extent;
+    _style: any;
+    _visibility: any;
+    _pickingReady: boolean;
+    setGeometry(geoJson: any): Geometry;
+    setFillColor(r: any, g: any, b: any, a: any): Geometry;
+    setFillColor4v(rgba: any): Geometry;
+    setStrokeColor(r: any, g: any, b: any, a: any): Geometry;
+    setLineColor(r: any, g: any, b: any, a: any): Geometry;
+    setStrokeColor4v(rgba: any): Geometry;
+    setLineColor4v(rgba: any): Geometry;
+    setStrokeOpacity(opacity: any): Geometry;
+    setLineOpacity(opacity: any): Geometry;
+    setStrokeWidth(width: any): Geometry;
+    bringToFront(): Geometry;
+    setLineWidth(width: any): Geometry;
+    setFillOpacity(opacity: any): Geometry;
+    setVisibility(visibility: any): Geometry;
+    getVisibility(): any;
+    remove(): void;
+    getExtent(): Extent;
+    getType(): any;
+}
+export namespace GeometryType {
+    const POINT: number;
+    const LINESTRING: number;
+    const POLYGON: number;
+    const MULTIPOLYGON: number;
+    const MULTILINESTRING: number;
+}
+import { Extent } from "../Extent.js";
+import { LonLat } from "../LonLat.js";

package/types/entity/GeometryHandler.d.ts

@@ -0,0 +1,76 @@
+export class GeometryHandler {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    static appendLineData(pathArr: any, isClosed: any, color: any, pickingColor: any, thickness: any, strokeColor: any, strokeSize: any, outVerticesHigh: any, outVerticesLow: any, outOrders: any, outIndexes: any, outColors: any, outPickingColors: any, outThickness: any, outStrokeColors: any, outStrokes: any, outVerticesHigh2: any, outVerticesLow2: any): void;
+    constructor(layer: any);
+    __staticId: number;
+    _layer: any;
+    _handler: any;
+    _geometries: any[];
+    _updatedGeometryArr: any[];
+    _updatedGeometry: {};
+    _removeGeometryExtentArr: any[];
+    _removeGeometryExtents: {};
+    _polyVerticesHighMerc: any[];
+    _polyVerticesLowMerc: any[];
+    _polyColors: any[];
+    _polyPickingColors: any[];
+    _polyIndexes: any[];
+    _lineVerticesHighMerc: any[];
+    _lineVerticesLowMerc: any[];
+    _lineOrders: any[];
+    _lineIndexes: any[];
+    _lineColors: any[];
+    _linePickingColors: any[];
+    _lineThickness: any[];
+    _lineStrokes: any[];
+    _lineStrokeColors: any[];
+    _polyVerticesHighBufferMerc: any;
+    _polyVerticesLowBufferMerc: any;
+    _polyColorsBuffer: any;
+    _polyPickingColorsBuffer: any;
+    _polyIndexesBuffer: any;
+    _lineVerticesHighBufferMerc: any;
+    _lineVerticesLowBufferMerc: any;
+    _lineColorsBuffer: any;
+    _linePickingColorsBuffer: any;
+    _lineThicknessBuffer: any;
+    _lineStrokesBuffer: any;
+    _lineStrokeColorsBuffer: any;
+    _lineOrdersBuffer: any;
+    _lineIndexesBuffer: any;
+    _buffersUpdateCallbacks: (() => void)[];
+    _changedBuffers: any[];
+    assignHandler(handler: any): void;
+    /**
+     * @public
+     * @param {Geometry} geometry - Geometry object.
+     */
+    public add(geometry: Geometry): void;
+    remove(geometry: any): void;
+    _refreshRecursevely(geometry: any, treeNode: any): void;
+    _refreshRecursevelyExt(extent: any, treeNode: any): void;
+    _refreshPlanetNode(treeNode: any): void;
+    _updatePlanet(): void;
+    refresh(): void;
+    update(): void;
+    setGeometryVisibility(geometry: any): void;
+    setPolyColorArr(geometry: any, color: any): void;
+    setLineStrokeColorArr(geometry: any, color: any): void;
+    setLineColorArr(geometry: any, color: any): void;
+    setLineStrokeArr(geometry: any, width: any): void;
+    setLineThicknessArr(geometry: any, width: any): void;
+    bringToFront(geometry: any): void;
+    createPolyVerticesBuffer(): void;
+    createPolyIndexesBuffer(): void;
+    createPolyColorsBuffer(): void;
+    createPolyPickingColorsBuffer(): void;
+    createLineVerticesBuffer(): void;
+    createLineIndexesBuffer(): void;
+    createLineOrdersBuffer(): void;
+    createLineColorsBuffer(): void;
+    createLinePickingColorsBuffer(): void;
+    createLineThicknessBuffer(): void;
+    createLineStrokesBuffer(): void;
+    createLineStrokeColorsBuffer(): void;
+}