@openglobus/og 0.10.4 → 0.11.1

package/types/entity/BaseBillboard.d.ts

@@ -0,0 +1,208 @@
+/**
+ * Base prototype for billboard and label classes.
+ * @class
+ * @param {Object} [options] - 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.
+ */
+export class BaseBillboard {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(options: any);
+    /**
+     * Object unic identifier.
+     * @public
+     * @readonly
+     * @type {number}
+     */
+    public readonly id: number;
+    /**
+     * Billboard center cartesian position.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _position: any;
+    _positionHigh: Vec3;
+    _positionLow: Vec3;
+    /**
+     * Screen space rotation angle.
+     * @protected
+     * @type {number}
+     */
+    protected _rotation: number;
+    /**
+     * RGBA color.
+     * @protected
+     * @type {og.Vec4}
+     */
+    protected _color: any;
+    /**
+     * Cartesian aligned axis vector.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _alignedAxis: any;
+    /**
+     * Billboard center screen space offset. Where x,y - screen space offset and z - depth offset.
+     * @protected
+     * @type {og.math.Vecto3}
+     */
+    protected _offset: any;
+    /**
+     * Billboard visibility.
+     * @protected
+     * @type {boolean}
+     */
+    protected _visibility: boolean;
+    /**
+     * Entity instance that holds this billboard.
+     * @protected
+     * @type {og.Entity}
+     */
+    protected _entity: any;
+    /**
+     * Handler that stores and renders this billboard object.
+     * @protected
+     * @type {og.BillboardHandler}
+     */
+    protected _handler: any;
+    /**
+     * Billboard handler array index.
+     * @protected
+     * @type {number}
+     */
+    protected _handlerIndex: number;
+    /**
+     * Sets billboard 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: any): void;
+    /**
+     * Returns billboard position.
+     * @public
+     * @returns {og.Vec3}
+     */
+    public getPosition(): any;
+    /**
+     * Sets screen space offset.
+     * @public
+     * @param {number} x - X offset.
+     * @param {number} y - Y offset.
+     * @param {number} [z] - Z offset.
+     */
+    public setOffset(x: number, y: number, z?: number): void;
+    /**
+     * Sets screen space offset.
+     * @public
+     * @param {og.Vec2} offset - Offset size.
+     */
+    public setOffset3v(offset: any): void;
+    /**
+     * Returns billboard screen space offset size.
+     * @public
+     * @returns {og.Vec3}
+     */
+    public getOffset(): any;
+    /**
+     * Sets billboard screen space rotation in radians.
+     * @public
+     * @param {number} rotation - Screen space rotation in radians.
+     */
+    public setRotation(rotation: number): void;
+    /**
+     * Gets screen space rotation.
+     * @public
+     * @returns {number}
+     */
+    public getRotation(): number;
+    /**
+     * Sets billboard 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: any): void;
+    /**
+     * Sets billboard color.
+     * @public
+     * @param {string} color - HTML style color.
+     */
+    public setColorHTML(color: string): void;
+    /**
+     * Returns RGBA color.
+     * @public
+     * @returns {og.Vec4}
+     */
+    public getColor(): any;
+    /**
+     * Sets billboard visibility.
+     * @public
+     * @param {boolean} visibility - Visibility flag.
+     */
+    public setVisibility(visibility: boolean): void;
+    /**
+     * Returns billboard visibility.
+     * @public
+     * @returns {boolean}
+     */
+    public 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.
+     */
+    public setAlignedAxis(x: number, y: number, z: number): void;
+    /**
+     * Sets billboard aligned vector.
+     * @public
+     * @param {og.math.Vecto3} alignedAxis - Vector to align.
+     */
+    public setAlignedAxis3v(alignedAxis: any): void;
+    /**
+     * Returns aligned vector.
+     * @public
+     * @returns {og.Vec3}
+     */
+    public getAlignedAxis(): any;
+    /**
+     * Removes billboard from hander.
+     * @public
+     */
+    public remove(): void;
+    /**
+     * Sets billboard picking color.
+     * @public
+     * @param {og.Vec3} color - Picking color.
+     */
+    public setPickingColor3v(color: any): void;
+}
+import { Vec3 } from "../math/Vec3.js";

