@xtctwins/tctwins-core 1.0.6 → 1.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xtctwins/tctwins-core",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "private": false,
   "description": "Web Programming Toolkit for 3D/2D BIM and CAD",
   "module": "./dist/tctwins-core.es.js",

package/types/extras/ContextMenu/ContextMenu.d.ts

@@ -7,6 +7,8 @@ export declare type ContextMenuConfiguration = {
   enabled?: boolean;
   /** Whether this ````ContextMenu```` automatically hides whenever we mouse-down or tap anywhere in the page. */
   hideOnMouseDown?: boolean;
+  /** Whether this ````ContextMenu```` automatically hides after we select a menu item. Se false if we want the menu to remain shown and show any updates to its item titles, after we've selected an item. */
+  hideOnAction?: boolean;
 };
 
 /**

package/types/plugins/AngleMeasurementsPlugin/AngleMeasurement.d.ts

@@ -11,7 +11,7 @@ export declare class AngleMeasurement extends Component {
    * @type {AngleMeasurementsPlugin}
    */
   plugin: AngleMeasurementsPlugin;
-  
+
   /**
    * Sets whether this AngleMeasurement indicates that its measurement is approximate.
    *
@@ -28,6 +28,7 @@ export declare class AngleMeasurement extends Component {
    * @type {Boolean}
    */
   get approximate(): boolean;
+
   /**
    * Sets whether this AngleMeasurement is visible or not.
    *
@@ -112,7 +113,41 @@ export declare class AngleMeasurement extends Component {
    * @type {Boolean}
    */
   get angleVisible(): boolean;
-  
+
+  /**
+   * Sets if the labels are visible.
+   *
+   * @type {Boolean}
+   */
+  set labelsVisible(value: Boolean);
+
+  /**
+   * Gets if the labels are visible.
+   *
+   * @type {Boolean}
+   */
+  get labelsVisible();
+
+  /**
+   * Sets if this DistanceMeasurement appears highlighted.
+   * @param highlighted
+   */
+  setHighlighted(highlighted: Boolean): any;
+
+  /**
+   * Sets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events.
+   *
+   * @type {Boolean}
+   */
+  set clickable(value: Boolean);
+
+  /**
+   * Gets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events.
+   *
+   * @type {Boolean}
+   */
+  get clickable();
+
   /**
    * Gets the origin {@link Marker}.
    *
@@ -141,4 +176,21 @@ export declare class AngleMeasurement extends Component {
    * @type {Number}
    */
   get angle(): number;
-}
+
+  /**
+   * Gets the color of the angle measurement.
+   *
+   * The color is an HTML string representation, eg. "#00BBFF" and "blue".
+   *
+   * @type {String}
+   */
+  get color(): string;
+
+  /** Sets the color of the angle measurement.
+   *
+   * The color is given as an HTML string representation, eg. "#00BBFF" and "blue".
+   *
+   * @type {String}
+   */
+  set color(value);
+}

package/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurement.d.ts

