@openglobus/og 0.11.8 → 0.12.4

package/types/entity/PointCloud.d.ts

@@ -0,0 +1,174 @@
+/**
+ * PointCloud object.
+ * @class
+ * @param {*} [options] - Point cloud options:
+ * @param {Array.<Array.<number>>} [options.points] - Points cartesian coordinates array,
+ * where first three is cartesian coordinates, next fourth is a RGBA color, and last is an point properties.
+ * @param {number} [options.pointSize] - Point screen size in pixels.
+ * @param {number} [options.pickingDistance] - Point border picking size in screen pixels.
+ * @param {boolean} [options.visibility] - Point cloud visibility.
+ * @example <caption>Creates point cloud with two ten pixel size points</caption>
+ * new og.Entity({
+ *     pointCloud: {
+ *         pointSize: 10,
+ *         points: [
+ *             [0, 0, 0, 255, 255, 255, 255, { 'name': 'White point' }],
+ *             [100, 100, 0, 255, 0, 0, 255, { 'name': 'Red point' }]
+ *         ]
+ *     }
+ * });
+ */
+export class PointCloud {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(options: any);
+    /**
+     * Object unic identifier.
+     * @public
+     * @readonly
+     * @type {number}
+     */
+    public readonly id: number;
+    /**
+     * Cloud visibility.
+     * @public
+     * @type {boolean}
+     */
+    public visibility: boolean;
+    /**
+     * Point screen size in pixels.
+     * @public
+     * @type {number}
+     */
+    public pointSize: number;
+    /**
+     * Point picking border size in pixels.
+     * @public
+     * @type {number}
+     */
+    public pickingDistance: number;
+    /**
+     * Parent collection render node.
+     * @private
+     * @type {RenderNode}
+     */
+    private _renderNode;
+    /**
+     * Entity instance that holds this point cloud.
+     * @private
+     * @type {Entity}
+     */
+    private _entity;
+    /**
+     * Points properties.
+     * @private
+     * @type {Array.<*>}
+     */
+    private _points;
+    /**
+     * Coordinates array.
+     * @private
+     * @type {Array.<number>}
+     */
+    private _coordinatesData;
+    /**
+     * Color array.
+     * @private
+     * @type {Array.<number>}
+     */
+    private _colorData;
+    /**
+     * Picking color array.
+     * @private
+     * @type {Array.<number>}
+     */
+    private _pickingColorData;
+    _coordinatesBuffer: any;
+    _colorBuffer: any;
+    _pickingColorBuffer: any;
+    /**
+     * Handler that stores and renders this object.
+     * @private
+     * @type {PointCloudHandler}
+     */
+    private _handler;
+    _handlerIndex: number;
+    _buffersUpdateCallbacks: (() => void)[];
+    _changedBuffers: any[];
+    /**
+     * Clears point cloud data
+     * @public
+     */
+    public clear(): void;
+    /**
+     * Set point cloud opacity.
+     * @public
+     * @param {number} opacity - Cloud opacity.
+     */
+    public setOpacity(opacity: number): void;
+    opacity: number;
+    /**
+     * Sets cloud visibility.
+     * @public
+     * @param {number} visibility - Visibility flag.
+     */
+    public setVisibility(visibility: number): void;
+    /**
+     * @return {boolean} Point cloud visibily.
+     */
+    getVisibility(): boolean;
+    /**
+     * Assign rendering scene node.
+     * @public
+     * @param {RenderNode}  renderNode - Assigned render node.
+     */
+    public setRenderNode(renderNode: RenderNode): void;
+    /**
+     * Removes from entity.
+     * @public
+     */
+    public remove(): void;
+    /**
+     * Adds points to render.
+     * @public
+     * @param {Array.<Array<number>>} points - Point cloud array.
+     * @example
+     * var points = [[0, 0, 0, 255, 255, 255, 255, { 'name': 'White point' }], [100, 100, 0, 255, 0, 0, 255, { 'name': 'Red point' }]];
+     */
+    public setPoints(points: Array<Array<number>>): void;
+    setPointPosition(index: any, x: any, y: any, z: any): void;
+    setPointColor(index: any, r: any, g: any, b: any, a: any): void;
+    addPoints(points: any): void;
+    addPoint(index: any, point: any): void;
+    /**
+     * Returns specific point by index.
+     * @public
+     * @param {number} index - Point index.
+     * @return {*} Specific point
+     */
+    public getPoint(index: number): any;
+    removePoint(index: any): void;
+    insertPoint(index: any, point: any): void;
+    /**
+     * Each point iterator.
+     * @public
+     * @param {callback} callback -
+     */
+    public each(callback: any): void;
+    draw(): void;
+    drawPicking(): void;
+    /**
+     * Update gl buffers.
+     * @private
+     */
+    private _update;
+    /**
+     * Delete buffers
+     * @private
+     */
+    private _deleteBuffers;
+    _createCoordinatesBuffer(): void;
+    _createColorBuffer(): void;
+    _createPickingColorBuffer(): void;
+    _setPickingColors(): void;
+}

