@xeokit/xeokit-sdk 2.6.107 → 2.6.108

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeokit/xeokit-sdk",
-  "version": "2.6.107",
+  "version": "2.6.108",
   "description": "3D BIM IFC Viewer SDK for AEC engineering applications. Open Source JavaScript Toolkit based on pure WebGL for top performance, real-world coordinates and full double precision",
   "module": "./dist/xeokit-sdk.es.js",
   "main": "./dist/xeokit-sdk.cjs.js",

package/src/plugins/lib/ui/index.js

@@ -312,10 +312,25 @@ export class Label3D {
         this.__visible = true;
 
         this._updatePos = () => {
-            toClipSpace(camera, this._start, tmpVec4a);
-            math.mulVec4Scalar(tmpVec4a, 1.0 / tmpVec4a[3]);
-            toCanvasSpace(scene.canvas.canvas, parentElement, tmpVec4a, tmpVec2a);
-            this._label.setPos(tmpVec2a[0], tmpVec2a[1]);
+            const p0 = tmpVec4a;
+            toClipSpace(camera, this._start, p0);
+            math.mulVec3Scalar(p0, 1.0 / p0[3]);
+
+            const outsideFrustum = ((p0[3] < 0)
+                                    ||
+                                    (p0[0] < -1) || (p0[0] > 1)
+                                    ||
+                                    (p0[1] < -1) || (p0[1] > 1)
+                                    ||
+                                    (p0[2] < -1) || (p0[2] > 1));
+            const culled = outsideFrustum || scene._sectionPlanesState.sectionPlanes.some(
+                plane => plane.active && (math.dotVec3(plane.dir, math.subVec3(plane.pos, this._start, tmpVec3a)) > 0));
+
+            this._label.setCulled(culled);
+            if (! culled) {
+                toCanvasSpace(scene.canvas.canvas, parentElement, p0, tmpVec2a);
+                this._label.setPos(tmpVec2a[0], tmpVec2a[1]);
+            }
         };
 
         const setPosOnWire = (p0, p1, yOff) => {

package/src/viewer/Viewer.js

@@ -491,6 +491,7 @@ class Viewer {
             const plugin = plugins[i];
             plugin.destroy();
         }
+        this.metaScene._destroy();
         this.scene.destroy();
     }
 }

package/src/viewer/metadata/MetaScene.js

@@ -149,6 +149,20 @@ class MetaScene {
         return metaModel;
     }
 
+    /**
+     * Destroys this MetaScene.
+     */
+    _destroy() {
+        this.viewer = null;
+        this.scene = null;
+        this.metaModels = {};
+        this.propertySets = {};
+        this.metaObjects = {};
+        this.metaObjectsByType = {};
+        this.rootMetaObjects = {};
+        this._eventSubs = {};
+    }
+
     /**
      * Removes a {@link MetaModel} from this MetaScene.
      *

package/types/extras/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./ContextMenu";
+export * from "./PointerCircle";
 export * from "./PointerLens";
 export * from "./MarqueePicker";
 export * from "./collision"

package/types/plugins/AnnotationsPlugin/AnnotationsPlugin.d.ts

@@ -117,34 +117,39 @@ export declare class AnnotationsPlugin extends Plugin {
    * Fires when a annotation is created.
    * @param {String} event The annotationCreated event
    * @param {Function} callback Callback fired on the event
+   * @returns {String} Subscription id
    */
-  on(event: "annotationCreated", callback: (annotationId: string)=> void): void;
+  on(event: "annotationCreated", callback: (annotationId: string)=> void): string;
 
   /**
    * Fires when a annotation is destroyed.
    * @param {String} event The annotationDestroyed event
    * @param {Function} callback Callback fired on the event
+   * @returns {String} Subscription id
    */
-  on(event: "annotationDestroyed", callback: (annotationId: string)=> void): void;
+  on(event: "annotationDestroyed", callback: (annotationId: string)=> void): string;
 
   /**
    * Fires when a mouse enters a annotation.
    * @param {String} event The markerMouseEnter event
    * @param {Function} callback Callback fired on the event
+   * @returns {String} Subscription id
    */