package/types/entity/Billboard.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Represents basic quad billboard image.
+ * @class
+ * @extends {og.BaseBillboard}
+ * @param {Object} [options] - 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.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.
+ */
+export class Billboard {
+    constructor(options: any);
+    /**
+     * Image src.
+     * @protected
+     * @type {string}
+     */
+    protected _src: string;
+    /**
+     * Image object.
+     * @protected
+     * @type {Object}
+     */
+    protected _image: any;
+    _scale: number;
+    /**
+     * Billboard screen width.
+     * @protected
+     * @type {number}
+     */
+    protected _width: number;
+    /**
+     * Billboard screen height.
+     * @protected
+     * @type {number}
+     */
+    protected _height: number;
+    /**
+     * Sets billboard image url source.
+     * @public
+     * @param {string} src - Image url.
+     */
+    public setSrc(src: string): void;
+    /**
+     * Sets image object.
+     * @public
+     * @param {Object} image - JavaScript image object.
+     */
+    public setImage(image: any): void;
+    /**
+     * Sets billboard screen size in pixels.
+     * @public
+     * @param {number} width - Billboard width.
+     * @param {number} height - Billboard height.
+     */
+    public setSize(width: number, height: number): void;
+    /**
+     * Returns billboard screen size.
+     * @public
+     * @returns {Object}
+     */
+    public getSize(): any;
+    /**
+     * Sets billboard screen width.
+     * @public
+     * @param {number} width - Width.
+     */
+    public setWidth(width: number): void;
+    /**
+     * Gets billboard screen width.
+     * @public
+     * @returns {number}
+     */
+    public getWidth(): number;
+    /**
+     * Sets billboard screen heigh.
+     * @public
+     * @param {number} height - Height.
+     */
+    public setHeight(height: number): void;
+    /**
+     * Gets billboard screen height.
+     * @public
+     * @returns {number}
+     */
+    public getHeight(): number;
+}

package/types/entity/BillboardHandler.d.ts

@@ -0,0 +1,74 @@
+export class BillboardHandler {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    static concArr(dest: any, curr: any): void;
+    constructor(entityCollection: any);
+    /**
+     * Picking rendering option.
+     * @public
+     * @type {boolean}
+     */
+    public pickingEnabled: boolean;
+    _entityCollection: any;
+    _renderer: any;
+    _billboards: any[];
+    _positionHighBuffer: any;
+    _positionLowBuffer: any;
+    _sizeBuffer: any;
+    _offsetBuffer: any;
+    _rgbaBuffer: any;
+    _rotationBuffer: any;
+    _texCoordBuffer: any;
+    _vertexBuffer: any;
+    _alignedAxisBuffer: any;
+    _texCoordArr: Float32Array;
+    _vertexArr: Float32Array;
+    _positionHighArr: Float32Array;
+    _positionLowArr: Float32Array;
+    _sizeArr: Float32Array;
+    _offsetArr: Float32Array;
+    _rgbaArr: Float32Array;
+    _rotationArr: Float32Array;
+    _alignedAxisArr: Float32Array;
+    _pickingColorBuffer: any;
+    _pickingColorArr: Float32Array;
+    _buffersUpdateCallbacks: (() => void)[];
+    _changedBuffers: any[];
+    __staticId: number;
+    initProgram(): void;
+    setRenderer(renderer: any): void;
+    refresh(): void;
+    _removeBillboards(): void;
+    clear(): void;
+    _deleteBuffers(): void;
+    update(): void;
+    add(billboard: any): void;
+    _addBillboardToArrays(billboard: any): void;
+    _displayPASS(): void;
+    _pickingPASS(): void;
+    draw(): void;
+    drawPicking(): void;
+    reindexBillbordsArray(startIndex: any): void;
+    _removeBillboard(billboard: any): void;
+    remove(billboard: any): void;
+    setPositionArr(index: any, positionHigh: any, positionLow: any): void;
+    setPickingColorArr(index: any, color: any): void;
+    setSizeArr(index: any, width: any, height: any): void;
+    setOffsetArr(index: any, offset: any): void;
+    setRgbaArr(index: any, rgba: any): void;
+    setRotationArr(index: any, rotation: any): void;
+    setTexCoordArr(index: any, tcoordArr: any): void;
+    setVisibility(index: any, visibility: any): void;
+    setVertexArr(index: any, vertexArr: any): void;
+    setAlignedAxisArr(index: any, alignedAxis: any): void;
+    createPositionBuffer(): void;
+    createSizeBuffer(): void;
+    createOffsetBuffer(): void;
+    createRgbaBuffer(): void;
+    createRotationBuffer(): void;
+    createVertexBuffer(): void;
+    createTexCoordBuffer(): void;
+    createAlignedAxisBuffer(): void;
+    createPickingColorBuffer(): void;
+    refreshTexCoordsArr(): void;
+}

package/types/entity/Entity.d.ts

