@openglobus/og 0.19.4 → 0.20.0

package/lib/@openglobus/js/ellipsoid/Ellipsoid.d.ts

@@ -0,0 +1,193 @@
+import { LonLat } from "../LonLat";
+import { Quat } from "../math/Quat";
+import { Vec3 } from "../math/Vec3";
+export interface IInverseResult {
+    distance: number;
+    initialAzimuth: number;
+    finalAzimuth: number;
+}
+export interface IDirectResult {
+    destination: LonLat;
+    finalAzimuth: number;
+}
+/**
+ * Class represents a plant ellipsoid.
+ * @class
+ * @param {number} equatorialSize - Equatorial ellipsoid size.
+ * @param {number} polarSize - Polar ellipsoid size.
+ */
+declare class Ellipsoid {
+    /**
+     * Equatorial size
+     * @type {number}
+     * @protected
+     */
+    protected _a: number;
+    /**
+     * Polar size
+     * @type {number}
+     * @protected
+     */
+    protected _b: number;
+    protected _flattening: number;
+    protected _f: number;
+    protected _a2: number;
+    protected _b2: number;
+    protected _e: number;
+    protected _e2: number;
+    protected _e22: number;
+    protected _k: number;
+    protected _k2: number;
+    protected _radii: Vec3;
+    protected _radii2: Vec3;
+    protected _invRadii: Vec3;
+    _invRadii2: Vec3;
+    constructor(equatorialSize?: number, polarSize?: number);
+    /**
+     * Returns the distance travelling from ‘this’ point to destination point along a rhumb line.
+     * @param   {LonLat} startLonLat coordinates.
+     * @param   {LonLat} endLonLat coordinates
+     * @returns {number} Distance in m between this point and destination point (same units as radius).
+     */
+    rhumbDistanceTo(startLonLat: LonLat, endLonLat: LonLat): number;
+    /**
+     * Returns the point at given fraction between two points on the great circle.
+     * @param   {LonLat} lonLat1 - Longitude/Latitude of source point.
+     * @param   {LonLat} lonLat2 - Longitude/Latitude of destination point.
+     * @param   {number} fraction - Fraction between the two points (0 = source point, 1 = destination point).
+     * @returns {LonLat} Intermediate point between points.
+     */
+    getIntermediatePointOnGreatCircle(lonLat1: LonLat, lonLat2: LonLat, fraction: number): LonLat;
+    /**
+     * REMOVE ASAP after
+     * @param lonLat1
+     * @param lonLat2
+     * @returns {number}
+     */
+    static getBearing(lonLat1: LonLat, lonLat2: LonLat): number;
+    getFlattening(): number;
+    /**
+     * Gets ellipsoid equatorial size.
+     * @public
+     * @returns {number} -
+     */
+    getEquatorialSize(): number;
+    get equatorialSize(): number;
+    get equatorialSizeSqr(): number;
+    /**
+     * Gets ellipsoid polar size.
+     * @public
+     * @returns {number} -
+     */
+    getPolarSize(): number;
+    get polarSize(): number;
+    get polarSizeSqr(): number;
+    /**
+     * Calculate cartesian coordinates by its ECEF geodetic coordinates.
+     * @public
+     * @param {LonLat} lonlat - Geodetic coordinates.
+     * @returns {Vec3} -
+     */
+    lonLatToCartesian(lonlat: LonLat): Vec3;
+    /**
+     * Calculate cartesian coordinates by its ECEF geodetic coordinates.
+     * @public
+     * @param {LonLat} lonlat - Geodetic coordinates.
+     * @param {Vec3} res - Output variable reference.
+     * @returns {Vec3} -
+     */
+    lonLatToCartesianRes(lonlat: LonLat, res: Vec3): Vec3;
+    /**
+     * Gets cartesian ECEF from Wgs84 geodetic coordinates.
+     * @public
+     * @param {Number} lon - Longitude.
+     * @param {Number} lat - Latitude.
+     * @param {Number} height - Height.
+     * @param {Vec3} res - Output result variable.
+     * @returns {Vec3} -
+     */
+    geodeticToCartesian(lon: number, lat: number, height?: number, res?: Vec3): Vec3;
+    /**
+     * Gets Wgs84 geodetic coordinates from cartesian ECEF.
+     * @public
+     * @param {Vec3} p - Cartesian coordinates.
+     * @returns {LonLat} -
+     */
+    projToSurface(p: Vec3): Vec3;
+    /**
+     * Converts 3d cartesian coordinates to geodetic
+     * @param {Vec3} cart - Cartesian coordinates
+     * @returns {LonLat} - Geodetic coordinates
+     */
+    cartesianToLonLat(cart: Vec3): LonLat;
+    /**
+     * Converts 3d cartesian coordinates to geodetic
+     * @param {Vec3} cart - Cartesian coordinates
+     * @param {LonLat} res - Link geodetic coordinates variable
+     * @returns {LonLat} - Geodetic coordinates
+     */
+    cartesianToLonLatRes(cart: Vec3, res?: LonLat): LonLat;
+    /**
+     * Gets ellipsoid surface normal.
+     * @public
+     * @param {Vec3} coord - Spatial coordinates.
+     * @return {Vec3} -
+     */
+    getSurfaceNormal3v(coord: Vec3): Vec3;
+    getGreatCircleDistance(lonLat1: LonLat, lonLat2: LonLat): number;
+    /**
+     * Calculates the destination point given start point lat / lon, azimuth(deg) and distance (m).
+     * Source: http://movable-type.co.uk/scripts/latlong-vincenty-direct.html and optimized / cleaned up by Mathias Bynens <http://mathiasbynens.be/>
+     * Based on the Vincenty direct formula by T. Vincenty, “Direct and Inverse Solutions of Geodesics on the Ellipsoid with application of nested equations”, Survey Review, vol XXII no 176, 1975 <http://www.ngs.noaa.gov/PUBS_LIB/inverse.pdf>
+     * @param {LonLat} lonLat - Origin coordinates
+     * @param {number} azimuth - View azimuth in degrees
+     * @param {number} dist - Distance to the destination point coordinates in meters
+     * @returns {LonLat} - Destination point coordinates
+     */
+    getGreatCircleDestination(lonLat: LonLat, azimuth: number, dist: number): LonLat;
+    /**
+     * Returns inverse Geodesic solution for two points
+     * @param {LonLat} lonLat1 - start coordinates point
+     * @param {LonLat} lonLat2 - end coordinates point
+     * @returns {IInverseResult} - Contains distance, initialAzimuth, and finalAzimuth values
+     */
+    inverse(lonLat1: LonLat, lonLat2: LonLat): IInverseResult;
+    /**
+     * Calculates the destination point given start point lat / lon, azimuth(deg) and distance (m).
+     * Source: http://movable-type.co.uk/scripts/latlong-vincenty-direct.html and optimized / cleaned up by Mathias Bynens <http://mathiasbynens.be/>
+     * Based on the Vincenty direct formula by T. Vincenty, “Direct and Inverse Solutions of Geodesics on the Ellipsoid with application of nested equations”, Survey Review, vol XXII no 176, 1975 <http://www.ngs.noaa.gov/PUBS_LIB/inverse.pdf>
+     * @param {LonLat} lonLat - Origin coordinates
+     * @param {number} azimuth - View azimuth in degrees
+     * @param {number} dist - Distance to the destination point coordinates in meters
+     * @returns {{ destination: LonLat; finalAzimuth: number }} - Destination point coordinates
+     */
+    direct(lonLat: LonLat, azimuth: number, dist: number): IDirectResult;
+    /**
+     * Returns cartesian coordinates of the intersection of a ray and an ellipsoid.
+     * If the ray doesn't hit ellipsoid returns null.
+     * @public
+     * @param {Vec3} origin - Ray origin point.
+     * @param {Vec3} direction - Ray direction.
+     * @returns {Vec3} -
+     */
+    hitRay(origin: Vec3, direction: Vec3): Vec3 | undefined;
+    getNorthFrameRotation(cartesian: Vec3): Quat;
+    /**
+     * @todo this is not precise function, needs to be replaced or removed
+     * @param lonLat1
+     * @param bearing
+     * @param distance
+     * @returns {LonLat}
+     */
+    getBearingDestination(lonLat1: LonLat, bearing?: number, distance?: number): LonLat;
+    /**
+     * Returns the point at given fraction between two points on the great circle.
+     * @param   {LonLat} lonLat1 - Longitude/Latitude of source point.
+     * @param   {LonLat} lonLat2 - Longitude/Latitude of destination point.
+     * @param   {number} fraction - Fraction between the two points (0 = source point, 1 = destination point).
+     * @returns {LonLat} Intermediate point between points.
+     */
+    static getIntermediatePointOnGreatCircle(lonLat1: LonLat, lonLat2: LonLat, fraction: number): LonLat;
+    static getRhumbBearing(lonLat1: LonLat, lonLat2: LonLat): number;
+}
+export { Ellipsoid };