package/types/entity/PointCloudHandler.d.ts

@@ -0,0 +1,38 @@
+export class PointCloudHandler {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(entityCollection: any);
+    /**
+     * Picking rendering option.
+     * @public
+     * @type {boolean}
+     */
+    public pickingEnabled: boolean;
+    /**
+     * Parent collection
+     * @private
+     * @type {EntityCollection}
+     */
+    private _entityCollection;
+    /**
+     * Renderer
+     * @private
+     * @type {Renderer}
+     */
+    private _renderer;
+    /**
+     * Point cloud array
+     * @private
+     * @type {Array.<PointCloud>}
+     */
+    private _pointClouds;
+    __staticId: number;
+    _initProgram(): void;
+    setRenderNode(renderNode: any): void;
+    add(pointCloud: any): void;
+    remove(pointCloud: any): void;
+    reindexPointCloudArray(startIndex: any): void;
+    draw(): void;
+    drawPicking(): void;
+    clear(): void;
+}

package/types/entity/Polyline.d.ts

@@ -0,0 +1,306 @@
+/**
+ * Polyline object.
+ * @class
+ * @param {Object} [options] - Polyline options:
+ * @param {number} [options.thickness] - Thickness in screen pixels 1.5 is default.
+ * @param {Number} [options.altitude] - Relative to ground layers altitude value.
+ * @param {Vec4} [options.color] - RGBA color.
+ * @param {Boolean} [options.opacity] - Line opacity.
+ * @param {Boolean} [options.visibility] - Polyline visibility. True default.
+ * @param {Boolean} [options.isClosed] - Closed geometry type identificator.
+ * @param {Array.<Array.<number>>} [options.pathLonLat] - Polyline geodetic coordinates array. [[0,0,0], [1,1,1],...]
+ * @param {Array.<Array.<number>>} [options.path3v] - LinesString cartesian coordinates array. [[0,0,0], [1,1,1],...]
+ * @param {Array.<Array.<number>>} [options.pathColors] - Coordinates color. [[1,0,0,1], [0,1,0,1],...] for right and green colors.
+ */
+export class Polyline {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    /**
+     * Appends to the line array new cartesian coordinates line data.
+     * @param {Array.<Array.<number>>} path3v - Line coordinates path array. [[0,0,0], [1,1,1],...]
+     * @param {Boolean} isClosed - Identificator for the closed line data creation.
+     * @param {Number[]} outVertices - Out vertices data array.
+     * @param {Number[]} outOrders - Out vertices orders data array.
+     * @param {Number[]} outIndexes - Out vertices indexes data array.
+     * @param {Ellipsoid} [ellipsoid] - Ellipsoid to coordinates transformation.
+     * @param {Array.<Array.<LonLat>>} [outTransformedPathLonLat] - Geodetic coordinates out array.
+     * @param {Array.<Array.<LonLat>>} [outPath3v] - Cartesian coordinates out array.
+     * @param {Array.<Array.<LonLat>>} [outTransformedPathMerc] - Mercator coordinates out array.
+     * @param {Extent} [outExtent] - Geodetic line extent.
+     * @param {Array} [outColors]
+     * @static
+     */
+    static appendLineData3v(path3v: Array<Array<number>>, pathColors: any, defaultColor: any, isClosed: boolean, outVerticesHigh: any, outVerticesLow: any, outOrders: number[], outIndexes: number[], ellipsoid?: Ellipsoid, outTransformedPathLonLat?: Array<Array<LonLat>>, outPath3v?: Array<Array<LonLat>>, outTransformedPathMerc?: Array<Array<LonLat>>, outExtent?: Extent, outColors?: any[]): void;
+    /**
+     * Appends to the line new cartesian coordinates point data.
+     * @param {Array.<Array.<number>>} path3v - Line coordinates path array. [[0,0,0], [1,1,1],...]
+     * @param {Boolean} isClosed - Identificator for the closed line data creation.
+     * @param {Number[]} outVertices - Out vertices data array.
+     * @param {Number[]} outOrders - Out vertices orders data array.
+     * @param {Number[]} outIndexes - Out vertices indexes data array.
+     * @param {Ellipsoid} [ellipsoid] - Ellipsoid to coordinates transformation.
+     * @param {Array.<Array.<LonLat>>} [outTransformedPathLonLat] - Geodetic coordinates out array.
+     * @param {Array.<Array.<LonLat>>} [outPath3v] - Cartesian coordinates out array.
+     * @param {Array.<Array.<LonLat>>} [outTransformedPathMerc] - Mercator coordinates out array.
+     * @param {Extent} [outExtent] - Geodetic line extent.
+     * @static
+     */
+    static appendPoint3v(path3v: Array<Array<number>>, point3v: any, pathColors: any, color: any, isClosed: boolean, outVerticesHigh: any, outVerticesLow: any, outColors: any, outOrders: number[], outIndexes: number[], ellipsoid?: Ellipsoid, outTransformedPathLonLat?: Array<Array<LonLat>>, outTransformedPathMerc?: Array<Array<LonLat>>, outExtent?: Extent): void;
+    /**
+     * Appends to the line array new geodetic coordinates line data.
+     * @param {Array.<Array.<number>>} pathLonLat - Line geodetic coordinates path array. [[0,0,0], [1,1,1],...]
+     * @param {Boolean} isClosed - Identificator for the closed line data creation.
+     * @param {Number[]} outVertices - Out vertices data array.
+     * @param {Number[]} outOrders - Out vertices orders data array.
+     * @param {Number[]} outIndexes - Out indexes data array.
+     * @param {Ellipsoid} ellipsoid - Ellipsoid to coordinates transformation.
+     * @param {Array.<Array.<number>>} outTransformedPathCartesian - Cartesian coordinates out array. [[0,0,0], [1,1,1],...]
+     * @param {Array.<Array.<LonLat>>} outPathLonLat - Geographic coordinates out array.
+     * @param {Array.<Array.<LonLat>>} outTransformedPathMerc - Mercator coordinates out array.
+     * @param {Extent} outExtent - Geodetic line extent.
+     * @static
+     */
+    static appendLineDataLonLat(pathLonLat: Array<Array<number>>, pathColors: any, defaultColor: any, isClosed: boolean, outVerticesHigh: any, outVerticesLow: any, outOrders: number[], outIndexes: number[], ellipsoid: Ellipsoid, outTransformedPathCartesian: Array<Array<number>>, outPathLonLat: Array<Array<LonLat>>, outTransformedPathMerc: Array<Array<LonLat>>, outExtent: Extent, outColors: any): void;
+    constructor(options: any);
+    /**
+     * Object unic identifier.
+     * @public
+     * @readonly
+     * @type {number}
+     */
+    public readonly id: number;
+    altitude: any;
+    /**
+     * Polyline thickness in screen pixels.
+     * @public
+     * @type {number}
+     */
+    public thickness: number;
+    /**
+     * Polyline RGBA color.
+     * @public
+     * @type {Array<number>} - (exactly 4 entries)
+     */
+    public _defaultColor: Array<number>;
+    /**
+     * Polyline visibility.
+     * @public
+     * @type {boolean}
+     */
+    public visibility: boolean;
+    /**
+     * Polyline geometry ring type identificator.
+     * @protected
+     * @type {Boolean}
+     */
+    protected _closedLine: boolean;
+    /**
+     * Polyline cartesian coordinates.
+     * @private
+     * @type {Array.<Vec3>}
+     */
+    private _path3v;
+    _pathLengths: any[];
+    /**
+     * Polyline geodetic degrees coordiantes.
+     * @private
+     * @type {Array.<LonLat>}
+     */
+    private _pathLonLat;
+    /**
+     * Polyline geodetic mercator coordinates.
+     * @private
+     * @type {Array.<LonLat>}
+     */
+    private _pathLonLatMerc;
+    _pathColors: any;
+    /**
+     * Polyline geodetic extent.
+     * @protected
+     * @type {Extent}
+     */
+    protected _extent: Extent;
+    _verticesHigh: any[];
+    _verticesLow: any[];
+    _orders: any[];
+    _indexes: any[];
+    _colors: any[];
+    _verticesHighBuffer: any;
+    _verticesLowBuffer: any;
+    _ordersBuffer: any;
+    _indexesBuffer: any;
+    _colorsBuffer: any;
+    _pickingColor: number[];
+    _renderNode: any;
+    /**
+     * Entity instance that holds this Polyline.
+     * @private
+     * @type {Entity}
+     */
+    private _entity;
+    /**
+     * Handler that stores and renders this Polyline object.
+     * @private
+     * @type {PolylineHandler}
+     */
+    private _handler;
+    _handlerIndex: number;
+    _buffersUpdateCallbacks: (() => void)[];
+    _changedBuffers: any[];
+    /**
+     * Sets polyline path with cartesian coordinates.
+     * @protected
+     * @param {pg.math.Vector3[]} path3v - Cartesian coordinates.
+     */
+    protected _setEqualPath3v(path3v: pg.math.Vector3[]): void;
+    /**
+     * Sets polyline with geodetic coordinates.
+     * @protected
+     * @param {LonLat[]} pathLonLat - Geodetic polyline path coordinates.
+     */
+    protected _setEqualPathLonLat(pathLonLat: LonLat[]): void;
+    setPointLonLat(lonlat: any, index: any, segmentIndex: any): void;
+    setPoint3v(coordinates: any, index: any, segmentIndex: any, skipLonLat: any): void;
+    _resizePathLengths(index?: number): void;
+    removeSegment(index: any): void;
+    removePoint(index: any, multiLineIndex?: number): void;
+    insertPoint3v(point3v: any, index: number, color: any, multilineIndex?: number): void;
+    /**
+     * Adds a new cartesian point in the end of the path in a last line segment.
+     * @public
+     * @param {Vec3} point3v - New coordinate.
+     */
+    public appendPoint3v(point3v: Vec3, color: any, skipEllipsoid: any): void;
+    /**
+     * Adds a new cartesian point in the end of the path.
+     * @public
+     * @param {Vec3} point3v - New coordinate.
+     * @param {number} [multiLineIndex=0] - Path part index, first by default.
+     */
+    public addPoint3v(point3v: Vec3, multiLineIndex?: number): void;
+    /**
+     * Adds a new geodetic point in the end of the path.
+     * @public
+     * @param {LonLat} lonLat - New coordinate.
+     * @param {number} [multiLineIndex=0] - Path part index, first by default.
+     */
+    public addPointLonLat(lonLat: LonLat, multiLineIndex?: number): void;
+    /**
+     * Clear Polyline object data.
+     * @public
+     */
+    public clear(): void;
+    setPointColor(color: any, index?: number, segmentIndex?: number): void;
+    /**
+     * Sets Polyline opacity.
+     * @public
+     * @param {number} opacity - Opacity.
+     */
+    public setOpacity(opacity: number): void;
+    /**
+     * Sets Polyline thickness in screen pixels.
+     * @public
+     * @param {number} thickness - Thickness.
+     */
+    public setThickness(thickness: number): void;
+    /**
+     * Returns thickness.
+     * @public
+     * @return {number} Thickness in screen pixels.
+     */
+    public getThickness(): number;
+    /**
+     * Sets visibility.
+     * @public
+     * @param {boolean} visibility - Polyline visibility.
+     */
+    public setVisibility(visibility: boolean): void;
+    /**
+     * Gets Polyline visibility.
+     * @public
+     * @return {boolean} Polyline visibility.
+     */
+    public getVisibility(): boolean;
+    /**
+     * Assign with render node.
+     * @public
+     * @param {RenderNode} renderNode -
+     */
+    public setRenderNode(renderNode: RenderNode): void;
+    /**
+     * @protected
+     */
+    protected _clearData(): void;
+    _createData3v(path3v: any): void;
+    _createDataLonLat(pathLonlat: any): void;
+    /**
+     * Removes from an entity.
+     * @public
+     */
+    public remove(): void;
+    setPickingColor3v(color: any): void;
+    /**
+     * Returns polyline geodetic extent.
+     * @public
+     * @returns {Extent} - Geodetic extent
+     */
+    public getExtent(): Extent;
+    /**
+     * Returns path cartesian coordinates.
+     * @return {Array.<Vec3>} Polyline path.
+     */
+    getPath3v(): Array<Vec3>;
+    /**
+     * Returns geodetic path coordinates.
+     * @return {Array.<LonLat>} Polyline path.
+     */
+    getPathLonLat(): Array<LonLat>;
+    getPathColors(): any;
+    setPathColors(pathColors: any): void;
+    setColorHTML(htmlColor: any): void;
+    /**
+     * Sets geodetic coordinates.
+     * @public
+     * @param {Array.<Array.<number>>} pathLonLat - Polyline path cartesian coordinates. (exactly 3 entries)
+     * @param {Boolean} [forceEqual=false] - Makes assigning faster for size equal coordinates array.
+     */
+    public setPathLonLat(pathLonLat: Array<Array<number>>, forceEqual?: boolean): void;
+    /**
+     * Sets Polyline cartesian coordinates.
+     * @public
+     * @param {Array.<Array.<number>>} path3v - Polyline path cartesian coordinates. (exactly 3 entries)
+     * @param {Boolean} [forceEqual=false] - Makes assigning faster for size equal coordinates array.
+     */
+    public setPath3v(path3v: Array<Array<number>>, pathColors: any, forceEqual?: boolean): void;
+    draw(): void;
+    drawPicking(): void;
+    /**
+     * Refresh buffers.
+     * @protected
+     */
+    protected _refresh(): void;
+    /**
+     * Updates render buffers.
+     * @protected
+     */
+    protected _update(): void;
+    /**
+     * Clear GL buffers.
+     * @protected
+     */
+    protected _deleteBuffers(): void;
+    /**
+     * Creates gl main data buffer.
+     * @protected
+     */
+    protected _createVerticesBuffer(): void;
+    /**
+     * Creates gl index and order buffer.
+     * @protected
+     */
+    protected _createIndexBuffer(): void;
+    _createColorsBuffer(): void;
+}
+import { Extent } from "../Extent.js";
+import { LonLat } from "../LonLat.js";
+import { Vec3 } from "../math/Vec3.js";