@@ -72,6 +72,23 @@ export declare class DistanceMeasurement extends Component {
    */
   get targetVisible(): boolean;
 
+  /**
+   * Sets if the axis-aligned wires between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} are enabled.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  set axisEnabled(value: boolean);
+
+  /**
+   * Gets if the axis-aligned wires between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} are enabled.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  get axisEnabled();
   /**
    * Sets if the direct point-to-point wire between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target} is visible.
    *
@@ -100,20 +117,108 @@ export declare class DistanceMeasurement extends Component {
    */
   get axisVisible(): boolean;
 
+  /**
+   * Sets if the X-axis-aligned wire between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} is visible.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  set xAxisVisible(value: boolean);
+
+  /**
+   * Gets if the X-axis-aligned wires between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} are visible.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  get xAxisVisible();
+
+  /**
+   * Sets if the Y-axis-aligned wire between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} is visible.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  set yAxisVisible(value: boolean);
+
+  /**
+   * Gets if the Y-axis-aligned wires between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} are visible.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  get yAxisVisible();
+
+  /**
+   * Sets if the Z-axis-aligned wire between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} is visible.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  set zAxisVisible(value: boolean);
+
+  /**
+   * Gets if the Z-axis-aligned wires between {@link DistanceMeasurement#origin} and {@link DistanceMeasurement#target} are visible.
+   *
+   * Wires are only shown if enabled and visible.
+   *
+   * @type {Boolean}
+   */
+  get zAxisVisible();
+
+  /**
+   * Sets if the labels are visible.
+   *
+   * @type {Boolean}
+   */
+  set labelsVisible(value: boolean);
+
+  /**
+   * Gets if the labels are visible.
+   *
+   * @type {Boolean}
+   */
+  get labelsVisible();
+
+  /**
+   * Sets if this DistanceMeasurement appears highlighted.
+   * @param highlighted
+   */
+  setHighlighted(highlighted: boolean): any;
+
+  /**
+   * Sets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events, or ignore mouse events altogether.
+   *
+   * @type {Boolean}
+   */
+  set clickable(value: boolean);
+
+  /**
+   * Gets if the wires, dots ad labels will fire "mouseOver" "mouseLeave" and "contextMenu" events.
+   *
+   * @type {Boolean}
+   */
+  get clickable();
+
   /**
    * Gets the origin {@link Marker}.
    *
    * @type {Marker}
    */
   get origin(): Marker;
-  
+
   /**
    * Gets the target {@link Marker}.
    *
    * @type {Marker}
    */
   get target(): Marker;
-  
+
   /**
    * Gets the World-space direct point-to-point distance between {@link DistanceMeasurement.origin} and {@link DistanceMeasurement.target}.
    *

package/types/plugins/FastNavPlugin/FastNavPlugin.d.ts

@@ -4,6 +4,8 @@ import { Viewer } from "../../viewer/Viewer";
 export declare type FastNavPluginConfiguration = {
   /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
   id?: string;
+  /** Whether to temporarily hide color textures whenever we interact with the Viewer. */
+  hideColorTexture?: boolean;
   /** Whether to temporarily hide physically-based rendering (PBR) whenever we interact with the Viewer. */
   hidePBR?: boolean;
   /** Whether to temporarily hide scalable ambient occlusion (SAO) whenever we interact with the Viewer. */
@@ -35,6 +37,24 @@ export declare class FastNavPlugin extends Plugin {
      */
     constructor(viewer: Viewer, cfg?: FastNavPluginConfiguration);
 
+    /**
+     * Gets whether to temporarily hide color textures whenever we interact with the Viewer.
+     *
+     * Default is ````true````.
+     *
+     * @return {Boolean} ````true```` if hiding color textures.
+     */
+    get hideColorTexture(): boolean;
+
+    /**
+     * Sets whether to temporarily hide color textures whenever we interact with the Viewer.
+     *
+     * Default is ````true````.
+     *
+     * @param {Boolean} hideColorTexture ````true```` to hide color textures.
+     */
+    set hideColorTexture(hideColorTexture: boolean);    
+
     /**
      * Sets whether to temporarily hide physically-based rendering (PBR) whenever we interact with the Viewer.
      *

package/types/plugins/StoreyViewsPlugin/StoreyViewsPlugin.d.ts

@@ -3,9 +3,19 @@ import { Plugin, Viewer } from "../../viewer";
 import { Storey } from "./Storey";
 import { StoreyMap } from "./StoreyMap";
 
+export declare type IFCStoreyPlanObjectStates = {
+  [key: string] : {
+    visible: boolean;
+    edges?: boolean;
+    colorize?: number[]
+  }
+};
+
 export declare type StoreyViewsPluginConfiguration = {
   /** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
   id?: string;
+  /** Map of visual states for the {@link Entity}s as rendered within each {@link Storey}.  Default value is {@link IFCStoreyPlanObjectStates}. */
+  objectStates?: IFCStoreyPlanObjectStates;
 };
 
 /**
@@ -40,6 +50,24 @@ export declare class StoreyViewsPlugin extends Plugin {
    */
   modelStoreys: {[key: string]: { [key: string]: Storey} };
 
+  /**
+   * Sets map of visual states for the {@link Entity}s as rendered within each {@link Storey}.
+   *
+   * Default value is {@link IFCStoreyPlanObjectStates}.
+   *
+   * @type {IFCStoreyPlanObjectStates}
+   */
+  set objectStates(arg: IFCStoreyPlanObjectStates);
+
+  /**
+   * Gets map of visual states for the {@link Entity}s as rendered within each {@link Storey}.
+   *
+   * Default value is {@link IFCStoreyPlanObjectStates}.
+   *
+   * @type {IFCStoreyPlanObjectStates}
+   */
+  get objectStates(): IFCStoreyPlanObjectStates;
+
   /**
    * Arranges the {@link Camera} for a 3D orthographic view of the {@link Entity}s within the given storey.
    *
@@ -60,14 +88,20 @@ export declare class StoreyViewsPlugin extends Plugin {
    *
    * Optionally hides all other Entitys.
    *
+   * Optionally sets the visual appearance of each of the Entitys according to its IFC type. The appearance of
+   * IFC types in plan views is configured by {@link StoreyViewsPlugin.objectStates}.
+   *
    * See also: {@link ObjectsMemento}, which saves and restores a memento of the visual state
    * of the {@link Entity}'s that represent objects within a {@link Scene}.
    *
    * @param {String} storeyId ID of the ````IfcBuildingStorey```` object.
    * @param {*} [options] Options for showing the Entitys within the storey.
+   * @param {Boolean} [options.hideOthers=false] When ````true````, hide all other {@link Entity}s.
+   * @param {Boolean} [options.useObjectStates=false] When ````true````, apply the custom visibilities and appearances configured for IFC types in {@link StoreyViewsPlugin.objectStates}.
    */
   showStoreyObjects(storeyId: string, options?: {
     hideOthers?: boolean;
+    useObjectStates?: boolean
   }): void;
 
   /**

package/types/plugins/TreeViewPlugin/TreeViewPlugin.d.ts

@@ -49,6 +49,15 @@ export declare class TreeViewPlugin extends Plugin {
    */
   get hierarchy(): "containment" | "storeys" | "types";
 
+  /**
+   * Returns the map of {@link ModelTreeView}s.
+   *
+   * Each ModelTreeView is mapped to the ID of its model.
+   *
+   * @return {*|{}}
+   */
+  get modelTreeViews(): any;
+
   /**
    * Adds a model to this tree view.
    *

package/types/viewer/metadata/MetaScene.d.ts

@@ -131,5 +131,5 @@ export declare class MetaScene {
      * @param {String} id ID of root {@link MetaObject}.
      * @param {Function} callback Callback fired at each {@link MetaObject}.
      */
-  withMetaObjectsInSubtree(id: string, callback: ()=> void): void;
+  withMetaObjectsInSubtree(id: string, callback: (...args: any[])=> void): void;
 }

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

