@xeokit/xeokit-sdk 2.5.2-beta-4 → 2.5.2-beta-5

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/TreeViewPlugin/TreeViewPlugin.d.ts

@@ -1,6 +1,6 @@
 import { Plugin, Viewer } from "../../viewer";
-import { ModelTreeView } from "./ModelTreeView";
 import { TreeViewNode } from "./TreeViewNode";
+import { ITreeViewRenderService } from "./renderService";
 
 export declare type TreeViewPluginConfiguration = {
   /** DOM element ID to contain the TreeViewPlugin */
@@ -17,6 +17,8 @@ export declare type TreeViewPluginConfiguration = {
   sortNodes?: boolean;
   /** When true, will not contain nodes that don't have content in the {@link Scene}. These are nodes whose {@link MetaObject}s don't have {@link Entity}s. */
   pruneEmptyNodes?: boolean;
+  /** Optional {@link ITreeViewRenderService} to use. Defaults to the {@link TreeViewPlugin}'s default {@link RenderService}. */
+  renderService?: ITreeViewRenderService;
 };
 
 /**
@@ -47,15 +49,6 @@ 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.
    *
@@ -69,13 +62,10 @@ export declare class TreeViewPlugin extends Plugin {
    * @param {String} [options.rootName] Optional display name for the root node. Ordinary, for "containment"
    * and "storeys" hierarchy types, the tree would derive the root node name from the model's "IfcProject" element
    * name. This option allows to override that name when it is not suitable as a display name.
-   * @returns {ModelTreeView} ModelTreeView for the newly-added model. If this method succeeded in adding the model,
-   * then {@link ModelTreeView.valid} will equal ````true````. Otherwise, that property will be ````false````
-   * and {@link ModelTreeView.errors} will contain error messages.
    */
   addModel(modelId: string, options?: {
-      rootName?: string;
-  }): ModelTreeView;
+    rootName?: string;
+  }): void;
 
   /**
    * Removes a model from this tree view.
@@ -86,11 +76,6 @@ export declare class TreeViewPlugin extends Plugin {
    */
   removeModel(modelId: string): void;
 
-  /**
-   * Collapses all trees within this tree view.
-   */
-  collapse(): void;
-
   /**
    * Highlights the tree view node that represents the given object {@link Entity}.
    *
@@ -127,6 +112,12 @@ export declare class TreeViewPlugin extends Plugin {
    */
   expandToDepth(depth: number): void;
 
+
+  /**
+   * Closes all the nodes in the tree.
+   */
+  collapse(): void;
+
   /**
    * Iterates over a subtree of the tree view's {@link TreeViewNode}s, calling the given callback for each
    * node in depth-first pre-order.
@@ -136,17 +127,22 @@ export declare class TreeViewPlugin extends Plugin {
    */
   withNodeTree(node: TreeViewNode, callback: (node: TreeViewNode) => void): void;
 
+  /**
+   * Destroys this TreeViewPlugin.
+   */
+  destroy(): void;
+
   /**
    * Fires on right click to show contextmenu.
    * @param {String} event The contextmenu event
    * @param {Function} callback Callback fired on the event
   */
-  on(event: "contextmenu", callback: (data: {event: MouseEvent, viewer: Viewer, treeViewPlugin: TreeViewPlugin, treeViewNode: TreeViewNode })=> void): void;
+  on(event: "contextmenu", callback: (data: { event: MouseEvent, viewer: Viewer, treeViewPlugin: TreeViewPlugin, treeViewNode: TreeViewNode }) => void): void;
 
   /**
    * Fires when an title is clicked.
    * @param {String} event The nodeTitleClicked event
    * @param {Function} callback Callback fired on the event
   */
-   on(event: "nodeTitleClicked", callback: (data: {event: MouseEvent, viewer: Viewer, treeViewPlugin: TreeViewPlugin, treeViewNode: TreeViewNode })=> void): void;
+  on(event: "nodeTitleClicked", callback: (data: { event: MouseEvent, viewer: Viewer, treeViewPlugin: TreeViewPlugin, treeViewNode: TreeViewNode }) => void): void;
 }

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;
+
+  /**
+   * 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
+
+  /**
+   * 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;
+}

package/types/viewer/Configs.d.ts

@@ -17,4 +17,30 @@ export declare abstract class Configs {
    * @returns {Boolean}
    */
   get doublePrecisionEnabled(): boolean;