package/types/entity/PolylineHandler.d.ts

@@ -0,0 +1,18 @@
+export class PolylineHandler {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(entityCollection: any);
+    _entityCollection: any;
+    _renderer: any;
+    _polylines: any[];
+    __staticId: number;
+    pickingEnabled: boolean;
+    _initProgram(): void;
+    setRenderNode(renderNode: any): void;
+    add(polyline: any): void;
+    remove(polyline: any): void;
+    reindexPolylineArray(startIndex: any): void;
+    draw(): void;
+    drawPicking(): void;
+    clear(): void;
+}

package/types/entity/Ray.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Ray class.
+ * @class
+ * @param {Object} [options] - Options:
+ * @param {Vec3|Array.<number>} [options.startPosition] - Ray start point position.
+ * @param {Vec3|Array.<number>} [options.endPosition] - Ray end point position.
+ * @param {Vec3|Array.<number>} [options.startColor] - Ray start point color.
+ * @param {Vec3|Array.<number>} [options.endColor] - Ray end point color.
+ * @param {boolean} [options.visibility] - Visibility.
+ */
+export class Ray {
+    constructor(options: any);
+    /**
+     * Object unic identifier.
+     * @public
+     * @readonly
+     * @type {number}
+     */
+    public readonly id: number;
+    _thickness: any;
+    _length: any;
+    _lengthHighLow: Float32Array;
+    _startPosition: any;
+    _startPositionHigh: Vec3;
+    _startPositionLow: Vec3;
+    _endPosition: any;
+    _endPositionHigh: Vec3;
+    _endPositionLow: Vec3;
+    _startColor: any;
+    _endColor: any;
+    /**
+     * Ray visibility.
+     * @protected
+     * @type {boolean}
+     */
+    protected _visibility: boolean;
+    /**
+     * Entity instance that holds this billboard.
+     * @protected
+     * @type {Entity}
+     */
+    protected _entity: Entity;
+    /**
+     * Handler that stores and renders this billboard object.
+     * @protected
+     * @type {BillboardHandler}
+     */
+    protected _handler: BillboardHandler;
+    /**
+     * Billboard handler array index.
+     * @protected
+     * @type {number}
+     */
+    protected _handlerIndex: number;
+    /**
+     * Sets ray start position.
+     * @public
+     * @param {number} x - X coordinate.
+     * @param {number} y - Y coordinate.
+     * @param {number} z - Z coordinate.
+     */
+    public setStartPosition(x: number, y: number, z: number): void;
+    /**
+     * Sets ray start position.
+     * @public
+     * @param {Vec3} position - Cartesian coordinates.
+     */
+    public setStartPosition3v(position: Vec3): void;
+    /**
+     * Sets ray end position.
+     * @public
+     * @param {number} x - X coordinate.
+     * @param {number} y - Y coordinate.
+     * @param {number} z - Z coordinate.
+     */
+    public setEndPosition(x: number, y: number, z: number): void;
+    /**
+     * Sets ray end position.
+     * @public
+     * @param {Vec3} position - Cartesian coordinates.
+     */
+    public setEndPosition3v(position: Vec3): void;
+    setLength(length: any): void;
+    setThickness(thickness: any): void;
+    setColors4v(startColor: any, endColor: any): void;
+    setColorsHTML(startColor: any, endColor: any): void;
+    /**
+     * Returns ray start position.
+     * @public
+     * @returns {Vec3}
+     */
+    public getStartPosition(): Vec3;
+    /**
+     * Returns ray end position.
+     * @public
+     * @returns {Vec3}
+     */
+    public getEndPosition(): Vec3;
+    /**
+     * Sets billboard visibility.
+     * @public
+     * @param {boolean} visibility - Visibility flag.
+     */
+    public setVisibility(visibility: boolean): void;
+    /**
+     * Returns billboard visibility.
+     * @public
+     * @returns {boolean}
+     */
+    public getVisibility(): boolean;
+    /**
+     * Removes billboard from hander.
+     * @public
+     */
+    public remove(): void;
+    /**
+     * Sets billboard picking color.
+     * @public
+     * @param {Vec3} color - Picking color.
+     */
+    public setPickingColor3v(color: Vec3): void;
+}
+import { Vec3 } from "../math/Vec3.js";
+import { Entity } from "./Entity.js";