-   on(event: "markerMouseEnter", callback: (annotation: Annotation)=> void): void;
+   on(event: "markerMouseEnter", callback: (annotation: Annotation)=> void): string;
 
   /**
    * Fires when a mouse leave an annotation.
    * @param {String} event The markerMouseLeave event
    * @param {Function} callback Callback fired on the event
+   * @returns {String} Subscription id
    */
-  on(event: "markerMouseLeave", callback: (annotation: Annotation)=> void): void;
+  on(event: "markerMouseLeave", callback: (annotation: Annotation)=> void): string;
 
   /**
    * Fires when a mouse leave an annotation.
    * @param {String} event The markerClicked event
    * @param {Function} callback Callback fired on the event
+   * @returns {String} Subscription id
    */
-  on(event: "markerClicked", callback: (annotation: Annotation)=> void): void;
+  on(event: "markerClicked", callback: (annotation: Annotation)=> void): string;
 }

package/types/plugins/lib/ui/index.d.ts

@@ -1,5 +1,6 @@
 import { Viewer } from "../../../viewer";
 import { PointerCircle } from "../../../extras/PointerCircle";
+import { CameraControl } from "../../../viewer/scene/CameraControl/CameraControl";
 
 type Vec2 = number[]
 type Vec3 = number[]
@@ -12,4 +13,8 @@ type OnChange<T> = (canvasPos: Vec2, worldPos: T | null) => void;
 type OnCommit<T> = (canvasPos: Vec2, worldPos: T | null) => void;
 
 
-declare function touchPointSelector<T>(viewer: Viewer, pointerCircle: PointerCircle, ray2WorldPos: Ray2WorldPos<T>): (onCancel: OnCancel, onChange: OnChange<T>, onCommit: OnCommit<T>) => Cleanup;
+declare function touchPointSelector<T>(viewer: Viewer, pointerCircle: PointerCircle, ray2WorldPos: Ray2WorldPos<T>): (onCancel: OnCancel, onChange: OnChange<T>, onCommit: OnCommit<T>) => Cleanup;
+
+export declare addMousePressListener(element: HTMLElement, onChange: (canvasPos: Vec2 | null) => void);
+
+export declare addTouchPressListener(element: HTMLElement, cameraControl: CameraControl, pointerCircle: PointerCircle, onChange: (canvasPos: Vec2 | null) => void);

package/types/viewer/Plugin.d.ts