package/lib/@openglobus/js/ellipsoid/index.d.ts

@@ -0,0 +1,3 @@
+import { Ellipsoid } from './Ellipsoid';
+import { wgs84 } from './wgs84';
+export { Ellipsoid, wgs84 };

package/lib/@openglobus/js/ellipsoid/wgs84.d.ts

@@ -0,0 +1,6 @@
+import { Ellipsoid } from "./Ellipsoid";
+/**
+ * WGS84 ellipsoid object.
+ * @type {Ellipsoid}
+ */
+export declare const wgs84: Ellipsoid;

package/lib/@openglobus/js/entity/BaseBillboard.d.ts

@@ -0,0 +1,222 @@
+import { Entity } from "./Entity";
+import { NumberArray2, Vec2 } from "../math/Vec2";
+import { NumberArray3, Vec3 } from "../math/Vec3";
+import { NumberArray4, Vec4 } from "../math/Vec4";
+import { BaseBillboardHandler } from "./BaseBillboardHandler";
+export interface IBaseBillboardParams {
+    position?: NumberArray3 | Vec3;
+    rotation?: number;
+    color?: string | NumberArray4 | Vec4;
+    alignedAxis?: NumberArray3 | Vec3;
+    offset?: NumberArray2 | NumberArray3 | Vec2 | Vec3;
+    visibility?: boolean;
+}
+/**
+ * Base prototype for billboard and label classes.
+ * @class
+ * @param {Object} [options] - Options:
+ * @param {Vec3|Array.<number>} [options.position] - Billboard position.
+ * @param {number} [options.rotation] - Screen angle rotation.
+ * @param {Vec4|string|Array.<number>} [options.color] - Billboard color.
+ * @param {Vec3|Array.<number>} [options.alignedAxis] - Billboard aligned vector.
+ * @param {Vec3|Array.<number>} [options.offset] - Billboard center screen offset.
+ * @param {boolean} [options.visibility] - Visibility.
+ */
+declare class BaseBillboard {
+    static __counter__: number;
+    __id: number;
+    /**
+     * Billboard center cartesian position.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _position: Vec3;
+    _positionHigh: Vec3;
+    _positionLow: Vec3;
+    /**
+     * Screen space rotation angle.
+     * @public
+     * @type {number}
+     */
+    _rotation: number;
+    /**
+     * RGBA color.
+     * @public
+     * @type {Vec4}
+     */
+    _color: Vec4;
+    /**
+     * Cartesian aligned axis vector.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _alignedAxis: Vec3;
+    /**
+     * Billboard center screen space offset. Where x,y - screen space offset and z - depth offset.
+     * @public
+     * @type {Vec3}
+     */
+    _offset: Vec3;
+    /**
+     * Billboard visibility.
+     * @protected
+     * @type {boolean}
+     */
+    protected _visibility: boolean;
+    /**
+     * Entity instance that holds this billboard.
+     * @public
+     * @type {Entity}
+     */
+    _entity: Entity | null;
+    /**
+     * Handler that stores and renders this billboard object.
+     * @public
+     * @type {BillboardHandler | null}
+     */
+    _handler: BaseBillboardHandler | null;
+    /**
+     * Billboard handler array index.
+     * @public
+     * @type {number}
+     */
+    _handlerIndex: number;
+    /**
+     * An indication that the object is ready to draw
+     * @public
+     * @type {number}
+     */
+    _isReady: boolean;
+    _lockId: number;
+    constructor(options?: IBaseBillboardParams);
+    /**
+     * Sets billboard position.
+     * @public
+     * @param {number} x - X coordinate.
+     * @param {number} y - Y coordinate.
+     * @param {number} z - Z coordinate.
+     */
+    setPosition(x: number, y: number, z: number): void;
+    /**
+     * Sets billboard position.
+     * @public
+     * @param {Vec3} position - Cartesian coordinates.
+     */
+    setPosition3v(position: Vec3): void;
+    /**
+     * Returns billboard position.
+     * @public
+     * @returns {Vec3}
+     */
+    getPosition(): Vec3;
+    /**
+     * Sets screen space offset.
+     * @public
+     * @param {number} x - X offset.
+     * @param {number} y - Y offset.
+     * @param {number} [z] - Z offset.
+     */
+    setOffset(x: number, y: number, z?: number): void;
+    /**
+     * Sets screen space offset.
+     * @public
+     * @param {Vec2} offset - Offset size.
+     */
+    setOffset3v(offset: Vec3): void;
+    /**
+     * Returns billboard screen space offset size.
+     * @public
+     * @returns {Vec3}
+     */
+    getOffset(): Vec3;
+    /**
+     * Sets billboard screen space rotation in radians.
+     * @public
+     * @param {number} rotation - Screen space rotation in radians.
+     */
+    setRotation(rotation: number): void;
+    /**
+     * Gets screen space rotation.
+     * @public
+     * @returns {number}
+     */
+    getRotation(): number;
+    /**
+     * Sets billboard opacity.
+     * @public
+     * @param {number} a - Billboard opacity.
+     */
+    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.
+     */
+    setColor(r: number, g: number, b: number, a?: number): void;
+    /**
+     * Sets RGBA color. Each channel from 0.0 to 1.0.
+     * @public
+     * @param {Vec4} color - RGBA vector.
+     */
+    setColor4v(color: Vec4): void;
+    /**
+     * Sets billboard color.
+     * @public
+     * @param {string} color - HTML style color.
+     */
+    setColorHTML(color: string): void;
+    /**
+     * Returns RGBA color.
+     * @public
+     * @returns {Vec4}
+     */
+    getColor(): Vec4;
+    /**
+     * Sets billboard visibility.
+     * @public
+     * @param {boolean} visibility - Visibility flag.
+     */
+    setVisibility(visibility: boolean): void;
+    /**
+     * Returns billboard visibility.
+     * @public
+     * @returns {boolean}
+     */
+    getVisibility(): boolean;
+    /**
+     * Sets billboard cartesian aligned vector.
+     * @public
+     * @param {number} x - Aligned vector X coordinate.
+     * @param {number} y - Aligned vector Y coordinate.
+     * @param {number} z - Aligned vector Z coordinate.
+     */
+    setAlignedAxis(x: number, y: number, z: number): void;
+    /**
+     * Sets billboard aligned vector.
+     * @public
+     * @param {Vec3} alignedAxis - Align direction.
+     */
+    setAlignedAxis3v(alignedAxis: Vec3): void;
+    /**
+     * Returns aligned vector.
+     * @public
+     * @returns {Vec3}
+     */
+    getAlignedAxis(): Vec3;
+    /**
+     * Removes billboard from handler.
+     * @public
+     */
+    remove(): void;
+    /**
+     * Sets billboard picking color.
+     * @public
+     * @param {Vec3} color - Picking color.
+     */
+    setPickingColor3v(color: Vec3): void;
+    serializeWorkerData(workerId: number): Float32Array | null;
+}
+export { BaseBillboard };