@@ -0,0 +1,330 @@
+/**
+ * Entity instances aggregate multiple forms of visualization into a single high-level object.
+ * They can be created manually and added to entity collection.
+ *
+ * @class
+ * @param {Object} [options] - Entity options:
+ * @param {string} [options.name] - A human readable name to display to users. It does not have to be unique.
+ * @param {og.Vec3|Array.<number>} [options.cartesian] - Spatial entities like billboard, label, sphere etc. cartesian position.
+ * @param {og.LonLat} [options.lonlat] - Geodetic coordiantes for an entities like billboard, label, sphere etc.
+ * @param {boolean} [options.aground] - True for entities that have to be placed on the relief.
+ * @param {boolean} [options.visibility] - Entity visibility.
+ * @param {*} [options.billboard] - Billboard options(see {@link og.Billboard}).
+ * @param {*} [options.label] - Label options(see {@link og.Label}).
+ * @param {*} [options.sphere] - Sphere options(see {@link og.shape.Sphere}).
+ * @param {*} [options.box] - Sphere options(see {@link og.shape.Box}).
+ * @param {*} [options.polyline] - Polyline options(see {@link og.Polyline}).
+ * @param {*} [options.ray] - Ray options(see {@link og.Ray}).
+ * @param {*} [options.pointCloud] - Point cloud options(see {@link og.PointCloud}).
+ * @param {*} [options.geometry] - Geometry options (see {@link og.Geometry}), available for vector layer only.
+ * @param {*} [options.properties] - Entity custom properties.
+ */
+export class Entity {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    constructor(options: any);
+    /**
+     * Unic identifier.
+     * @public
+     * @readonly
+     */
+    public readonly id: number;
+    /**
+     * Entity user defined properties.
+     * @public
+     * @type {Object}
+     */
+    public properties: any;
+    /**
+     * Children entities.
+     * @public
+     * @type {Array.<og.Entity>}
+     */
+    public childrenNodes: Array<any>;
+    /**
+     * Parent entity.
+     * @public
+     * @type {og.Entity}
+     */
+    public parent: any;
+    /**
+     * Entity cartesian position.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _cartesian: any;
+    /**
+     * Geodetic entity coordiantes.
+     * @protected
+     * @type {og.LonLat}
+     */
+    protected _lonlat: any;
+    /**
+     * World Mercator entity coordinates.
+     * @protected
+     * @type {og.LonLat}
+     */
+    protected _lonlatMerc: any;
+    /**
+     * Entity visible terrain altitude.
+     * @protected
+     * @type {number}
+     */
+    protected _altitude: number;
+    /**
+     * Visibility flag.
+     * @protected
+     * @type {boolean}
+     */
+    protected _visibility: boolean;
+    /**
+     * Entity collection that this entity belongs to.
+     * @protected
+     * @type {og.EntityCollection}
+     */
+    protected _entityCollection: any;
+    /**
+     * Entity collection array store index.
+     * @protected
+     * @type {number}
+     */
+    protected _entityCollectionIndex: number;
+    /**
+     * Assigned vector layer pointer.
+     * @protected
+     * @type {og.layer.Vector}
+     */
+    protected _layer: any;
+    /**
+     * Assigned vector layer entity array index.
+     * @protected
+     * @type {number}
+     */
+    protected _layerIndex: number;
+    /**
+     * Picking color.
+     * @protected
+     * @type {og.Vec3}
+     */
+    protected _pickingColor: any;
+    _featureConstructorArray: {
+        billboard: (typeof Billboard | ((billboard: any) => any))[];
+        label: (typeof Label | ((label: any) => any))[];
+        sphere: (typeof Sphere | ((shape: any) => any))[];
+        polyline: (typeof Polyline | ((polyline: any) => any))[];
+        pointCloud: (typeof PointCloud | ((pointCloud: any) => any))[];
+        geometry: (typeof Geometry | ((geometry: any) => any))[];
+        strip: (typeof Strip | ((strip: any) => any))[];
+        ray: (typeof Ray | ((ray: any) => any))[];
+    };
+    /**
+     * Billboard entity.
+     * @public
+     * @type {og.Billboard}
+     */
+    public billboard: any;
+    /**
+     * Text label entity.
+     * @public
+     * @type {og.Label}
+     */
+    public label: any;
+    /**
+     * Shape entity.
+     * @public
+     * @type {og.shape.BaseShape}
+     */
+    public shape: any;
+    /**
+     * Polyline entity.
+     * @public
+     * @type {og.Polyline}
+     */
+    public polyline: any;
+    /**
+     * Ray entity.
+     * @public
+     * @type {og.ray}
+     */
+    public ray: any;
+    /**
+     * PointCloud entity.
+     * @public
+     * @type {og.PointCloud}
+     */
+    public pointCloud: any;
+    /**
+     * Geometry entity(available for vector layer only).
+     * @public
+     * @type {og.Geometry}
+     */
+    public geometry: any;
+    /**
+     * Strip entity.
+     * @public
+     * @type {og.Strip}
+     */
+    public strip: any;
+    get instanceName(): string;
+    _createOptionFeature(featureName: any, options: any): any;
+    getCollectionIndex(): number;
+    /**
+     * Adds current entity into the specified entity collection.
+     * @public
+     * @param {og.EntityCollection|og.layer.Vector} collection - Specified entity collection or vector layer.
+     * @param {Boolean} [rightNow=false] - Entity insertion option for vector layer.
+     * @returns {og.Entity} - This object.
+     */
+    public addTo(collection: any | any, rightNow?: boolean): any;
+    /**
+     * Removes current entity from collection and layer.
+     * @public
+     */
+    public remove(): void;
+    /**
+     * Sets the entity visibility.
+     * @public
+     * @param {boolean} visibility - Entity visibility.
+     */
+    public setVisibility(visibility: boolean): void;
+    /**
+     * Returns entity visibility.
+     * @public
+     * @returns {boolean} -
+     */
+    public getVisibility(): boolean;
+    /**
+     * Sets entity cartesian position.
+     * @public
+     * @param {og.Vec3} cartesian - Cartesian position in 3d space.
+     */
+    public setCartesian3v(cartesian: any): void;
+    /**
+     * Sets entity cartesian position.
+     * @public
+     * @param {number} x - 3d space X - position.
+     * @param {number} y - 3d space Y - position.
+     * @param {number} z - 3d space Z - position.
+     */
+    public setCartesian(x: number, y: number, z: number): void;
+    /**
+     * Sets entity cartesian position without event dispatching.
+     * @protected
+     * @param {og.Vec3} cartesian - Cartesian position in 3d space.
+     * @param {boolean} skipLonLat - skip geodetic calculation.
+     */
+    protected _setCartesian3vSilent(cartesian: any, skipLonLat: boolean): void;
+    /**
+     * Gets entity geodetic coordinates.
+     * @public
+     * @returns {og.LonLat} -
+     */
+    public getLonLat(): any;
+    /**
+     * Sets geodetic coordinates of the entity point object.
+     * @public
+     * @param {og.LonLat} lonlat - WGS84 coordinates.
+     */
+    public setLonLat(lonlat: any): void;
+    /**
+     * Sets entity altitude over the planet.
+     * @public
+     * @param {number} altitude - Altitude.
+     */
+    public setAltitude(altitude: number): void;
+    /**
+     * Sets entity altitude over the planet.
+     * @public
+     * @return {number} Altitude.
+     */
+    public getAltitude(): number;
+    /**
+     * Returns carteain position.
+     * @public
+     * @returns {og.Vec3} -
+     */
+    public getCartesian(): any;
+    /**
+     * Sets entity billboard.
+     * @public
+     * @param {og.Billboard} billboard - Billboard object.
+     * @returns {og.Billboard} -
+     */
+    public setBillboard(billboard: any): any;
+    /**
+     * Sets entity label.
+     * @public
+     * @param {og.Label} label - Text label.
+     * @returns {og.Label} -
+     */
+    public setLabel(label: any): any;
+    /**
+     * Sets entity ray.
+     * @public
+     * @param {og.Ray} ray - Ray object.
+     * @returns {og.Ray} -
+     */
+    public setRay(ray: any): any;
+    /**
+     * Sets entity shape.
+     * @public
+     * @param {og.BaseShape} shape - Shape object.
+     * @returns {og.Polyline} -
+     */
+    public setShape(shape: any): any;
+    /**
+     * Sets entity polyline.
+     * @public
+     * @param {og.Polyline} polyline - Polyline object.
+     * @returns {og.Polyline} -
+     */
+    public setPolyline(polyline: any): any;
+    /**
+     * Sets entity pointCloud.
+     * @public
+     * @param {og.PointCloud} pointCloud - PointCloud object.
+     * @returns {og.PointCloud} -
+     */
+    public setPointCloud(pointCloud: any): any;
+    /**
+     * Sets entity geometry.
+     * @public
+     * @param {og.Geometry} geometry - Geometry object.
+     * @returns {og.Geometry} -
+     */
+    public setGeometry(geometry: any): any;
+    /**
+     * Sets entity strip.
+     * @public
+     * @param {og.Strip} strip - Strip object.
+     * @returns {og.Strip} -
+     */
+    public setStrip(strip: any): any;
+    get layer(): any;
+    get rendererEvents(): any;
+    /**
+     * Append child entity.
+     * @public
+     * @param {og.Entity} entity - Child entity.
+     */
+    public appendChild(entity: any): void;
+    /**
+     * Appends entity items(billboard, label etc.) picking color.
+     * @public
+     */
+    public setPickingColor(): void;
+    /**
+     * Return geodethic extent.
+     * @returns {og.Extent} -
+     */
+    getExtent(): any;
+    isEqual(entity: any): boolean;
+}
+import { Billboard } from "./Billboard.js";
+import { Label } from "./Label.js";
+import { Sphere } from "../shapes/Sphere.js";
+import { Polyline } from "./Polyline.js";
+import { PointCloud } from "./PointCloud.js";
+import { Geometry } from "./Geometry.js";
+import { Strip } from "./Strip.js";
+import { Ray } from "./Ray.js";