@openglobus/og 0.19.4 → 0.20.0

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

@@ -0,0 +1,354 @@
+import { Billboard, IBillboardParams } from "./Billboard";
+import { EntityCollection, EntityCollectionEvents } from "./EntityCollection";
+import { Extent } from "../Extent";
+import { Geometry, IGeometryParams } from "./Geometry";
+import { GeoObject, IGeoObjectParams } from "./GeoObject";
+import { LonLat } from "../LonLat";
+import { Label, ILabelParams } from "./Label";
+import { NumberArray3, Vec3 } from "../math/Vec3";
+import { NumberArray2 } from "../math/Vec2";
+import { IPointCloudParams, PointCloud } from "./PointCloud";
+import { IPolylineParams, Polyline } from "./Polyline";
+import { IRayParams, Ray } from "./Ray";
+import { Strip } from "./Strip";
+import { Vector, VectorEventsType } from "../layer/Vector";
+import { EntityCollectionNode } from "../quadTree/EntityCollectionNode";
+export interface IEntityParams {
+    name?: string;
+    properties?: any;
+    cartesian?: Vec3 | NumberArray3;
+    lonlat?: LonLat | NumberArray3 | NumberArray2;
+    altitude?: number;
+    visibility?: boolean;
+    billboard?: Billboard | IBillboardParams;
+    label?: Label | ILabelParams;
+    polyline?: Polyline | IPolylineParams;
+    ray?: Ray | IRayParams;
+    pointCloud?: PointCloud | IPointCloudParams;
+    geometry?: Geometry | IGeometryParams;
+    geoObject?: GeoObject | IGeoObjectParams;
+    strip?: Strip;
+}
+/**
+ * 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 etc. cartesian position.
+ * @param {LonLat} [options.lonlat] - Geodetic coordinates for an entities like billboard, label 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 Billboard}).
+ * @param {*} [options.label] - Label options(see {@link Label}).
+ * @param {*} [options.polyline] - Polyline options(see {@link Polyline}).
+ * @param {*} [options.ray] - Ray options(see {@link Ray}).
+ * @param {*} [options.pointCloud] - Point cloud options(see {@link PointCloud}).
+ * @param {*} [options.geometry] - Geometry options (see {@link Geometry}), available for vector layer only.
+ * @param {*} [options.properties] - Entity custom properties.
+ */
+declare class Entity {
+    static __counter__: number;
+    /**
+     * Uniq identifier.
+     * @public
+     * @readonly
+     */
+    protected __id: number;
+    /**
+     * Entity user defined properties.
+     * @public
+     * @type {Object}
+     */
+    properties: any;
+    /**
+     * Children entities.
+     * @public
+     * @type {Array.<Entity>}
+     */
+    childrenNodes: Entity[];
+    /**
+     * Parent entity.
+     * @public
+     * @type {Entity}
+     */
+    parent: Entity | null;
+    /**
+     * Entity cartesian position.
+     * @protected
+     * @type {Vec3}
+     */
+    _cartesian: Vec3;
+    /**
+     * Geodetic entity coordinates.
+     * @public
+     * @type {LonLat}
+     */
+    _lonLat: LonLat;
+    /**
+     * World Mercator entity coordinates.
+     * @public
+     * @type {LonLat}
+     */
+    _lonLatMerc: LonLat;
+    /**
+     * Entity visible terrain altitude.
+     * @public
+     * @type {number}
+     */
+    _altitude: number;
+    /**
+     * Visibility flag.
+     * @protected
+     * @type {boolean}
+     */
+    protected _visibility: boolean;
+    /**
+     * Entity collection that this entity belongs to.
+     * @public
+     * @type {EntityCollection}
+     */
+    _entityCollection: EntityCollection | null;
+    /**
+     * Entity collection array store index.
+     * @public
+     * @type {number}
+     */
+    _entityCollectionIndex: number;
+    /**
+     * Assigned vector layer pointer.
+     * @public
+     * @type {Vector}
+     */
+    _layer: Vector | null;
+    /**
+     * Assigned vector layer entity array index.
+     * @public
+     * @type {number}
+     */
+    _layerIndex: number;
+    /**
+     * Picking color.
+     * @public
+     * @type {Vec3}
+     */
+    _pickingColor: Vec3;
+    protected _featureConstructorArray: Record<string, [any, Function]>;
+    /**
+     * Billboard entity.
+     * @public
+     * @type {Billboard | null}
+     */
+    billboard: Billboard | null;
+    /**
+     * Text label entity.
+     * @public
+     * @type {Label | null}
+     */
+    label: Label | null;
+    /**
+     * Polyline entity.
+     * @public
+     * @type {Polyline | null}
+     */
+    polyline: Polyline | null;
+    /**
+     * Ray entity.
+     * @public
+     * @type {Ray | null}
+     */
+    ray: Ray | null;
+    /**
+     * PointCloud entity.
+     * @public
+     * @type {PointCloud | null}
+     */
+    pointCloud: PointCloud | null;
+    /**
+     * Geometry entity(available for vector layer only).
+     * @public
+     * @type {Geometry | null}
+     */
+    geometry: Geometry | null;
+    /**
+     * Geo object entity
+     * @public
+     * @type {Geometry | null}
+     */
+    geoObject: GeoObject | null;
+    /**
+     * Strip entity.
+     * @public
+     * @type {Strip | null}
+     */
+    strip: Strip | null;
+    _nodePtr?: EntityCollectionNode;
+    constructor(options?: IEntityParams);
+    get id(): number;
+    isEqual(entity: Entity): boolean;
+    get layerIndex(): number;
+    get instanceName(): string;
+    protected _createOptionFeature<T, K>(featureName: string, options?: T | K): T | null;
+    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.
+     */
+    addTo(collection: EntityCollection | Vector, rightNow?: boolean): this;
+    /**
+     * Removes current entity from collection and layer.
+     * @public
+     */
+    remove(): void;
+    /**
+     * Sets the entity visibility.
+     * @public
+     * @param {boolean} visibility - Entity visibility.
+     */
+    setVisibility(visibility: boolean): void;
+    /**
+     * Returns entity visibility.
+     * @public
+     * @returns {boolean} -
+     */
+    getVisibility(): boolean;
+    /**
+     * Sets entity cartesian position.
+     * @public
+     * @param {Vec3} cartesian - Cartesian position in 3d space.
+     */
+    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.
+     */
+    setCartesian(x?: number, y?: number, z?: number): void;
+    /**
+     * Sets entity cartesian position without event dispatching.
+     * @public
+     * @param {Vec3} cartesian - Cartesian position in 3d space.
+     * @param {boolean} skipLonLat - skip geodetic calculation.
+     */
+    _setCartesian3vSilent(cartesian: Vec3, skipLonLat?: boolean): void;
+    /**
+     * Gets entity geodetic coordinates.
+     * @public
+     * @returns {LonLat} -
+     */
+    getLonLat(): LonLat;
+    /**
+     * Sets geodetic coordinates of the entity point object.
+     * @public
+     * @param {LonLat} lonlat - WGS84 coordinates.
+     */
+    setLonLat(lonlat: LonLat): void;
+    /**
+     * Sets geodetic coordinates of the entity point object.
+     * @public
+     * @param {number} lon - Longitude.
+     * @param {number} lat - Latitude
+     * @param {number} [height] - Height
+     */
+    setLonLat2(lon: number, lat: number, height?: number): void;
+    /**
+     * Sets entity altitude over the planet.
+     * @public
+     * @param {number} altitude - Altitude.
+     */
+    setAltitude(altitude: number): void;
+    /**
+     * Sets entity altitude over the planet.
+     * @public
+     * @return {number} Altitude.
+     */
+    getAltitude(): number;
+    /**
+     * Returns cartesian position.
+     * @public
+     * @returns {Vec3} -
+     */
+    getCartesian(): Vec3;
+    /**
+     * Sets entity billboard.
+     * @public
+     * @param {Billboard} billboard - Billboard object.
+     * @returns {Billboard} -
+     */
+    setBillboard(billboard: Billboard): Billboard;
+    /**
+     * Sets entity label.
+     * @public
+     * @param {Label} label - Text label.
+     * @returns {Label} -
+     */
+    setLabel(label: Label): Label;
+    /**
+     * Sets entity ray.
+     * @public
+     * @param {Ray} ray - Ray object.
+     * @returns {Ray} -
+     */
+    setRay(ray: Ray): Ray;
+    /**
+     * Sets entity polyline.
+     * @public
+     * @param {Polyline} polyline - Polyline object.
+     * @returns {Polyline} -
+     */
+    setPolyline(polyline: Polyline): Polyline;
+    /**
+     * Sets entity pointCloud.
+     * @public
+     * @param {PointCloud} pointCloud - PointCloud object.
+     * @returns {PointCloud} -
+     */
+    setPointCloud(pointCloud: PointCloud): PointCloud;
+    /**
+     * Sets entity geometry.
+     * @public
+     * @param {Geometry} geometry - Geometry object.
+     * @returns {Geometry} -
+     */
+    setGeometry(geometry: Geometry): Geometry;
+    /**
+     * Sets entity geoObject.
+     * @public
+     * @param {GeoObject} geoObject - GeoObject.
+     * @returns {GeoObject} -
+     */
+    setGeoObject(geoObject: GeoObject): GeoObject;
+    /**
+     * Sets entity strip.
+     * @public
+     * @param {Strip} strip - Strip object.
+     * @returns {Strip} -
+     */
+    setStrip(strip: Strip): Strip;
+    get layer(): Vector | null;
+    get rendererEvents(): VectorEventsType | EntityCollectionEvents | null;
+    /**
+     * Append child entity.
+     * @public
+     * @param {Entity} entity - Child entity.
+     */
+    appendChild(entity: Entity): void;
+    /**
+     * Appends entity items(billboard, label etc.) picking color.
+     * @public
+     */
+    setPickingColor(): void;
+    /**
+     * Return geodetic extent.
+     * @public
+     * @returns {Extent} -
+     */
+    getExtent(): Extent;
+}
+export { Entity };

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