package/lib/@openglobus/js/entity/BaseBillboardHandler.d.ts

@@ -0,0 +1,81 @@
+import { TypedArray } from "../utils/shared";
+import { EntityCollection } from "./EntityCollection";
+import { Renderer } from "../renderer/Renderer";
+import { Vec3 } from "../math/Vec3";
+import { Vec4 } from "../math/Vec4";
+import { WebGLBufferExt } from "../webgl/Handler";
+import { BaseBillboard } from "./BaseBillboard";
+/**
+ * @class BaseBillboardHandler
+ */
+declare class BaseBillboardHandler {
+    static __counter__: number;
+    __id: number;
+    /**
+     * Picking rendering option.
+     * @public
+     * @type {boolean}
+     */
+    pickingEnabled: boolean;
+    _entityCollection: EntityCollection;
+    protected _renderer: Renderer | null;
+    protected _billboards: BaseBillboard[];
+    protected _positionHighBuffer: WebGLBufferExt | null;
+    protected _positionLowBuffer: WebGLBufferExt | null;
+    protected _sizeBuffer: WebGLBufferExt | null;
+    protected _offsetBuffer: WebGLBufferExt | null;
+    protected _rgbaBuffer: WebGLBufferExt | null;
+    protected _rotationBuffer: WebGLBufferExt | null;
+    protected _texCoordBuffer: WebGLBufferExt | null;
+    protected _vertexBuffer: WebGLBufferExt | null;
+    protected _texCoordArr: Float32Array;
+    protected _vertexArr: Float32Array;
+    protected _positionHighArr: Float32Array;
+    protected _positionLowArr: Float32Array;
+    protected _sizeArr: Float32Array;
+    protected _offsetArr: Float32Array;
+    protected _rgbaArr: Float32Array;
+    protected _rotationArr: Float32Array;
+    protected _pickingColorBuffer: WebGLBufferExt | null;
+    protected _pickingColorArr: Float32Array;
+    protected _buffersUpdateCallbacks: Function[];
+    protected _changedBuffers: boolean[];
+    constructor(entityCollection: EntityCollection);
+    isEqual(handler: BaseBillboardHandler): boolean;
+    static concArr(dest: number[], curr: number[]): void;
+    initProgram(): void;
+    setRenderer(renderer: Renderer): void;
+    refresh(): void;
+    protected _removeBillboards(): void;
+    clear(): void;
+    protected _deleteBuffers(): void;
+    update(): void;
+    add(billboard: BaseBillboard): void;
+    protected _displayPASS(): void;
+    protected _pickingPASS(): void;
+    draw(): void;
+    drawPicking(): void;
+    reindexBillboardsArray(startIndex: number): void;
+    protected _removeBillboard(billboard: BaseBillboard): void;
+    setAlignedAxisArr(index: number, alignedAxis: Vec3): void;
+    remove(billboard: BaseBillboard): void;
+    setPositionArr(index: number, positionHigh: Vec3, positionLow: Vec3): void;
+    setPickingColorArr(index: number, color: Vec3): void;
+    setSizeArr(index: number, width: number, height: number): void;
+    setOffsetArr(index: number, offset: Vec3): void;
+    setRgbaArr(index: number, rgba: Vec4): void;
+    setRotationArr(index: number, rotation: number): void;
+    setTexCoordArr(index: number, tcoordArr: number[] | TypedArray): void;
+    setVisibility(index: number, visibility: boolean): void;
+    setVertexArr(index: number, vertexArr: number[] | Float32Array): void;
+    createPositionBuffer(): void;
+    createSizeBuffer(): void;
+    createOffsetBuffer(): void;
+    createRgbaBuffer(): void;
+    createRotationBuffer(): void;
+    createVertexBuffer(): void;
+    createTexCoordBuffer(): void;
+    createPickingColorBuffer(): void;
+    refreshTexCoordsArr(): void;
+}
+export { BaseBillboardHandler };