@@ -31,8 +31,15 @@ export declare abstract class Plugin {
      * Subscribes to an event fired at this Plugin.
      * @param {String} event The event
      * @param {Function} callback Callback fired on the event
+     * @returns {String} Subscription id
      */
-    on(event: string, callback: ()=> void): void;
+    on(event: string, callback: ()=> void): string;
+
+    /**
+     * Removes event subscription.
+     * @param {String} subId Subscription id
+     */
+    off(subId: string): void;
 
     /**
      * Fires an event at this Plugin.

package/types/viewer/scene/Entity.d.ts

@@ -14,6 +14,15 @@ export declare abstract class Entity {
    */
   get id(): string | number;
 
+  /**
+   * The SceneModel of the SceneModelEntity
+   *
+   * SceneModelEntity is the only Entity class at the moment, so every Entity is SceneModelEntity.
+   */
+  model: {
+    id?: string
+  }
+
   /**
    * ID of the corresponding object within the originating system, if any.
    *
@@ -399,6 +408,16 @@ export declare abstract class Entity {
    */
   getGeometryData(): {indices: number[],positions:number[]}
 
+  /**
+   * Gets volume of the entity.
+   */
+  get volume(): number;
+
+  /**
+   * Gets surface area of the entity.
+   */
+  get surfaceArea(): number;
+
   /**
    * Destroys this Entity.
    */

package/types/viewer/scene/input/input.d.ts

@@ -153,7 +153,7 @@ export declare class Input extends Component {
    * @param callback Called fired on the event
    * @param scope  Scope for the callback
    */
-  on(event: "mousedown" | "mouseup" | "mouseclicked" | "dblclick", callback: (canvasCoords: number[]) => void, scope?: any): string;
+  on(event: "mousedown" | "mouseup" | "mouseclicked" | "dblclick" | "mousemove", callback: (canvasCoords: number[]) => void, scope?: any): string;
 
    /**
    * Fires on keyboard events

package/types/viewer/scene/math/math.d.ts

@@ -50,12 +50,37 @@ declare const math: {
   /**
    * Normalizes a three-element vector
    */
-   normalizeVec3: (v: number[], dest?: any) => number[];
+  normalizeVec3: (v: number[], dest?: any) => number[];
 
-   /**
-     * Multiplies each element of a three-element vector by a scalar.
-     */
-   mulVec3Scalar: (v: number[], scalar: number, dest?: number[]) => number[];
+  /**
+   * Adds one three-element vector to another.
+   */
+  addVec3: (u: number[], v: number[], dest?: number[]) => number[];
+
+  /**
+   * Adds one three-element vector to another.
+   */
+  subVec3: (u: number[], v: number[], dest?: number[]) => number[];
+
+  /**
+   * Multiplies each element of a three-element vector by a scalar.
+   */
+  mulVec3Scalar: (v: number[], scalar: number, dest?: number[]) => number[];
+
+  /**
+   * Returns the cross product of two three-element vectors.
+   */
+  cross3Vec3: (u: number[], v: number[], dest?: number[]) => number[];
+
+  /**
+   * Multiplies the given 4x4 matrix by the given four-element vector.
+   */
+  mulMat4v4: (m: number[], v: number[], dest?: number[]) => number[];
+
+  /**
+   * Builds normal vectors from positions and indices.
+   */
+  buildNormals: (positions: number[], indices: number[], normals?: number) => number[];
 };
 
 export {math};

package/types/viewer/scene/scene/Scene.d.ts

@@ -89,6 +89,8 @@ export declare class Scene extends Component {
     */
    on(event: "sectionPlaneDestroyed", callback: (measurement: SectionPlane) => void): void;
 
+  canvas: Component;
+
   /**
    * The epoch time (in milliseconds since 1970) when this Scene was instantiated.
    */
@@ -715,6 +717,9 @@ export declare class Scene extends Component {
    * @param {Number[]} [params.origin] World-space ray origin when ray-picking. Ignored when canvasPos given.
    * @param {Number[]} [params.direction] World-space ray direction when ray-picking. Also indicates the length of the ray. Ignored when canvasPos given.
    * @param {Number[]} [params.matrix] 4x4 transformation matrix to define the World-space ray origin and direction, as an alternative to ````origin```` and ````direction````.
+   * @param {Number} [params.snapRadius=30] The snap radius, in canvas pixels.
+   * @param {boolean} [params.snapToEdge=true] Whether to snap to edge. Only works when `canvasPos` given.
+   * @param {boolean} [params.snapToVertex=true] Whether to snap to vertex. Only works when `canvasPos` given.
    * @param {String[]} [params.includeEntities] IDs of {@link Entity}s to restrict picking to. When given, ignores {@link Entity}s whose IDs are not in this list.
    * @param {String[]} [params.excludeEntities] IDs of {@link Entity}s to ignore. When given, will pick *through* these {@link Entity}s, as if they were not there.
    * @param {PickResult} [pickResult] Holds the results of the pick attempt. Will use the Scene's singleton PickResult if you don't supply your own.
@@ -728,6 +733,9 @@ export declare class Scene extends Component {
     origin?: number[];
     direction?: number[];
     matrix?: number[];
+    snapRadius?: number;
+    snapToEdge?: boolean;
+    snapToVertex?: boolean;
     includeEntities?: string[];
     excludeEntities?: string[];
   }, pickResult?: PickResult): PickResult | null;