@@ -0,0 +1,363 @@
+import { BillboardHandler } from "./BillboardHandler";
+import { EventsHandler } from "../Events";
+import { Entity } from "./Entity";
+import { Ellipsoid } from "../ellipsoid/Ellipsoid";
+import { EntityCollectionNode } from "../quadTree/EntityCollectionNode";
+import { GeoObjectHandler } from "./GeoObjectHandler";
+import { LabelHandler } from "./LabelHandler";
+import { NumberArray3 } from "../math/Vec3";
+import { PointCloudHandler } from "./PointCloudHandler";
+import { PolylineHandler } from "./PolylineHandler";
+import { RayHandler } from "./RayHandler";
+import { RenderNode } from "../scene/RenderNode";
+import { StripHandler } from "./StripHandler";
+import { Vector } from "../layer/Vector";
+export type EntityCollectionEvents = EventsHandler<EntityCollectionEventList>;
+interface IEntityCollectionParams {
+    polygonOffsetUnits?: number;
+    visibility?: boolean;
+    labelMaxLetters?: number;
+    pickingEnabled?: boolean;
+    scaleByDistance?: NumberArray3;
+    pickingScale?: number;
+    opacity?: number;
+    entities?: Entity[];
+}
+/**
+ * An observable collection of og.Entity instances where each entity has a unique id.
+ * Entity collection provide handlers for 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 EntityCollection#entitymove
+ * @fires EntityCollection#draw
+ * @fires EntityCollection#drawend
+ * @fires EntityCollection#add
+ * @fires EntityCollection#remove
+ * @fires EntityCollection#entityadd
+ * @fires EntityCollection#entityremove
+ * @fires EntityCollection#visibilitychange
+ * @fires EntityCollection#mousemove
+ * @fires EntityCollection#mouseenter
+ * @fires EntityCollection#mouseleave
+ * @fires EntityCollection#lclick
+ * @fires EntityCollection#rclick
+ * @fires EntityCollection#mclick
+ * @fires EntityCollection#ldblclick
+ * @fires EntityCollection#rdblclick
+ * @fires EntityCollection#mdblclick
+ * @fires EntityCollection#lup
+ * @fires EntityCollection#rup
+ * @fires EntityCollection#mup
+ * @fires EntityCollection#ldown
+ * @fires EntityCollection#rdown
+ * @fires EntityCollection#mdown
+ * @fires EntityCollection#lhold
+ * @fires EntityCollection#rhold
+ * @fires EntityCollection#mhold
+ * @fires EntityCollection#mousewheel
+ * @fires EntityCollection#touchmove
+ * @fires EntityCollection#touchstart
+ * @fires EntityCollection#touchend
+ * @fires EntityCollection#doubletouch
+ * @fires EntityCollection#touchleave
+ * @fires EntityCollection#touchenter
+ */
+declare class EntityCollection {
+    static __counter__: number;
+    /**
+     * Uniq identifier.
+     * @public
+     * @readonly
+     */
+    protected __id: number;
+    /**
+     * Render node collections array index.
+     * @protected
+     * @type {number}
+     */
+    protected _renderNodeIndex: number;
+    /**
+     * Render node context.
+     * @public
+     * @type {RenderNode}
+     */
+    renderNode: RenderNode | null;
+    /**
+     * Visibility option.
+     * @public
+     * @type {boolean}
+     */
+    _visibility: boolean;
+    /**
+     * Specifies the scale Units for gl.polygonOffset function to calculate depth values, 0.0 is default.
+     * @public
+     * @type {Number}
+     */
+    polygonOffsetUnits: number;
+    /**
+     * Billboards handler
+     * @public
+     * @type {BillboardHandler}
+     */
+    billboardHandler: BillboardHandler;
+    /**
+     * Labels handler
+     * @public
+     * @type {LabelHandler}
+     */
+    labelHandler: LabelHandler;
+    /**
+     * Polyline handler
+     * @public
+     * @type {PolylineHandler}
+     */
+    polylineHandler: PolylineHandler;
+    /**
+     * Ray handler
+     * @public
+     * @type {RayHandler}
+     */
+    rayHandler: RayHandler;
+    /**
+     * PointCloud handler
+     * @public
+     * @type {PointCloudHandler}
+     */
+    pointCloudHandler: PointCloudHandler;
+    /**
+     * Strip handler
+     * @public
+     * @type {StripHandler}
+     */
+    stripHandler: StripHandler;
+    /**
+     * Geo object handler
+     * @public
+     * @type {GeoObjectHandler}
+     */
+    geoObjectHandler: GeoObjectHandler;
+    /**
+     * Entities array.
+     * @public
+     * @type {Array.<Entity>}
+     */
+    _entities: 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)
+     */
+    scaleByDistance: NumberArray3;
+    pickingScale: number;
+    /**
+     * Global opacity.
+     * @protected
+     * @type {number}
+     */
+    protected _opacity: number;
+    /**
+     * Opacity state during the animated opacity.
+     * @public
+     * @type {number}
+     */
+    _fadingOpacity: number;
+    /**
+     * Entity collection events handler.
+     * @public
+     * @type {EntityCollectionEvents}
+     */
+    events: EntityCollectionEvents;
+    rendererEvents: EntityCollectionEvents;
+    /**
+     * Used in EntityCollectionNode, also could be merged with _quadNode
+     */
+    _layer?: Vector;
+    _quadNode?: EntityCollectionNode;
+    constructor(options?: IEntityCollectionParams);
+    get id(): number;
+    isEqual(ec: EntityCollection): boolean;
+    /**
+     * Sets collection visibility.
+     * @public
+     * @param {boolean} visibility - Visibility flag.
+     */
+    setVisibility(visibility: boolean): void;
+    /**
+     * Returns collection visibility.
+     * @public
+     * @returns {boolean} -
+     */
+    getVisibility(): boolean;
+    /**
+     * Sets collection opacity.
+     * @public
+     * @param {number} opacity - Opacity.
+     */
+    setOpacity(opacity: number): void;
+    /**
+     * Sets collection picking ability.
+     * @public
+     * @param {boolean} enable - Picking enable flag.
+     */
+    setPickingEnabled(enable: boolean): void;
+    /**
+     * Gets collection opacity.
+     * @public
+     * @returns {number} -
+     */
+    getOpacity(): number;
+    /**
+     * Sets scale by distance parameters.
+     * @public
+     * @param {number} near - Full scale entity distance.
+     * @param {number} far - Zero scale entity distance.
+     * @param {number} [farInvisible] - Entity visibility distance.
+     */
+    setScaleByDistance(near: number, far: number, farInvisible?: number): void;
+    appendChildEntity(entity: Entity): void;
+    protected _addRecursively(entity: Entity): void;
+    /**
+     * Adds entity to the collection and returns collection.
+     * @public
+     * @param {Entity} entity - Entity.
+     * @returns {EntityCollection} -
+     */
+    add(entity: Entity): EntityCollection;
+    /**
+     * Adds entities array to the collection and returns collection.
+     * @public
+     * @param {Array.<Entity>} entities - Entities array.
+     * @returns {EntityCollection} -
+     */
+    addEntities(entities: Entity[]): EntityCollection;
+    /**
+     * Returns true if the entity belongs this collection, otherwise returns false.
+     * @public
+     * @param {Entity} entity - Entity.
+     * @returns {boolean} -
+     */
+    belongs(entity: Entity): boolean | null;
+    protected _removeRecursively(entity: Entity): void;
+    /**
+     * Removes entity from this collection.
+     * @public
+     * @param {Entity} entity - Entity to remove.
+     */
+    removeEntity(entity: Entity): void;
+    _removeEntitySilent(entity: Entity): void;
+    /**
+     * Creates or refresh collected entities picking color.
+     * @public
+     */
+    createPickingColors(): void;
+    /**
+     * Refresh collected entities indexes from startIndex entities collection array position.
+     * @public
+     * @param {number} startIndex - Entities collection array index.
+     */
+    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} -
+     */
+    addTo(renderNode: RenderNode, isHidden?: boolean): this;
+    /**
+     * This function is called in the RenderNode assign function.
+     * @public
+     * @param {RenderNode} renderNode
+     */
+    bindRenderNode(renderNode: RenderNode): void;
+    /**
+     * Updates coordinates all lonLat entities in collection after collection attached to the planet node.
+     * @protected
+     * @param {Ellipsoid} ellipsoid - Globe ellipsoid.
+     */
+    protected _updateGeodeticCoordinates(ellipsoid: Ellipsoid): void;
+    /**
+     * Updates billboard texture atlas.
+     * @public
+     */
+    updateBillboardsTextureAtlas(): void;
+    /**
+     * Updates labels font atlas.
+     * @public
+     */
+    updateLabelsFontAtlas(): void;
+    /**
+     * Removes collection from render node.
+     * @public
+     */
+    remove(): void;
+    /**
+     * Gets entity array.
+     * @public
+     * @returns {Array.<Entity>} -
+     */
+    getEntities(): Entity[];
+    /**
+     * Safety entities loop.
+     * @public
+     * @param {function} callback - Entity callback.
+     */
+    each(callback: Function): void;
+    /**
+     * Removes all entities from collection and clear handlers.
+     * @public
+     */
+    clear(): void;
+    /**
+     * Clears entity recursively.
+     * @private
+     * @param {Entity} entity - Entity to clear.
+     */
+    protected _clearEntity(entity: Entity): void;
+}
+type EntityCollectionEventList = [
+    "draw",
+    "drawend",
+    "add",
+    "remove",
+    "entityadd",
+    "entityremove",
+    "visibilitychange",
+    "mousemove",
+    "mouseenter",
+    "mouseleave",
+    "lclick",
+    "rclick",
+    "mclick",
+    "ldblclick",
+    "rdblclick",
+    "mdblclick",
+    "lup",
+    "rup",
+    "mup",
+    "ldown",
+    "rdown",
+    "mdown",
+    "lhold",
+    "rhold",
+    "mhold",
+    "mousewheel",
+    "touchmove",
+    "touchstart",
+    "touchend",
+    "doubletouch",
+    "touchleave",
+    "touchenter"
+];
+export { EntityCollection };