package/lib/@openglobus/js/entity/Billboard.d.ts

@@ -0,0 +1,113 @@
+import { BaseBillboard, IBaseBillboardParams } from "./BaseBillboard";
+import { BillboardHandler } from "./BillboardHandler";
+import { HTMLImageElementExt } from "../utils/ImagesCacheManager";
+export interface IBillboardParams extends IBaseBillboardParams {
+    src?: string;
+    image?: HTMLImageElement;
+    size?: [number, number];
+    width?: number;
+    height?: number;
+}
+/**
+ * Represents basic quad billboard image.
+ * @class
+ * @extends {BaseBillboard}
+ * @param {Object} [options] - Options:
+ * @param {Vec3|Array.<number>} [options.position] - Billboard spatial position.
+ * @param {number} [options.rotation] - Screen angle rotation.
+ * @param {Vec4|string|Array.<number>} [options.color] - Billboard color.
+ * @param {Vec3|Array.<number>} [options.alignedAxis] - Billboard aligned vector.
+ * @param {Vec3|Array.<number>} [options.offset] - Billboard center screen offset.
+ * @param {boolean} [options.visibility] - Visibility.
+ * @param {string} [options.src] - Billboard image url source.
+ * @param {Image} [options.image] - Billboard image object.
+ * @param {number} [options.width] - Screen width.
+ * @param {number} [options.height] - Screen height.
+ * @param {number} [options.scale] - Billboard scale.
+ */
+declare class Billboard extends BaseBillboard {
+    _handler: BillboardHandler | null;
+    /**
+     * Image src.
+     * @protected
+     * @type {string}
+     */
+    protected _src: string | null;
+    /**
+     * Image object.
+     * @protected
+     * @type {Object}
+     */
+    protected _image: HTMLImageElement & {
+        __nodeIndex?: number;
+    } | null;
+    protected _scale: number;
+    /**
+     * Billboard screen width.
+     * @public
+     * @type {number}
+     */
+    _width: number;
+    /**
+     * Billboard screen height.
+     * @public
+     * @type {number}
+     */
+    _height: number;
+    constructor(options?: IBillboardParams);
+    /**
+     * Sets billboard image url source.
+     * @public
+     * @param {string} src - Image url.
+     */
+    setSrc(src: string | null): void;
+    getSrc(): string | null;
+    /**
+     * Sets image object.
+     * @public
+     * @param {Object} image - JavaScript image object.
+     */
+    setImage(image: HTMLImageElement): void;
+    getImage(): HTMLImageElementExt | null;
+    /**
+     * Sets billboard screen size in pixels.
+     * @public
+     * @param {number} width - Billboard width.
+     * @param {number} height - Billboard height.
+     */
+    setSize(width: number, height: number): void;
+    /**
+     * Returns billboard screen size.
+     * @public
+     * @returns {Object}
+     */
+    getSize(): {
+        width: number;
+        height: number;
+    };
+    /**
+     * Sets billboard screen width.
+     * @public
+     * @param {number} width - Width.
+     */
+    setWidth(width: number): void;
+    /**
+     * Gets billboard screen width.
+     * @public
+     * @returns {number}
+     */
+    getWidth(): number;
+    /**
+     * Sets billboard screen heigh.
+     * @public
+     * @param {number} height - Height.
+     */
+    setHeight(height: number): void;
+    /**
+     * Gets billboard screen height.
+     * @public
+     * @returns {number}
+     */
+    getHeight(): number;
+}
+export { Billboard };

package/lib/@openglobus/js/entity/BillboardHandler.d.ts

@@ -0,0 +1,15 @@
+import { BaseBillboardHandler } from "./BaseBillboardHandler";
+import { Billboard } from "./Billboard";
+import { EntityCollection } from "./EntityCollection";
+/**
+ * @class BillboardHandler
+ */
+declare class BillboardHandler extends BaseBillboardHandler {
+    protected _billboards: Billboard[];
+    constructor(props: EntityCollection);
+    add(billboard: Billboard): void;
+    protected _addBillboardToArrays(billboard: Billboard): void;
+    get billboards(): Billboard[];
+    refreshTexCoordsArr(): void;
+}
+export { BillboardHandler };