@openglobus/og 0.22.1 → 0.23.0

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

@@ -5,7 +5,7 @@ import { Ellipsoid } from "../ellipsoid/Ellipsoid";
 import { EntityCollectionNode } from "../quadTree/EntityCollectionNode";
 import { GeoObjectHandler } from "./GeoObjectHandler";
 import { LabelHandler } from "./LabelHandler";
-import { NumberArray3 } from "../math/Vec3";
+import { Vec3, NumberArray3 } from "../math/Vec3";
 import { PointCloudHandler } from "./PointCloudHandler";
 import { PolylineHandler } from "./PolylineHandler";
 import { RayHandler } from "./RayHandler";
@@ -23,6 +23,7 @@ interface IEntityCollectionParams {
     opacity?: number;
     useLighting?: boolean;
     entities?: Entity[];
+    depthOrder?: number;
 }
 /**
  * An observable collection of og.Entity instances where each entity has a unique id.
@@ -80,12 +81,6 @@ declare class EntityCollection {
      * @readonly
      */
     protected __id: number;
-    /**
-     * Render node collections array index.
-     * @protected
-     * @type {number}
-     */
-    protected _renderNodeIndex: number;
     /**
      * Render node context.
      * @public
@@ -186,12 +181,15 @@ declare class EntityCollection {
     _layer?: Vector;
     _quadNode?: EntityCollectionNode;
     _useLighting: number;
+    protected _depthOrder: number;
     constructor(options?: IEntityCollectionParams);
+    get depthOrder(): number;
+    set depthOrder(depghOrder: number);
     isEmpty(): boolean;
     get id(): number;
     get useLighting(): boolean;
     set useLighting(f: boolean);
-    isEqual(ec: EntityCollection): boolean;
+    isEqual(ec: EntityCollection | null): boolean;
     /**
      * Sets collection visibility.
      * @public
@@ -252,7 +250,7 @@ declare class EntityCollection {
      * @param {Entity} entity - Entity.
      * @returns {boolean} -
      */
-    belongs(entity: Entity): boolean | null;
+    belongs(entity: Entity): boolean;
     protected _removeRecursively(entity: Entity): void;
     /**
      * Removes entity from this collection.
@@ -286,6 +284,7 @@ declare class EntityCollection {
      * @param {RenderNode} renderNode
      */
     bindRenderNode(renderNode: RenderNode): void;
