@openglobus/og 0.10.4 → 0.11.1

package/types/entity/EntityCollection.d.ts

@@ -0,0 +1,303 @@
+/**
+ * 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.<og.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 {og.scene.RenderNode}
+     */
+    public renderNode: any;
+    /**
+     * 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 {og.BillboardHandler}
+     */
+    public billboardHandler: any;
+    /**
+     * Labels handler
+     * @public
+     * @type {og.LabelHandler}
+     */
+    public labelHandler: any;
+    /**
+     * Shape handler
+     * @public
+     * @type {og.ShapeHandler}
+     */
+    public shapeHandler: any;
+    /**
+     * Polyline handler
+     * @public
+     * @type {og.PolylineHandler}
+     */
+    public polylineHandler: any;
+    /**
+     * Ray handler
+     * @public
+     * @type {og.RayHandler}
+     */
+    public rayHandler: any;
+    /**
+     * PointCloud handler
+     * @public
+     * @type {og.PointCloudHandler}
+     */
+    public pointCloudHandler: any;
+    /**
+     * Strip handler
+     * @public
+     * @type {og.StripHandler}
+     */
+    public stripHandler: any;
+    /**
+     * Entities array.
+     * @protected
+     * @type {Array.<og.Entity>}
+     */
+    protected _entities: Array<any>;
+    /**
+     * 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,number,number>}
+     */
+    public scaleByDistance: Array<number, number, 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 {og.Events}
+     */
+    public events: any;
+    rendererEvents: any;
+    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 {og.Entity} entity - Entity.
+     * @returns {og.EntityCollection} -
+     */
+    public add(entity: any): any;
+    /**
+     * Adds entities array to the collection and returns collection.
+     * @public
+     * @param {Array.<og.Entity>} entities - Entities array.
+     * @returns {og.EntityCollection} -
+     */
+    public addEntities(entities: Array<any>): any;
+    /**
+     * Returns true if the entity belongs this collection, otherwise returns false.
+     * @public
+     * @param {og.Entity} entity - Entity.
+     * @returns {boolean} -
+     */
+    public belongs(entity: any): boolean;
+    _removeRecursively(entity: any): void;
+    /**
+     * Removes entity from this collection.
+     * @public
+     * @param {og.Entity} entity - Entity to remove.
+     */
+    public removeEntity(entity: any): 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 {og.scene.RenderNode} renderNode - Render node.
+     * @param {boolean} [isHidden] - Uses in vector layers that render in planet render specific function.
+     * @returns {og.EntityCollection} -
+     */
+    public addTo(renderNode: any, isHidden?: boolean): any;
+    /**
+     * This function is called in the RenderNode assign function.
+     * @param {og.RenderNode} renderNode
+     */
+    bindRenderNode(renderNode: any): void;
+    /**
+     * Updates coordiantes all lonLat entities in collection after collecction attached to the planet node.
+     * @private
+     * @param {og.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.<og.Entity>} -
+     */
+    public getEntities(): Array<any>;
+    /**
+     * 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 {og.Entity} entity - Entity to clear.
+     */
+    private _clearEntity;
+}

package/types/entity/Geometry.d.ts

@@ -0,0 +1,72 @@
+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 {og.LonLat[]} outCoordinates - Geometry feature coordinates clone.
+     @returns {og.Extent} -
+     */
+    static getExtent(geometryObj: any, outCoordinates: any[]): any;
+    constructor(options: any);
+    _id: number;
+    /**
+     * Entity instance that holds this geometry.
+     * @protected
+     * @type {og.Entity}
+     */
+    protected _entity: any;
+    _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: any;
+    _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(): any;
+    getType(): any;
+}
+export namespace GeometryType {
+    const POINT: number;
+    const LINESTRING: number;
+    const POLYGON: number;
+    const MULTIPOLYGON: number;
+    const MULTILINESTRING: number;
+}

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 {og.Geometry} geometry - Geometry object.
+     */
+    public add(geometry: any): 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;
+}

package/types/entity/Label.d.ts

