@openglobus/og 0.11.7 → 0.12.3

package/types/entity/Billboard.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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 rotaion.
+ * @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.
+ */
+export class Billboard extends BaseBillboard {
+    /**
+     * 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;
+}
+import { BaseBillboard } from "./BaseBillboard.js";

package/types/entity/BillboardHandler.d.ts

@@ -0,0 +1,79 @@
+export class BillboardHandler {
+    static set _staticCounter(arg: any);
+    static get _staticCounter(): any;
+    static concArr(dest: any, curr: any): void;
+    /**
+     *
+     * @param {*} entityCollection
+     */
+    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;
+    isEqual(handler: any): boolean;
+    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,348 @@
+/**
+ * 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 {Vec3|Array.<number>} [options.cartesian] - Spatial entities like billboard, label, sphere etc. cartesian position.
+ * @param {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.<Entity>}
+     */
+    public childrenNodes: Array<Entity>;
+    /**
+     * Parent entity.
+     * @public
+     * @type {Entity}
+     */
+    public parent: Entity;
+    /**
+     * Entity cartesian position.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _cartesian: Vec3;
+    /**
+     * Geodetic entity coordiantes.
+     * @protected
+     * @type {LonLat}
+     */
+    protected _lonlat: LonLat;
+    /**
+     * World Mercator entity coordinates.
+     * @protected
+     * @type {LonLat}
+     */
+    protected _lonlatMerc: LonLat;
+    /**
+     * 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 {EntityCollection}
+     */
+    protected _entityCollection: EntityCollection;
+    /**
+     * Entity collection array store index.
+     * @protected
+     * @type {number}
+     */
+    protected _entityCollectionIndex: number;
+    /**
+     * Assigned vector layer pointer.
+     * @protected
+     * @type {layer.Vector}
+     */
+    protected _layer: layer.Vector;
+    /**
+     * Assigned vector layer entity array index.
+     * @protected
+     * @type {number}
+     */
+    protected _layerIndex: number;
+    /**
+     * Picking color.
+     * @protected
+     * @type {Vec3}
+     */
+    protected _pickingColor: Vec3;
+    _featureConstructorArray: {
+        billboard: (typeof Billboard | ((billboard: Billboard) => Billboard))[];
+        label: (typeof Label | ((label: Label) => Label))[];
+        sphere: (typeof Sphere | ((shape: BaseShape) => Polyline))[];
+        polyline: (typeof Polyline | ((polyline: Polyline) => Polyline))[];
+        pointCloud: (typeof PointCloud | ((pointCloud: PointCloud) => PointCloud))[];
+        geometry: (typeof Geometry | ((geometry: Geometry) => Geometry))[];
+        geoObject: (typeof GeoObject | ((geoObject: GeoObject) => GeoObject))[];
+        strip: (typeof Strip | ((strip: Strip) => Strip))[];
+        ray: (typeof Ray | ((ray: Ray) => Ray))[];
+    };
+    /**
+     * Billboard entity.
+     * @public
+     * @type {Billboard}
+     */
+    public billboard: Billboard;
+    /**
+     * Text label entity.
+     * @public
+     * @type {Label}
+     */
+    public label: Label;
+    /**
+     * Shape entity.
+     * @public
+     * @type {shape.BaseShape}
+     */
+    public shape: shape.BaseShape;
+    /**
+     * Polyline entity.
+     * @public
+     * @type {Polyline}
+     */
+    public polyline: Polyline;
+    /**
+     * Ray entity.
+     * @public
+     * @type {ray}
+     */
+    public ray: ray;
+    /**
+     * PointCloud entity.
+     * @public
+     * @type {PointCloud}
+     */
+    public pointCloud: PointCloud;
+    /**
+     * Geometry entity(available for vector layer only).
+     * @public
+     * @type {Geometry}
+     */
+    public geometry: Geometry;
+    /**
+     * Geo object entity
+     * @public
+     * @type {og.Geometry}
+     */
+    public geoObject: og.Geometry;
+    /**
+     * Strip entity.
+     * @public
+     * @type {Strip}
+     */
+    public strip: Strip;
+    get instanceName(): string;
+    _createOptionFeature(featureName: any, options: any): any;
+    getCollectionIndex(): number;
+    /**
+     * Adds current entity into the specified entity collection.
+     * @public
+     * @param {EntityCollection|Vector} collection - Specified entity collection or vector layer.
+     * @param {Boolean} [rightNow=false] - Entity insertion option for vector layer.
+     * @returns {Entity} - This object.
+     */
+    public addTo(collection: EntityCollection | Vector, rightNow?: boolean): Entity;
+    /**
+     * 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 {Vec3} cartesian - Cartesian position in 3d space.
+     */
+    public setCartesian3v(cartesian: Vec3): 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 {Vec3} cartesian - Cartesian position in 3d space.
+     * @param {boolean} skipLonLat - skip geodetic calculation.
+     */
+    protected _setCartesian3vSilent(cartesian: Vec3, skipLonLat: boolean): void;
+    /**
+     * Gets entity geodetic coordinates.
+     * @public
+     * @returns {LonLat} -
+     */
+    public getLonLat(): LonLat;
+    /**
+     * Sets geodetic coordinates of the entity point object.
+     * @public
+     * @param {LonLat} lonlat - WGS84 coordinates.
+     */
+    public setLonLat(lonlat: LonLat): 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 {Vec3} -
+     */
+    public getCartesian(): Vec3;
+    /**
+     * Sets entity billboard.
+     * @public
+     * @param {Billboard} billboard - Billboard object.
+     * @returns {Billboard} -
+     */
+    public setBillboard(billboard: Billboard): Billboard;
+    /**
+     * Sets entity label.
+     * @public
+     * @param {Label} label - Text label.
+     * @returns {Label} -
+     */
+    public setLabel(label: Label): Label;
+    /**
+     * Sets entity ray.
+     * @public
+     * @param {Ray} ray - Ray object.
+     * @returns {Ray} -
+     */
+    public setRay(ray: Ray): Ray;
+    /**
+     * Sets entity shape.
+     * @public
+     * @param {BaseShape} shape - Shape object.
+     * @returns {Polyline} -
+     */
+    public setShape(shape: BaseShape): Polyline;
+    /**
+     * Sets entity polyline.
+     * @public
+     * @param {Polyline} polyline - Polyline object.
+     * @returns {Polyline} -
+     */
+    public setPolyline(polyline: Polyline): Polyline;
+    /**
+     * Sets entity pointCloud.
+     * @public
+     * @param {PointCloud} pointCloud - PointCloud object.
+     * @returns {PointCloud} -
+     */
+    public setPointCloud(pointCloud: PointCloud): PointCloud;
+    /**
+     * Sets entity geometry.
+     * @public
+     * @param {Geometry} geometry - Geometry object.
+     * @returns {Geometry} -
+     */
+    public setGeometry(geometry: Geometry): Geometry;
+    /**
+     * Sets entity geoObject.
+     * @public
+     * @param {GeoObject} geoObject - GeoObject.
+     * @returns {GeoObject} -
+     */
+    public setGeoObject(geoObject: GeoObject): GeoObject;
+    /**
+     * Sets entity strip.
+     * @public
+     * @param {Strip} strip - Strip object.
+     * @returns {Strip} -
+     */
+    public setStrip(strip: Strip): Strip;
+    get layer(): layer.Vector;
+    get rendererEvents(): any;
+    /**
+     * Append child entity.
+     * @public
+     * @param {Entity} entity - Child entity.
+     */
+    public appendChild(entity: Entity): void;
+    /**
+     * Appends entity items(billboard, label etc.) picking color.
+     * @public
+     */
+    public setPickingColor(): void;
+    /**
+     * Return geodethic extent.
+     * @returns {Extent} -
+     */
+    getExtent(): Extent;
+    isEqual(entity: any): boolean;
+}
+import { Vec3 } from "../math/Vec3.js";
+import { LonLat } from "../LonLat.js";
+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 { GeoObject } from "./GeoObject.js";
+import { Strip } from "./Strip.js";
+import { Ray } from "./Ray.js";
+import { Extent } from "../Extent.js";