@@ -2,13 +2,15 @@ export * from "./Component";
 export * from "./Entity";
 export * from "./LineSet";
 export * from "./Bitmap";
+export * from "./LineSet";
+export * from "./Bitmap";
 export * from "./camera";
 export * from "./CameraControl/CameraControl";
 export * from "./geometry";
 export * from "./lights";
 export * from "./marker";
 export * from "./materials";
-export * from "./math/math";
+export * from "./math";
 export * from "./mementos";
 export * from "./mesh";
 export * from "./nodes";
@@ -18,3 +20,4 @@ export * from "./sectionPlane";
 export * from "./stats";
 export * from "./viewport";
 export * from "./webgl";
+export * from "./utils";

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

@@ -9,6 +9,11 @@ import { Component } from "../Component";
  * * Located at {@link Scene#input}
  */
 export declare class Input extends Component {
+  readonly KEY_CTRL: number;
+
+  keyDown: boolean[];
+
+  keyboardEnabled: boolean;
 
   /**
    * Sets whether input handlers are enabled.

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

@@ -30,17 +30,23 @@ declare const math: {
    */
   vec4: (values?: number[]) => number[];
 
+  /**
+   * Returns a new, uninitialized 2D axis-aligned bounding box.
+   *
+   */
+  AABB2: (values?: any) => any;
+
   /**
    * Gets the center of a 2D AABB.
    * @returns {Number[]}
    */
-  getAABB2Center(aabb: number[], dest?: (values?: number[]) => number[]): number[];
+  getAABB2Center(aabb: number[], dest?: any): number[];
 
   /**
    * Gets the center of an AABB.
    * @returns {Number[]}
    */
-  getAABB3Center(aabb: number[], dest?: (values?: number[]) => number[]): number[];
+  getAABB3Center(aabb: number[], dest?: any): number[];
 
   /**
    * Gets the diagonal size of an AABB3 given as minima and maxima.
@@ -53,9 +59,46 @@ declare const math: {
    normalizeVec3: (v: number[], dest?: any) => number[];
 
    /**
-     * Multiplies each element of a three-element vector by a scalar.
-     */
+    * Multiplies each element of a three-element vector by a scalar.
+    */
    mulVec3Scalar: (v: number[], scalar: number, dest?: number[]) => number[];
+
+   /**
+    * Returns true if the first AABB contains the second AABB.
+    */
+   containsAABB3: (aabb1: number[], aabb2: number[]) => boolean;
+
+  /**
+   * Returns a new, uninitialized 3D axis-aligned bounding box.
+   */
+   AABB3: (values?: any) => any;
+
+  /**
+   * Collapses a 3D axis-aligned boundary, ready to expand to fit 3D points.
+   * Creates new AABB if none supplied.
+   */
+   collapseAABB3: (aabb: number[]) => number[];
+
+  /**
+   * Expands the first axis-aligned 3D boundary to enclose the second, if required.
+   */
+   expandAABB3: (aabb1: number[], aabb2: number[]) => number[];
+
+  /**
+   * Returns a new, uninitialized 4x4 matrix.
+   * @method mat4
+   * @param [values] Initial values.
+   * @static
+   * @returns {Number[]}
+   */
+    mat4(values?: any): number[];
+
+  /**
+   * Returns a 4x4 perspective projection matrix.
+   * @method frustumMat4v
+   * @static
+   */
+  frustumMat4: (left: number, right: number, bottom: number, top: number, near: number, far: number, dest: number[] | null) => number[];
 };
 
 export {math};

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

@@ -79,6 +79,33 @@ export declare class Scene extends Component {
    */
   get startTime(): Date;
 
+  /**
+   * canvas
+   */
+  get canvas(): any;
+
+  /**
+   * Sets whether data texture scene representation (DTX) is enabled for the {@link Scene}.
+   *
+   * Even when enabled, DTX will only work if supported.
+   *
+   * Default value is ````false````.
+   *
+   * @type {Boolean}
+   */
+  set dtxEnabled(value: boolean);
+
+  /**
+   * Gets whether data texture-based scene representation (DTX) is enabled for the {@link Scene}.
+   *
+   * Even when enabled, DTX will only apply if supported.
+   *
+   * Default value is ````false````.
+   *
+   * @type {Boolean}
+   */
+  get dtxEnabled(): boolean;
+
   /**
    * Map of {@link Entity}s that represent models.
    *
@@ -646,7 +673,7 @@ export declare class Scene extends Component {
    * @param {String[]} ids Array of {@link Entity.id} values.
    * @returns {[Number, Number, Number, Number, Number, Number]} An axis-aligned World-space bounding box, given as elements ````[xmin, ymin, zmin, xmax, ymax, zmax]````.
    */
-  getAABB(ids: string[]): number[];
+  getAABB(ids?: string[] | null): number[];
 
   /**
    * Batch-updates {@link Entity.visible} on {@link Entity}s that represent objects.