+
+  /**
+   * Sets the maximum data texture height.
+   *
+   * Should be a multiple of 1024. Default is 4096, which is the maximum allowed value.
+   */
+  set maxDataTextureHeight(value: number);
+
+  /**
+   * Gets maximum data texture height.
+   */
+  get maxDataTextureHeight(): number;
+
+  /**
+   * Sets the maximum batched geometry VBO size.
+   *
+   * Default value is 5000000, which is the maximum size.
+   *
+   * Minimum size is 100000.
+   */
+  set maxGeometryBatchSize(value: number);
+
+  /**
+   * Gets the maximum batched geometry VBO size.
+   */
+  get maxGeometryBatchSize(): number;
 }

package/types/viewer/Viewer.d.ts

@@ -38,7 +38,7 @@ export declare type ViewerConfiguration = {
   /**When ````transparent```` is false, set this ````true```` to derive the canvas background color from {@link AmbientLight.color}, or ````false```` to set the canvas background to ````backgroundColor````. */
   backgroundColorFromAmbientLight?: boolean;
   /** The measurement unit type. */
-  units?: "meters" | "centimeters" | "millimeters" | "yards" | "feet" | "inches" ;
+  units?: "meters" | "centimeters" | "millimeters" | "yards" | "feet" | "inches";
   /** The number of Real-space units in each World-space coordinate system unit. */
   scale?: number;
   /** The Real-space 3D origin, in current measurement units, at which the World-space coordinate origin ````[0,0,0]```` sits. */
@@ -55,10 +55,16 @@ export declare type ViewerConfiguration = {
   pickSurfacePrecisionEnabled?: boolean;
   /** Whether to enable logarithmic depth buffer. */
   logarithmicDepthBufferEnabled?: boolean;
+  /** Whether to enable base color texture rendering. */
+  colorTextureEnabled?: boolean;
   /** Whether to enable physically-based rendering. */
   pbrEnabled?: boolean;
   /** Optional locale-based translation service. */
   localeService?: LocaleService;
+  /** Whether to enable data texture-based (DTX) scene representation within the Viewer. */
+  dtxEnabled?: boolean;
+  /** Enhances the efficiency of SectionPlane creation by proactively allocating Viewer resources for a specified quantity of SectionPlanes.*/
+  numCachedSectionPlanes?: number;
 };
 
 /**
@@ -196,7 +202,7 @@ export declare class Viewer {
    * @param {Boolean} [params.includeGizmos=false] When true, will include gizmos like {@link SectionPlane} in the snapshot.
    * @returns {String} String-encoded image data URI.
    */
-  getSnapshot(params: { width?: number, height?: number, format?: "jpeg" | "png"| "bmp", includeGizmos?: boolean }): string;
+  getSnapshot(params: { width?: number, height?: number, format?: "jpeg" | "png" | "bmp", includeGizmos?: boolean }): string;
 
   /**
    * Gets a snapshot of this Viewer's {@link Scene} as a Base64-encoded image which includes
@@ -224,8 +230,8 @@ export declare class Viewer {
    * @param {Boolean} [params.includeGizmos=false] When true, will include gizmos like {@link SectionPlane} in the snapshot.
    * @returns {Promise} Promise which returns a string-encoded image data URI.
    */
-  getSnapshotWithPlugins(params: { width?: number, height?: number, format?: "jpeg" | "png"| "bmp", includeGizmos?: boolean }): Promise<String>;
-  
+  getSnapshotWithPlugins(params: { width?: number, height?: number, format?: "jpeg" | "png" | "bmp", includeGizmos?: boolean }): Promise<String>;
+
   /**
    * Exits snapshot mode.
    *

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

@@ -1,24 +0,0 @@
-import { MetaModel } from "../../viewer/metadata";
-
-/**
- * Represents a model tree view within a {@link TreeViewPlugin}.
- */
-export declare class ModelTreeView {
-  /**
-   * Contains messages for any errors found in the MetaModel for this ModelTreeView.
-   * @type {String[]}
-   */
-  errors: string[];
-
-  /**
-   * True if errors were found in the MetaModel for this ModelTreeView.
-   * @type {boolean}
-   */
-  valid: boolean;
-
-  /**
-   * The MetaModel corresponding to this ModelTreeView.
-   * @type {MetaModel}
-   */
-  metaModel: MetaModel;
-}