@@ -0,0 +1,194 @@
+/**
+ * Billboard text label.
+ * @class
+ * @extends {og.BaseBillboard}
+ * @param {Object} [options] - Label options:
+ * @param {og.Vec3|Array.<number>} [options.position] - Billboard spatial position.
+ * @param {number} [options.rotation] - Screen angle rotaion.
+ * @param {og.Vec4|string|Array.<number>} [options.color] - Billboard color.
+ * @param {og.Vec3|Array.<number>} [options.alignedAxis] - Billboard aligned vector.
+ * @param {og.Vec3|Array.<number>} [options.offset] - Billboard center screen offset.
+ * @param {boolean} [options.visibility] - Visibility.
+ * @param {string} [options.text] - Text string.
+ * @param {string} [options.face] - HTML5 font face.
+ * @param {number} [options.size] - Font size in pixels.
+ * @param {string} [options.style] - HTML5 font style. Example 'normal', 'italic'.
+ * @param {string} [options.weight] - HTML5 font weight. Example 'normal', 'bold'.
+ * @param {number} [options.outline] - Text outline size. 0 - no outline, 1 - maximum outline. Default 0.58.
+ * @param {og.Vec4|string|Array.<number>} [options.outlineColor] - Outline color.
+ * @param {og.Label.ALIGN} [options.align] - Text horizontal align: "left", "right" and "center".
+ */
+export class Label {
+    constructor(options: any);
+    /**
+     * Label text string.
+     * @private
+     * @type {string}
+     */
+    private _text;
+    /**
+     * HTML5 font face.
+     * @private
+     * @type {string}
+     */
+    private _face;
+    /**
+     * Font size in pixels.
+     * @private
+     * @type {number}
+     */
+    private _size;
+    /**
+     * Label outline.
+     * @private
+     * @type {number}
+     */
+    private _outline;
+    /**
+     * Label outline color.
+     * @private
+     * @type {og.Vec4}
+     */
+    private _outlineColor;
+    /**
+     * Text horizontal align: "left", "right" and "center".
+     * @private
+     * @type {og.Label.ALIGN}
+     */
+    private _align;
+    /**
+     * Label font atlas index.
+     * @private
+     * @type {number}
+     */
+    private _fontIndex;
+    /**
+     * Font atlas pointer.
+     * @private
+     * @type {og.utils.FontAtlas}
+     */
+    private _fontAtlas;
+    /**
+     * Sets lablel text.
+     * @public
+     * @param {string} text - Text string.
+     * It can't be bigger than maximum labelHandler _maxLetters value.
+     */
+    public setText(text: string): void;
+    /**
+     * Gets current text string.
+     * @public
+     * @returns {string}
+     */
+    public getText(): string;
+    /**
+     * Sets label text align. Could be center, left or right. Left is default.
+     * @public
+     * @param {og.Label.ALIGN} align - Text align.
+     */
+    public setAlign(align: any): void;
+    /**
+     * Gets label text current alignment.
+     * @public
+     * @returns {og.Label.ALIGN}
+     */
+    public getAlign(): any;
+    /**
+     * Sets font face family.
+     * @public
+     * @param {string} face - Font face family.
+     */
+    public setFace(face: string): void;
+    /**
+     * Gets current font face.
+     * @public
+     * @returns {string}
+     */
+    public getFace(): string;
+    /**
+     * Sets label font size in pixels.
+     * @public
+     * @param {number} size - Label size in pixels.
+     */
+    public setSize(size: number): void;
+    /**
+     * Gets label size in pixels.
+     * @public
+     * @returns {number}
+     */
+    public getSize(): number;
+    /**
+     * Sets text outline border size. Where 0 - is no outline and 1 - is the maximum outline size.
+     * @public
+     * @param {number} outline - Text outline size.
+     */
+    public setOutline(outline: number): void;
+    /**
+     * Gets text current outline size.
+     * @public
+     * @returns {number}
+     */
+    public getOutline(): number;
+    /**
+     * Sets label opacity.
+     * @public
+     * @param {number} a - Label opacity.
+     */
+    public setOpacity(a: number): void;
+    /**
+     * Sets text outline color.
+     * @public
+     * @param {number} r - Red.
+     * @param {number} g - Green.
+     * @param {number} b - Blue.
+     * @param {number} a - Alpha.
+     */
+    public setOutlineColor(r: number, g: number, b: number, a: number): void;
+    /**
+     * Sets text outline color.
+     * @public
+     * @param {og.Vec4} rgba - Color vector.
+     */
+    public setOutlineColor4v(rgba: any): void;
+    /**
+     * Sets text outline color HTML string.
+     * @public
+     * @param {string} color - HTML string color.
+     */
+    public setOutlineColorHTML(color: string): void;
+    /**
+     * Gets outline color vector.
+     * @public
+     * @returns {og.Vec4}
+     */
+    public getOutlineColor(): any;
+    /**
+     * Sets outline opacity. Actually outline color alpha value.
+     * @public
+     * @param {number} opacity - Outline opacity.
+     */
+    public setOutlineOpacity(opacity: number): void;
+    /**
+     * Gets outline opacity value.
+     * @public
+     * @returns {number}
+     */
+    public getOutlineOpacity(): number;
+    /**
+     * Updates label parameters.
+     * @public
+     */
+    public update(): void;
+    _applyFontIndex(fontIndex: any): void;
+    /**
+     * Assigns font atlas and update.
+     * @public
+     * @param {og.utils.FontAtlas} fontAtlas - Font atlas.
+     */
+    public assignFontAtlas(fontAtlas: any): void;
+}
+export namespace ALIGN {
+    const RIGHT: number;
+    const LEFT: number;
+    const CENTER: number;
+}

package/types/entity/LabelHandler.d.ts

@@ -0,0 +1,24 @@
+export class LabelHandler extends BillboardHandler {
+    constructor(entityCollection: any, maxLetters?: number);
+    _gliphParamBuffer: any;
+    _fontIndexBuffer: any;
+    _noOutlineBuffer: any;
+    _outlineBuffer: any;
+    _outlineColorBuffer: any;
+    _gliphParamArr: Float32Array;
+    _fontIndexArr: Float32Array;
+    _noOutlineArr: Float32Array;
+    _outlineArr: Float32Array;
+    _outlineColorArr: Float32Array;
+    _maxLetters: number;
+    assignFontAtlas(label: any): void;
+    setText(index: any, text: any, fontIndex: any, align: any): void;
+    setOutlineColorArr(index: any, rgba: any): void;
+    setOutlineArr(index: any, outline: any): void;
+    setFontIndexArr(index: any, fontIndex: any): void;
+    createFontIndexBuffer(): void;
+    createOutlineBuffer(): void;
+    createOutlineColorBuffer(): void;
+    setMaxLetters(c: any): void;
+}
+import { BillboardHandler } from "./BillboardHandler.js";