@xtctwins/tctwins-core 1.0.5 → 1.0.6

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

@@ -4,8 +4,6 @@ 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. */
@@ -37,24 +35,6 @@ 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/NavCubePlugin/NavCubePlugin.d.ts

@@ -34,6 +34,8 @@ export declare type NavCubePluginConfiguration = {
   bottomColor?: string;
   /** Custom color for highlighting regions on the NavCube as we hover the pointer over them. */
   hoverColor?: string;
+  /** Custom text color for labels of the NavCube. */
+  textColor?: string;
   /** Sets whether the axis, corner and edge-aligned views will fit the view to the entire {@link Scene} or just to visible object-{@link Entity}s. Entitys are visible objects when {@link Entity.isObject} and {@link Entity.visible} are both ````true````. */
   fitVisible?: boolean;
   /** Sets whether the NavCube switches between perspective and orthographic projections in synchrony with the {@link Camera}. When ````false````, the NavCube will always be rendered with perspective projection. */

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

@@ -39,6 +39,28 @@ export declare class Storey {
    */
   aabb: number[];
 
+  /**
+   * Axis-aligned World-space boundary of the {@link Entity}s that represent the IfcBuildingStorey.
+   *
+   * The boundary is a six-element Float32Array containing the min/max extents of the
+   * axis-aligned boundary, ie. ````[xmin, ymin, zmin, xmax, ymax, zmax]````
+   *
+   * @property storeyAABB
+   * @type {Number[]}
+   */
+  storeyAABB :number[];
+
+  /**
+   * Axis-aligned World-space boundary of the {@link Entity}s that represent the model.
+   *
+   * The boundary is a six-element Float32Array containing the min/max extents of the
+   * axis-aligned boundary, ie. ````[xmin, ymin, zmin, xmax, ymax, zmax]````
+   *
+   * @property modelAABB
+   * @type {Number[]}
+   */
+  modelAABB : number[];
+
   /** Number of {@link Entity}s within the IfcBuildingStorey.
    *
    * @type {Number}

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

@@ -3,19 +3,9 @@ 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;
 };
 
 /**
@@ -50,24 +40,6 @@ 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.
    *
@@ -88,20 +60,14 @@ 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/TreeViewNode.d.ts

@@ -6,7 +6,6 @@ export declare class TreeViewNode {
    * Globally unique node ID.
    *
    * @type {String}
-   * @abstract
    */
   get nodeId(): string;
 
@@ -14,7 +13,6 @@ export declare class TreeViewNode {
    * Title of the TreeViewNode.
    *
    * @type {String}
-   * @abstract
    */
   get title(): string;
 
@@ -23,51 +21,51 @@ export declare class TreeViewNode {
    *
    * This is only defined if the TreeViewNode represents an object.
    *
-   * @type {Number|String}
-   * @abstract
+   * @type {String}
+   */
+  get objectId(): string;
+
+  /**
+   * Type of the corresponding {@link MetaObject}.
+   *
+   * @type {String}
    */
-  get objectId(): string | number;
+  get type(): string;
 
   /**
    * The child TreeViewNodes.
    *
    * @type {Array}
-   * @abstract
    */
   get children(): any[];
 
   /** The parent TreeViewNode.
    *
-   * @type {TreeViewNode}
-   * @abstract
+   * @type {TreeViewNode|null}
    */
-  get parent(): TreeViewNode;
+  get parent(): TreeViewNode | null;
 
   /** The number of {@link Entity}s within the subtree of this TreeViewNode.
    *
    * @type {Number}
-   * @abstract
    */
   get numEntities(): number;
 
   /** The number of {@link Entity}s that are currently visible within the subtree of this TreeViewNode.
    *
    * @type {Number}
-   * @abstract
    */
   get numVisibleEntities(): number;
 
   /** Whether or not the TreeViewNode is currently checked.
    *
    * @type {Boolean}
-   * @abstract
    */
   get checked(): boolean;
 
   /** Whether or not the TreeViewNode is currently xrayed.
    *
    * @type {Boolean}
-   * @abstract
    */
-     get xrayed(): boolean;
+  get xrayed(): boolean;
 }

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

@@ -0,0 +1,128 @@
+import { TreeViewNode } from "./TreeViewNode";
+type genericHandler = (event: any) => void;
+
+export declare interface ITreeViewRenderService {
+
+  /**
+   * Creates the root node element.
+   */
+  createRootNode(): HTMLElement;
+
+  /**
+   * Creates a tree node element.
+   * 
+   * @param node {TreeViewNode} The node.
+   * @param expandHandler {genericHandler} The handler for expanding the node.
+   * @param checkHandler {genericHandler} The handler for checking the node.
+   * @param contextmenuHandler {genericHandler} The handler for the context menu.
+   * @param titleClickHandler {genericHandler} The handler for the title click.
+   * 
+   * @returns {HTMLElement} The tree node element.
+   */
+  createNodeElement(node: TreeViewNode, expandHandler: genericHandler, checkHandler: genericHandler, contextmenuHandler: genericHandler, titleClickHandler: genericHandler): HTMLElement;
+
+  /**
+   * Creates a tree node element for a disabled node.
+   *  
+   * @param rootName {String} The root name.
+   *
+   * @returns {HTMLElement} The disabled node element.
+   */
+  createDisabledNodeElement(rootName: string): HTMLElement;
+
+  /**
+   * Adds the child nodes to the parent node.
+   * 
+   * @param element {HTMLElement} The node element.
+   * @param nodes {Array<HTMLElement>} The children elements.
+   */
+  addChildren(element: HTMLElement, nodes: Array<HTMLElement>): void;
+
+  /**
+   * Expands a node, changes the icon and changes the handlers.
+   * 
+   * @param element {HTMLElement} The node element.
+   * @param expandHandler {genericHandler} The handler for expanding the node.
+   * @param collapseHandler {genericHandler} The handler for collapsing the node.
+   */
+  expand(element: HTMLElement, expandHandler: genericHandler, collapseHandler: genericHandler): void;
+
+  /**
+   * Collapses a node, changes the icon and changes the handlers.
+   * 
+   * @param element {HTMLElement} The node element.
+   * @param expandHandler {genericHandler} The handler for expanding the node.
+   * @param collapseHandler {genericHandler} The handler for collapsing the node.
+   */
+  collapse(element: HTMLElement, expandHandler: genericHandler, collapseHandler: genericHandler): void;
+
+  /**
+   * Returns whether the node is expanded.
+   *
+   * @param element {HTMLElement} The node element.
+   *
+   * @returns {Boolean} Whether the node is expanded.
+   */
+  isExpanded(element: HTMLElement): boolean;
+
+  /**
+   * Returns the node id from the treeview element.
+   *
+   * @param element {HTMLElement} The node element.
+   *
+   * @returns {String} The node id.
+   */
+  getId(element: HTMLElement): string | undefined;
+
+  /**
+   * Returns the node id from the checkbox element.
+   *
+   * @param element {HTMLElement} The node element.
+   *
+   * @returns {String} The node id.
+   */
+  getIdFromCheckbox(element: HTMLElement): string;
+
+  /**
+   * Returns the expand/collapse element.
+   *
+   * @param nodeId {String} The node id.
+   *
+   * @returns {HTMLElement} The expand/collapse element.
+   */
+  getSwitchElement(nodeId: string): HTMLElement | null;
+
+  /**
+   * Returns the node's checkbox state.
+   * 
+   * @param element {HTMLElement} The node element.
+   *
+   * @returns {Boolean} Whether the node is checked.
+   */
+  isChecked(element: HTMLElement): boolean;
+
+  /**
+   * Sets the node's checkbox state.
+   * 
+   * @param nodeId {String} The node id.
+   * @param checked {Boolean} Whether the node is checked.
+   */
+  setCheckbox(nodeId: string, checked: boolean): void;
+
+  /**
+   * Sets the node's xrayed state.
+   * 
+   * @param nodeId {String} The node is.
+   * @param xrayed {Boolean} Whether the node is xrayed.
+   */
+  setXRayed(nodeId: string, xrayed: boolean): void;
+
+  /**
+   * Sets the node's highlight state.
+   * When the node is highlighted, it will be expanded and scrolled into view. 
+   *
+   * @param nodeId {String} The node id.
+   * @param highlighted {Boolean} Whether the node is highlighted.
+   */
+  setHighlighted(nodeId: string, highlighted: boolean): void;
+}