@openglobus/og 0.12.1 → 0.13.0

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";

package/types/entity/EntityCollection.d.ts

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