@openglobus/og 0.11.2 → 0.11.7

package/src/og/entity/Entity.js

@@ -2,21 +2,22 @@
  * @module og/entity/Entity
  */
 
-'use strict';
-
-import * as mercator from '../mercator.js';
-import * as utils from '../utils/shared.js';
-import { Billboard } from './Billboard.js';
-import { Strip } from './Strip.js';
-import { Extent } from '../Extent.js';
-import { Geometry } from './Geometry.js';
-import { Label } from './Label.js';
-import { LonLat } from '../LonLat.js';
-import { Polyline } from './Polyline.js';
-import { Ray } from './Ray.js';
-import { PointCloud } from './PointCloud.js';
-import { Sphere } from '../shapes/Sphere.js';
-import { Vec3 } from '../math/Vec3.js';
+"use strict";
+
+import * as mercator from "../mercator.js";
+import * as utils from "../utils/shared.js";
+import { Billboard } from "./Billboard.js";
+import { Strip } from "./Strip.js";
+import { Extent } from "../Extent.js";
+import { Geometry } from "./Geometry.js";
+import { Label } from "./Label.js";
+import { LonLat } from "../LonLat.js";
+import { Polyline } from "./Polyline.js";
+import { Ray } from "./Ray.js";
+import { PointCloud } from "./PointCloud.js";
+import { Sphere } from "../shapes/Sphere.js";
+import { Vec3 } from "../math/Vec3.js";
+import { GeoObject } from "./GeoObject.js";
 
 /**
  * Entity instances aggregate multiple forms of visualization into a single high-level object.
@@ -25,7 +26,7 @@ import { Vec3 } from '../math/Vec3.js';
  * @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 {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.
@@ -41,7 +42,6 @@ import { Vec3 } from '../math/Vec3.js';
  */
 class Entity {
     constructor(options) {
-
         options = options || {};
 
         options.properties = options.properties || {};
@@ -70,21 +70,21 @@ class Entity {
         /**
          * Children entities.
          * @public
-         * @type {Array.<og.Entity>}
+         * @type {Array.<Entity>}
          */
         this.childrenNodes = [];
 
         /**
          * Parent entity.
          * @public
-         * @type {og.Entity}
+         * @type {Entity}
          */
         this.parent = null;
 
         /**
          * Entity cartesian position.
          * @protected
-         * @type {og.Vec3}
+         * @type {Vec3}
          */
         this._cartesian = utils.createVector3(options.cartesian);
 
@@ -119,7 +119,7 @@ class Entity {
         /**
          * Entity collection that this entity belongs to.
          * @protected
-         * @type {og.EntityCollection}
+         * @type {EntityCollection}
          */
         this._entityCollection = null;
 
@@ -133,7 +133,7 @@ class Entity {
         /**
          * Assigned vector layer pointer.
          * @protected
-         * @type {og.layer.Vector}
+         * @type {layer.Vector}
          */
         this._layer = null;
 
@@ -147,7 +147,7 @@ class Entity {
         /**
          * Picking color.
          * @protected
-         * @type {og.Vec3}
+         * @type {Vec3}
          */
         this._pickingColor = new Vec3(0, 0, 0);
 
@@ -159,6 +159,7 @@ class Entity {
             polyline: [Polyline, this.setPolyline],
             pointCloud: [PointCloud, this.setPointCloud],
             geometry: [Geometry, this.setGeometry],
+            geoObject: [GeoObject, this.setGeoObject],
             strip: [Strip, this.setStrip],
             ray: [Ray, this.setRay]
         };
@@ -166,58 +167,65 @@ class Entity {
         /**
          * Billboard entity.
          * @public
-         * @type {og.Billboard}
+         * @type {Billboard}
          */
-        this.billboard = this._createOptionFeature('billboard', options.billboard);
+        this.billboard = this._createOptionFeature("billboard", options.billboard);
 
         /**
          * Text label entity.
          * @public
-         * @type {og.Label}
+         * @type {Label}
          */
-        this.label = this._createOptionFeature('label', options.label);
+        this.label = this._createOptionFeature("label", options.label);
 
         /**
          * Shape entity.
          * @public
-         * @type {og.shape.BaseShape}
+         * @type {shape.BaseShape}
          */
-        this.shape = this._createOptionFeature('sphere', options.sphere || options.box);
+        this.shape = this._createOptionFeature("sphere", options.sphere || options.box);
 
         /**
          * Polyline entity.
          * @public
-         * @type {og.Polyline}
+         * @type {Polyline}
          */
-        this.polyline = this._createOptionFeature('polyline', options.polyline);
+        this.polyline = this._createOptionFeature("polyline", options.polyline);
 
         /**
          * Ray entity.
          * @public
-         * @type {og.ray}
+         * @type {ray}
          */
-        this.ray = this._createOptionFeature('ray', options.ray);
+        this.ray = this._createOptionFeature("ray", options.ray);
 
         /**
          * PointCloud entity.
          * @public
-         * @type {og.PointCloud}
+         * @type {PointCloud}
          */
-        this.pointCloud = this._createOptionFeature('pointCloud', options.pointCloud);
+        this.pointCloud = this._createOptionFeature("pointCloud", options.pointCloud);
 
         /**
          * Geometry entity(available for vector layer only).
          * @public
+         * @type {Geometry}
+         */
+        this.geometry = this._createOptionFeature("geometry", options.geometry);
+
+        /**
+         * Geo object entity
+         * @public
          * @type {og.Geometry}
          */
-        this.geometry = this._createOptionFeature('geometry', options.geometry);
+        this.geoObject = this._createOptionFeature("geoObject", options.geoObject);
 
         /**
          * Strip entity.
          * @public
-         * @type {og.Strip}
+         * @type {Strip}
          */
-        this.strip = this._createOptionFeature('strip', options.strip);
+        this.strip = this._createOptionFeature("strip", options.strip);
     }
 
     static get _staticCounter() {
@@ -250,9 +258,9 @@ class Entity {
     /**
      * Adds current entity into the specified entity collection.
      * @public
-     * @param {og.EntityCollection|og.layer.Vector} collection - Specified entity collection or vector layer.
+     * @param {EntityCollection|Vector} collection - Specified entity collection or vector layer.
      * @param {Boolean} [rightNow=false] - Entity insertion option for vector layer.
-     * @returns {og.Entity} - This object.
+     * @returns {Entity} - This object.
      */
     addTo(collection, rightNow) {
         collection.add(this, rightNow);
@@ -279,6 +287,9 @@ class Entity {
         // billboards
         this.billboard && this.billboard.setVisibility(visibility);
 
+        // billboards
+        this.geoObject && this.geoObject.setVisibility(visibility);
+
         // labels
         this.label && this.label.setVisibility(visibility);
 
@@ -311,7 +322,7 @@ class Entity {
     /**
      * Sets entity cartesian position.
      * @public
-     * @param {og.Vec3} cartesian - Cartesian position in 3d space.
+     * @param {Vec3} cartesian - Cartesian position in 3d space.
      */
     setCartesian3v(cartesian) {
         this.setCartesian(cartesian.x, cartesian.y, cartesian.z);
@@ -325,7 +336,6 @@ class Entity {
      * @param {number} z - 3d space Z - position.
      */
     setCartesian(x, y, z) {
-
         var p = this._cartesian;
 
         p.x = x;
@@ -335,6 +345,9 @@ class Entity {
         // billboards
         this.billboard && this.billboard.setPosition3v(p);
 
+        // geoObject
+        this.geoObject && this.geoObject.setPosition3v(p);
+
         // labels
         this.label && this.label.setPosition3v(p);
 
@@ -348,7 +361,6 @@ class Entity {
         var ec = this._entityCollection;
 
         if (ec && ec.renderNode && ec.renderNode.ellipsoid) {
-
             this._lonlat = ec.renderNode.ellipsoid.cartesianToLonLat(p);
 
             if (Math.abs(this._lonlat.lat) < mercator.MAX_LAT) {
@@ -364,11 +376,10 @@ class Entity {
     /**
      * Sets entity cartesian position without event dispatching.
      * @protected
-     * @param {og.Vec3} cartesian - Cartesian position in 3d space.
+     * @param {Vec3} cartesian - Cartesian position in 3d space.
      * @param {boolean} skipLonLat - skip geodetic calculation.
      */
     _setCartesian3vSilent(cartesian, skipLonLat) {
-
         var p = this._cartesian;
 
         p.x = cartesian.x;
@@ -378,6 +389,9 @@ class Entity {
         // billboards
         this.billboard && this.billboard.setPosition3v(p);
 
+        // geoObject
+        this.geoObject && this.geoObject.setPosition3v(p);
+
         // labels
         this.label && this.label.setPosition3v(p);
 
@@ -385,13 +399,12 @@ class Entity {
         this.shape && this.shape.setPosition3v(p);
 
         for (var i = 0; i < this.childrenNodes.length; i++) {
-            this.childrenNodes[i].setCartesian(x, y, z);
+            this.childrenNodes[i].setCartesian(p.x, p.y, p.z);
         }
 
         var ec = this._entityCollection;
 
         if (!skipLonLat && ec && ec.renderNode && ec.renderNode.ellipsoid) {
-
             this._lonlat = ec.renderNode.ellipsoid.cartesianToLonLat(p);
 
             if (Math.abs(this._lonlat.lat) < mercator.MAX_LAT) {
@@ -425,7 +438,6 @@ class Entity {
 
         var ec = this._entityCollection;
         if (ec && ec.renderNode && ec.renderNode.ellipsoid) {
-
             if (Math.abs(lonlat.lat) < mercator.MAX_LAT) {
                 this._lonlatMerc = lonlat.forwardMercator();
             } else {
@@ -458,7 +470,7 @@ class Entity {
     /**
      * Returns carteain position.
      * @public
-     * @returns {og.Vec3} -
+     * @returns {Vec3} -
      */
     getCartesian() {
         return this._cartesian.clone();
@@ -467,8 +479,8 @@ class Entity {
     /**
      * Sets entity billboard.
      * @public
-     * @param {og.Billboard} billboard - Billboard object.
-     * @returns {og.Billboard} -
+     * @param {Billboard} billboard - Billboard object.
+     * @returns {Billboard} -
      */
     setBillboard(billboard) {
         if (this.billboard) {
@@ -485,8 +497,8 @@ class Entity {
     /**
      * Sets entity label.
      * @public
-     * @param {og.Label} label - Text label.
-     * @returns {og.Label} -
+     * @param {Label} label - Text label.
+     * @returns {Label} -
      */
     setLabel(label) {
         if (this.label) {
@@ -503,8 +515,8 @@ class Entity {
     /**
      * Sets entity ray.
      * @public
-     * @param {og.Ray} ray - Ray object.
-     * @returns {og.Ray} -
+     * @param {Ray} ray - Ray object.
+     * @returns {Ray} -
      */
     setRay(ray) {
         if (this.ray) {
@@ -520,8 +532,8 @@ class Entity {
     /**
      * Sets entity shape.
      * @public
-     * @param {og.BaseShape} shape - Shape object.
-     * @returns {og.Polyline} -
+     * @param {BaseShape} shape - Shape object.
+     * @returns {Polyline} -
      */
     setShape(shape) {
         if (this.shape) {
@@ -538,8 +550,8 @@ class Entity {
     /**
      * Sets entity polyline.
      * @public
-     * @param {og.Polyline} polyline - Polyline object.
-     * @returns {og.Polyline} -
+     * @param {Polyline} polyline - Polyline object.
+     * @returns {Polyline} -
      */
     setPolyline(polyline) {
         if (this.polyline) {
@@ -555,8 +567,8 @@ class Entity {
     /**
      * Sets entity pointCloud.
      * @public
-     * @param {og.PointCloud} pointCloud - PointCloud object.
-     * @returns {og.PointCloud} -
+     * @param {PointCloud} pointCloud - PointCloud object.
+     * @returns {PointCloud} -
      */
     setPointCloud(pointCloud) {
         if (this.pointCloud) {
@@ -572,8 +584,8 @@ class Entity {
     /**
      * Sets entity geometry.
      * @public
-     * @param {og.Geometry} geometry - Geometry object.
-     * @returns {og.Geometry} -
+     * @param {Geometry} geometry - Geometry object.
+     * @returns {Geometry} -
      */
     setGeometry(geometry) {
         if (this.geometry) {
@@ -586,11 +598,29 @@ class Entity {
         return geometry;
     }
 
+    /**
+     * Sets entity geoObject.
+     * @public
+     * @param {GeoObject} geoObject - GeoObject.
+     * @returns {GeoObject} -
+     */
+    setGeoObject(geoObject) {
+        if (this.geoObject) {
+            this.geoObject.remove();
+        }
+        this.geoObject = geoObject;
+        this.geoObject._entity = this;
+        this.geoObject.setPosition3v(this._cartesian);
+        this.geoObject.setVisibility(this._visibility);
+        this._entityCollection && this._entityCollection._geoObjectHandler.add(geoObject);
+        return geoObject;
+    }
+
     /**
      * Sets entity strip.
      * @public
-     * @param {og.Strip} strip - Strip object.
-     * @returns {og.Strip} -
+     * @param {Strip} strip - Strip object.
+     * @returns {Strip} -
      */
     setStrip(strip) {
         if (this.strip) {
@@ -613,12 +643,13 @@ class Entity {
         } else if (this._entityCollection) {
             return this._entityCollection.events;
         }
+        return null;
     }
 
     /**
      * Append child entity.
      * @public
-     * @param {og.Entity} entity - Child entity.
+     * @param {Entity} entity - Child entity.
      */
     appendChild(entity) {
         entity._entityCollection = this._entityCollection;
@@ -633,7 +664,6 @@ class Entity {
      * @public
      */
     setPickingColor() {
-
         var c = this._pickingColor;
 
         // billboard
@@ -654,6 +684,8 @@ class Entity {
         // strip
         this.strip && this.strip.setPickingColor3v(c);
 
+        // billboard
+        this.geoObject && this.geoObject.setPickingColor3v(c);
         for (var i = 0; i < this.childrenNodes.length; i++) {
             this.childrenNodes[i].setPickingColor();
         }
@@ -661,7 +693,7 @@ class Entity {
 
     /**
      * Return geodethic extent.
-     * @returns {og.Extent} -
+     * @returns {Extent} -
      */
     getExtent() {
         var res;