+    protected _onChangeRelativeCenter: (c: Vec3) => void;
     /**
      * Updates coordinates all lonLat entities in collection after collection attached to the planet node.
      * @protected

package/lib/js/entity/EntityCollection.js

@@ -57,8 +57,11 @@ import { StripHandler } from "./StripHandler";
  */
 class EntityCollection {
     constructor(options = {}) {
+        this._onChangeRelativeCenter = (c) => {
+            this.geoObjectHandler.setRelativeCenter(c);
+            this.polylineHandler.setRelativeCenter(c);
+        };
         this.__id = EntityCollection.__counter__++;
-        this._renderNodeIndex = -1;
         this.renderNode = null;
         this._visibility = options.visibility == undefined ? true : options.visibility;
         this.polygonOffsetUnits =
@@ -74,7 +77,7 @@ class EntityCollection {
             this.setPickingEnabled(options.pickingEnabled);
         }
         this._entities = [];
-        this.scaleByDistance = options.scaleByDistance || [math.MAX32, math.MAX32, math.MAX32];
+        this.scaleByDistance = options.scaleByDistance || [1.0, 1.0, 1.0];
         let pickingScale = new Float32Array([1.0, 1.0, 1.0]);
         if (options.pickingScale !== undefined) {
             if (options.pickingScale instanceof Array) {
@@ -88,6 +91,7 @@ class EntityCollection {
                 pickingScale[2] = options.pickingScale;
             }
         }
+        this._depthOrder = options.depthOrder || 0;
         this.pickingScale = pickingScale;
         this._opacity = options.opacity == undefined ? 1.0 : options.opacity;
         this._fadingOpacity = this._opacity;
@@ -98,6 +102,15 @@ class EntityCollection {
             this.addEntities(options.entities);
         }
     }
+    get depthOrder() {
+        return this._depthOrder;
+    }
+    set depthOrder(depghOrder) {
+        this._depthOrder = depghOrder;
+        if (this.renderNode) {
+            this.renderNode.updateEntityCollectionsDepthOrder();
+        }
+    }
     isEmpty() {
         return this._entities.length == 0;
     }
@@ -111,7 +124,7 @@ class EntityCollection {
         this._useLighting = Number(f);
     }
     isEqual(ec) {
-        return this.__id === ec.__id;
+        return ec !== null && (this.__id === ec.__id);
     }
     /**
      * Sets collection visibility.
@@ -121,6 +134,7 @@ class EntityCollection {
     setVisibility(visibility) {
         this._visibility = visibility;
         this._fadingOpacity = this._opacity * (visibility ? 1 : 0);
+        this.renderNode?.updateEntityCollectionsDepthOrder();
         this.events.dispatch(this.events.visibilitychange, this);
     }
     /**
@@ -177,6 +191,24 @@ class EntityCollection {
         this._addRecursively(entity);
     }
     _addRecursively(entity) {
+        let rn = this.renderNode;
+        if (rn) {
+            if (entity._independentPicking || !entity.parent) {
+                if (rn) {
+                    rn.renderer && rn.renderer.assignPickingColor(entity);
+                }
+            }
+            else {
+                entity._pickingColor = entity.parent._pickingColor;
+            }
+            rn.renderer && rn.renderer.assignPickingColor(entity);
+            if (rn.ellipsoid && entity._cartesian.isZero()) {
+                entity.setCartesian3v(rn.ellipsoid.lonLatToCartesian(entity._lonLat));
+            }
+        }
+        entity.setPickingColor();
+        entity._updateAbsolutePosition();
+        entity.setScale3v(entity.getScale());
         // billboard
         entity.billboard && this.billboardHandler.add(entity.billboard);
         // label
@@ -192,19 +224,10 @@ class EntityCollection {
         //geoObject
         entity.geoObject && this.geoObjectHandler.add(entity.geoObject);
         this.events.dispatch(this.events.entityadd, entity);
-        let rn = this.renderNode;
-        for (let i = 0; i < entity.childrenNodes.length; i++) {
-            entity.childrenNodes[i]._entityCollection = this;
-            entity.childrenNodes[i]._entityCollectionIndex = entity._entityCollectionIndex;
-            if (entity.childrenNodes[i]._independentPicking) {
-                if (rn) {
-                    rn.renderer && rn.renderer.assignPickingColor(entity.childrenNodes[i]);
-                }
-            }
-            else {
-                entity.childrenNodes[i]._pickingColor = entity._pickingColor;
-            }
-            this._addRecursively(entity.childrenNodes[i]);
+        for (let i = 0; i < entity.childEntities.length; i++) {
+            entity.childEntities[i]._entityCollection = this;
+            entity.childEntities[i]._entityCollectionIndex = entity._entityCollectionIndex;
+            this._addRecursively(entity.childEntities[i]);
         }
     }
     /**
@@ -218,15 +241,7 @@ class EntityCollection {
             entity._entityCollection = this;
             entity._entityCollectionIndex = this._entities.length;
             this._entities.push(entity);
-            let rn = this.renderNode;
-            if (rn) {
-                rn.renderer && rn.renderer.assignPickingColor(entity);
-                if (rn.ellipsoid && entity._cartesian.isZero()) {
-                    entity.setCartesian3v(rn.ellipsoid.lonLatToCartesian(entity._lonLat));
-                }
-            }
             this._addRecursively(entity);
-            entity.setPickingColor();
         }
         return this;
     }
@@ -249,7 +264,7 @@ class EntityCollection {
      * @returns {boolean} -
      */
     belongs(entity) {
-        return entity._entityCollection && this._renderNodeIndex === entity._entityCollection._renderNodeIndex;
+        return this.isEqual(entity._entityCollection);
     }
     _removeRecursively(entity) {
         entity._entityCollection = null;
@@ -268,8 +283,8 @@ class EntityCollection {
         entity.strip && this.stripHandler.remove(entity.strip);
         // geoObject
         entity.geoObject && this.geoObjectHandler.remove(entity.geoObject);
-        for (let i = 0; i < entity.childrenNodes.length; i++) {
-            this._removeRecursively(entity.childrenNodes[i]);
+        for (let i = 0; i < entity.childEntities.length; i++) {
+            this._removeRecursively(entity.childEntities[i]);
         }
     }
     /**
@@ -337,14 +352,7 @@ class EntityCollection {
      */
     addTo(renderNode, isHidden = false) {
         if (!this.renderNode) {
-            this.renderNode = renderNode;
-            if (!isHidden) {
-                this._renderNodeIndex = renderNode.entityCollections.length;
-                renderNode.entityCollections.push(this);
-            }
-            renderNode.ellipsoid && this._updateGeodeticCoordinates(renderNode.ellipsoid);
-            this.bindRenderNode(renderNode);
-            this.events.dispatch(this.events.add, this);
+            renderNode.addEntityCollection(this, isHidden);
         }
         return this;
     }
@@ -362,6 +370,7 @@ class EntityCollection {
             this.polylineHandler.setRenderNode(renderNode);
             this.pointCloudHandler.setRenderNode(renderNode);
             this.stripHandler.setRenderNode(renderNode);
+            renderNode.renderer.events.on("changerelativecenter", this._onChangeRelativeCenter);
             this.updateBillboardsTextureAtlas();
             this.updateLabelsFontAtlas();
             this.createPickingColors();
@@ -410,15 +419,9 @@ class EntityCollection {
      */
     remove() {
         if (this.renderNode) {
-            if (this._renderNodeIndex !== -1) {
-                this.renderNode.entityCollections.splice(this._renderNodeIndex, 1);
-                // reindex in the renderNode
-                for (let i = this._renderNodeIndex; i < this.renderNode.entityCollections.length; i++) {
-                    this.renderNode.entityCollections[i]._renderNodeIndex = i;
-                }
-            }
+            this.renderNode.removeEntityCollection(this);
+            this.renderNode.renderer?.events.off("changerelativecenter", this._onChangeRelativeCenter);
             this.renderNode = null;
-            this._renderNodeIndex = -1;
             this.events.dispatch(this.events.remove, this);
         }
     }
@@ -476,8 +479,8 @@ class EntityCollection {
     _clearEntity(entity) {
         entity._entityCollection = null;
         entity._entityCollectionIndex = -1;
-        for (let i = 0; i < entity.childrenNodes.length; i++) {
-            this._clearEntity(entity.childrenNodes[i]);
+        for (let i = 0; i < entity.childEntities.length; i++) {
+            this._clearEntity(entity.childEntities[i]);
         }
     }
 }

package/lib/js/entity/GeoObject.d.ts

@@ -1,13 +1,29 @@
 import { Entity } from "./Entity";
 import { Quat, Vec3, Vec4 } from "../math/index";
-import { GeoObjectHandler, InstanceData } from "./GeoObjectHandler";
+import { GeoObjectHandler } from "./GeoObjectHandler";
+import { InstanceData } from "./InstanceData";
 import { NumberArray3 } from "../math/Vec3";
 import { NumberArray4 } from "../math/Vec4";
 import { Object3d } from "../Object3d";
+export declare const LOCAL_FORWARD: Vec3;
+/**
+ * Interface for GeoObject parameters.
+ * @typedef {Object} IGeoObjectParams
+ * @property {Object3d} [object3d] - 3D object associated with the geo object.
+ * @property {string} [objSrc] - Source url of the 3D object.
+ * @property {string} [tag] - Unique instancing drawing identifier tag.
+ * @property {Vec3 | NumberArray3} [position] - Position in Cartesian coordinates.
+ * @property {number} [pitch] - Rotation around X-axis in degrees.
+ * @property {number} [yaw] - Rotation around Y-axis in degrees.
+ * @property {number} [roll] - Rotation around Z-axis in degrees.
+ * @property {number | Vec3 | NumberArray3} [scale] - Scale of the object.
+ * @property {Vec3 | NumberArray3} [translate] - Translation offset.
+ * @property {Vec4 | NumberArray4 | string} [color] - RGBA color or HTML color string.
+ * @property {boolean} [visibility] - Visibility flag.
+ */
 export interface IGeoObjectParams {
     object3d?: Object3d;
     objSrc?: string;
-    textureSrc?: string;
     tag?: string;
     position?: Vec3 | NumberArray3;
     pitch?: number;
@@ -19,16 +35,27 @@ export interface IGeoObjectParams {
     visibility?: boolean;
 }
 /**
+ * Represents 3D object on the the globe or 3d space
  * @class
- * @param {Object} options -  Geo object parameters:
- * @param {Vec3} [options.position] - Geo object position.
+ * @param {IGeoObjectParams} options -  Geo object parameters:
+ * @param {Object3d} [options.object3d] - 3D object associated with the geo object.
+ * @param {string} [options.objSrc] - Source url of the 3D object.
+ * @param {string} [options.tag] - Unique instancing drawing identifier tag.
+ * @param {Vec3 | NumberArray3} [options.position] - Position in Cartesian coordinates.
+ * @param {number} [options.pitch=0] - Rotation around X-axis in degrees.
+ * @param {number} [options.yaw=0] - Rotation around Y-axis in degrees.
+ * @param {number} [options.roll=0] - Rotation around Z-axis in degrees.
+ * @param {number | Vec3 | NumberArray3} [options.scale=1] - Scale of the object.
+ * @param {Vec3 | NumberArray3} [options.translate] - Translation offset.
+ * @param {Vec4 | NumberArray4 | string} [options.color] - RGBA color or HTML color string.
+ * @param {boolean} [options.visibility=true] - Visibility flag.
  *
  * @todo: GeoObject and GeoObjectHandler provides instanced objects only.
  * It would be nice if it could provide not instanced rendering loop too.
  */
 declare class GeoObject {
     protected _tag: string;
-    instanced: boolean;
+    static __counter__: number;
     /**
      * Entity instance that holds this geo object.
      * @public
@@ -41,22 +68,18 @@ declare class GeoObject {
      * @type {Vec3}
      */
     protected _position: Vec3;
-    _positionHigh: Vec3;
-    _positionLow: Vec3;
-    protected _pitch: number;
-    protected _yaw: number;
-    protected _roll: number;
-    protected _pitchRad: number;
-    protected _yawRad: number;
-    protected _rollRad: number;
+    _rtcPositionHigh: Vec3;
+    _rtcPositionLow: Vec3;
     protected _scale: Vec3;
     protected _translate: Vec3;
+    protected _localPosition: Vec3;
     /**
      * RGBA color.
      * @public
      * @type {Vec4}
      */
     _color: Vec4;
+    protected _qFrame: Quat;
     _qRot: Quat;
     protected _direction: Vec3;
     _handler: GeoObjectHandler | null;
@@ -64,35 +87,67 @@ declare class GeoObject {
     _tagData: InstanceData | null;
     _tagDataIndex: number;
     protected _object3d: Object3d;
-    protected _visibility: boolean;
-    protected _qNorthFrame: Quat;
-    private _textureSrc?;
     _objectSrc?: string;
+    protected _visibility: boolean;
     protected _children: GeoObject[];
     constructor(options: IGeoObjectParams);
+    /**
+     * Gets the unique tag of the geo object.
+     * @returns {string}
+     */
     get tag(): string;
+    /**
+     * Gets the position of the geo object.
+     * @public
+     * @returns {Vec3}
+     */
     getPosition(): Vec3;
-    getPitch(): number;
-    getYaw(): number;
-    getRoll(): number;
+    /**
+     * Gets the 3D object associated with this geo object.
+     * @public
+     * @returns {Object3d}
+     */
     get object3d(): Object3d;
+    /**
+     * Gets geometry mesh vertices.
+     * @public
+     * @returns {number[]}
+     */
     get vertices(): number[];
+    /**
+     * Gets geometry mesh normals.
+     * @public
+     * @returns {number[]}
+     */
     get normals(): number[];
+    /**
+     * Gets geometry mesh texture coordinates.
+     * @public
+     * @returns {number[]}
+     */
     get texCoords(): number[];
-    get indices(): number[];
     /**
-     * Sets geo object opacity.
+     * Gets geometry mesh indices.
      * @public
-     * @param {number} a - Billboard opacity.
+     * @returns {number[]}
+     */
+    get indices(): number[];
+    /**
+     * Sets the opacity of the geo object.
+     * @param {number} a - Opacity value (0 to 1).
      */
     setOpacity(a: number): void;
     /**
-     * Sets color.
-     * @public
-     * @param {number} r - Red.
-     * @param {number} g - Green.
-     * @param {number} b - Blue.
-     * @param {number} [a] - Alpha.
+     * Gets the opacity of the geo object.
+     * @returns {number}
+     */
+    getOpacity(): number;
+    /**
+     * Sets the color of the geo object.
+     * @param {number} r - Red component.
+     * @param {number} g - Green component.
+     * @param {number} b - Blue component.
+     * @param {number} [a] - Alpha component.
      */
     setColor(r: number, g: number, b: number, a?: number): void;
     /**
@@ -121,31 +176,61 @@ declare class GeoObject {
      * @param {number} z - Z coordinate.
      */
     setPosition(x: number, y: number, z: number): void;
+    updateRTCPosition(): void;
     /**
      * Sets geo object position.
      * @public
      * @param {Vec3} position - Cartesian coordinates.
      */
     setPosition3v(position: Vec3): void;
-    setYaw(yaw: number): void;
+    /**
+     * Sets Object3d for the object
+     * @param {Object3d} object
+     */
     setObject(object: Object3d): void;
+    /**
+     * Sets the object url source.
+     * @param {string} src
+     */
     setObjectSrc(src: string): void;
-    setTextureSrc(src: string): void;
+    /**
+     * Sets object HTML color.
+     * @param {string} color
+     */
     setColorHTML(color: string): void;
     /**
-     *
-     * @param {number} pitch - Pitch in radians
+     * Sets scales.
+     * @public
+     * @param {number} scale
      */
-    setPitch(pitch: number): void;
-    setRoll(roll: number): void;
-    setPitchYawRoll(pitch: number, yaw: number, roll: number): void;
     setScale(scale: number): void;
+    /**
+     * Sets X, Y, Z axis scales
+     * @public
+     * @param {Vec3} scale
+     */
     setScale3v(scale: Vec3): void;
+    /**
+     * Gets scale.
+     * @publci
+     * @returns {Vec3}
+     */
     getScale(): Vec3;
     setTranslate3v(translate: Vec3): void;
     getTranslate(): Vec3;
     /**
-     * Removes geo object from handler.
+     * Sets local offset position.
+     * @param {Vec3} localPosition
+     */
+    setLocalPosition3v(localPosition: Vec3): void;
+    /**
+     * Gets local offset position.
+     * @public
+     * @returns {Vec3}
+     */
+    getLocalPosition(): Vec3;
+    /**
+     * Removes the geo object from the handler.
      * @public
      */
     remove(): void;
@@ -155,7 +240,27 @@ declare class GeoObject {
      * @param {Vec3} color - Picking color.
      */
     setPickingColor3v(color: Vec3): void;
+    /**
+     * Sets the rotation quaternion.
+     * @public
+     * @param {Quat} qRot - Rotation quaternion.
+     */
+    setRotation(qRot: Quat): void;
+    /**
+     * Returns orientation quaternion.
+     * @public
+     * @returns {Quat}
+     */
+    getRotation(): Quat;
+    /**
+     * Update object rotation
+     */
     updateRotation(): void;
+    /**
+     * Returns object direction
+     * @publcu
+     * @returns {Vec3}
+     */
     getDirection(): Vec3;
 }
 export { GeoObject };