@shapediver/viewer.shared.node-tree 1.15.7 → 2.0.0

package/dist/{Tree.d.ts → interfaces/ITree.d.ts}

@@ -1,12 +1,6 @@
-import { TreeNode } from './TreeNode';
-export declare class Tree {
-    #private;
-    /**
-     * @ignore
-     * Management of the main tree node.
-     */
-    constructor();
-    get root(): TreeNode;
+import { ITreeNode } from "./ITreeNode";
+export interface ITree {
+    readonly root: ITreeNode;
     /**
      * Add the node as a child of the corresponding parent node.
      *
@@ -14,7 +8,7 @@ export declare class Tree {
      * @param parent the targeted parent node
      * @param root optional root at which the process begins, root node will be used per default
      */
-    addNode(node: TreeNode, parent?: TreeNode, root?: TreeNode): boolean;
+    addNode(node: ITreeNode, parent?: ITreeNode, root?: ITreeNode): boolean;
     /**
      * Add the node at the corresponding path. (paths are dot separated ids)
      *
@@ -22,28 +16,28 @@ export declare class Tree {
      * @param path the path at which the node should be added
      * @param root optional root at which the process begins, root node will be used per default
      */
-    addNodeAtPath(node: TreeNode, path?: string, root?: TreeNode): boolean;
+    addNodeAtPath(node: ITreeNode, path?: string, root?: ITreeNode): boolean;
+    /**
+     * Get the node at the provided path.
+     *
+     * @param path
+     * @param root
+     * @returns
+     */
+    getNodeAtPath(path?: string, root?: ITreeNode): ITreeNode | null;
     /**
      * Remove a node from the tree.
      *
      * @param node the node to remove
      * @param root optional root at which the process begins, root node will be used per default
      */
-    removeNode(node: TreeNode, root?: TreeNode): boolean;
+    removeNode(node: ITreeNode, root?: ITreeNode): boolean;
     /**
      * Remove a node via the path of it.
      *
      * @param path the path of the node to be removed
      * @param root optional root at which the process begins, root node will be used per default
      */
-    removeNodeAtPath(path: string, root?: TreeNode): boolean;
-    /**
-     * Get the node at the provided path.
-     *
-     * @param path
-     * @param root
-     * @returns
-     */
-    getNodeAtPath(path?: string, root?: TreeNode): TreeNode | null;
+    removeNodeAtPath(path: string, root?: ITreeNode): boolean;
 }
-//# sourceMappingURL=Tree.d.ts.map
+//# sourceMappingURL=ITree.d.ts.map

package/dist/interfaces/ITree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITree.d.ts","sourceRoot":"","sources":["../../src/interfaces/ITree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,WAAW,KAAK;IAGlB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAMzB;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAExE;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAEzE;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;IAEjE;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAEvD;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;CAG7D"}

package/dist/interfaces/ITree.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ITree.js.map

package/dist/interfaces/ITree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITree.js","sourceRoot":"","sources":["../../src/interfaces/ITree.ts"],"names":[],"mappings":""}

package/dist/interfaces/ITreeNode.d.ts

@@ -0,0 +1,115 @@
+import { mat4 } from 'gl-matrix';
+import { IBox } from '@shapediver/viewer.shared.math';
+import { ITreeNodeData } from './ITreeNodeData';
+import { ISDObject } from './ISDObject';
+export interface ITransformation {
+    id: string;
+    matrix: mat4;
+}
+export interface ITreeNode {
+    readonly children: ITreeNode[];
+    readonly data: ITreeNodeData[];
+    readonly id: string;
+    readonly name: string;
+    readonly version: string;
+    readonly parent?: ITreeNode;
+    readonly nodeMatrix: mat4;
+    readonly worldMatrix: mat4;
+    readonly boundingBox: IBox;
+    readonly transformedNodes: {
+        [key: string]: ISDObject;
+    };
+    excludeViewports: string[];
+    restrictViewports: string[];
+    transformations: ITransformation[];
+    visible: boolean;
+    /**
+     * Add a child to the children of this node.
+     *
+     * @param child the child to add
+     */
+    addChild(child: ITreeNode): boolean;
+    /**
+     * Add a data item to node.
+     *
+     * @param data the data to add
+     */
+    addData(data: ITreeNodeData): boolean;
+    /**
+     * Add a transformation to this node.
+     *
+     * @param transformation the transformation to add
+     */
+    addTransformation(transformation: ITransformation): boolean;
+    /**
+     * Clones this node and all its children.
+     */
+    clone(): ITreeNode;
+    /**
+     * Clones this node and all its children.
+     */
+    cloneInstance(): ITreeNode;
+    /**
+     * Returns the child with the specified id
+    */
+    getChild(id: string): ITreeNode | undefined;
+    /**
+     * Returns the data item with the specified id
+    */
+    getData(id: string): ITreeNodeData | undefined;
+    /**
+     * Returns the transformation with the specified id
+    */
+    getTransformation(id: string): ITransformation | undefined;
+    /**
+     * Return the path to this node.
+     */
+    getPath(): string;
+    /**
+     * Check for existence of a child from the children of this node.
+     *
+     * @param child the child to check
+     */
+    hasChild(child: ITreeNode): boolean;
+    /**
+     * Check for existence of a data item of this node.
+     *
+     * @param data the data item to check
+     */
+    hasData(data: ITreeNodeData): boolean;
+    /**
+     * Check for existence of a transformation of this node.
+     *
+     * @param data the transformation to check
+     */
+    hasTransformation(transformation: ITransformation): boolean;
+    /**
+     * Remove a child from the children of this node.
+     *
+     * @param child the child to remove
+     */
+    removeChild(child: ITreeNode): boolean;
+    /**
+     * Remove a data item from this node.
+     *
+     * @param data the data to remove
+     */
+    removeData(data: ITreeNodeData): boolean;
+    /**
+     * Remove a transformation from this node.
+     *
+     * @param transformation the transformation to remove
+     */
+    removeTransformation(transformation: ITransformation): boolean;
+    /**
+     * Traverse this node and all it's children and executes the callback for all of them
+     *
+     * @param callback
+     */
+    traverse(callback: (node: ITreeNode) => void): void;
+    /**
+     * Update the version
+     */
+    updateVersion(): void;
+}
+//# sourceMappingURL=ITreeNode.d.ts.map

package/dist/interfaces/ITreeNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITreeNode.d.ts","sourceRoot":"","sources":["../../src/interfaces/ITreeNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,gCAAgC,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,MAAM,WAAW,eAAe;IAG5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,IAAI,CAAA;CAGf;AAED,MAAM,WAAW,SAAS;IAGtB,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,CAAC;IAE/B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;IAE5B,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;IAE3B,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;IAC3B,QAAQ,CAAC,gBAAgB,EAAE;QACvB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,CAAC;IAEF,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAE5B,eAAe,EAAE,eAAe,EAAE,CAAC;IACnC,OAAO,EAAE,OAAO,CAAC;IAMjB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC;IAEtC;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,eAAe,GAAG,OAAO,CAAC;IAE5D;;OAEG;IACH,KAAK,IAAI,SAAS,CAAC;IAEnB;;OAEG;IACH,aAAa,IAAI,SAAS,CAAC;IAE3B;;MAEE;IACF,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAE5C;;MAEE;IACF,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;IAE/C;;MAEE;IACF,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;IAE3D;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC;IAElB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC;IAEtC;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,eAAe,GAAG,OAAO,CAAC;IAE5D;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IAEvC;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC;IAEzC;;;;OAIG;IACH,oBAAoB,CAAC,cAAc,EAAE,eAAe,GAAG,OAAO,CAAC;IAE/D;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,aAAa,IAAI,IAAI,CAAC;CAGzB"}

package/dist/interfaces/ITreeNode.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ITreeNode.js.map

package/dist/interfaces/ITreeNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITreeNode.js","sourceRoot":"","sources":["../../src/interfaces/ITreeNode.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapediver/viewer.shared.node-tree",
-  "version": "1.15.7",
+  "version": "2.0.0",
   "description": "",
   "keywords": [],
   "author": "Michael Oppitz <michael@shapediver.com>",
@@ -10,7 +10,11 @@
     "test": "__tests__"
   },
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "package.json",
+    "README.md",
+    "tsconfig.json"
   ],
   "publishConfig": {
     "access": "public"
@@ -20,11 +24,10 @@
     "url": "git+https://github.com/shapediver/Viewer.git"
   },
   "scripts": {
-    "test": "bash ../../scripts/test.sh",
     "check": "tsc --noEmit",
-    "build": "bash ../../scripts/build.sh",
-    "build-watch": "bash ../../scripts/build-watch.sh",
-    "build-dep": "bash ../../scripts/build-dep.sh"
+    "build": "bash ../../scripts/building/build.sh",
+    "build-watch": "bash ../../scripts/building/build-watch.sh",
+    "build-dep": "bash ../../scripts/building/build-dep.sh"
   },
   "bugs": {
     "url": "https://github.com/shapediver/Viewer/issues"
@@ -36,10 +39,10 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@shapediver/viewer.shared.math": "1.15.7",
-    "@shapediver/viewer.shared.services": "1.15.7",
+    "@shapediver/viewer.shared.math": "2.0.0",
+    "@shapediver/viewer.shared.services": "2.0.0",
     "gl-matrix": "3.3.0",
     "tsyringe": "^4.5.0"
   },
-  "gitHead": "2b597ac1cf5808ace220b88a91b37c7852663785"
+  "gitHead": "bb53f1f23dcf3b1d76e786bdc8eb20e485c029f2"
 }

package/src/implementation/AbstractTreeNodeData.ts

@@ -0,0 +1,62 @@
+import { container } from 'tsyringe'
+import { UuidGenerator, EventEngine, EVENTTYPE } from '@shapediver/viewer.shared.services'
+
+import { ITreeNodeData } from '../interfaces/ITreeNodeData'
+
+export abstract class AbstractTreeNodeData implements ITreeNodeData {
+  // #region Properties (3)
+
+  #version: string;
+
+  readonly #id: string;
+  readonly #uuidGenerator: UuidGenerator = <UuidGenerator>container.resolve(UuidGenerator);
+  readonly #eventEngine: EventEngine = <EventEngine>container.resolve(EventEngine);
+
+  // #endregion Properties (3)
+
+  // #region Constructors (1)
+
+  /**
+   * Creates a tree node data object.
+   * 
+   * @param id Id of this data object
+   */
+  constructor(id?: string) {
+    this.#id = id || this.#uuidGenerator.create();
+    this.#version = this.#uuidGenerator.create();
+  }
+
+  // #endregion Constructors (1)
+
+  // #region Public Accessors (2)
+
+  public get id(): string {
+    return this.#id;
+  }
+
+  public get version(): string {
+    return this.#version;
+  }
+
+  // #endregion Public Accessors (2)
+
+  // #region Public Methods (1)
+
+  /**
+   * Update the version
+   */
+  public updateVersion(): void {
+    this.#version = this.#uuidGenerator.create();
+  }
+
+  // #endregion Public Methods (1)
+
+  // #region Public Abstract Methods (1)
+
+  /**
+   * Clones the tree node data.
+   */
+  public abstract clone(): ITreeNodeData;
+
+  // #endregion Public Abstract Methods (1)
+}

package/src/implementation/Tree.ts

@@ -0,0 +1,120 @@
+import { singleton } from 'tsyringe'
+import { ITree } from '../interfaces/ITree';
+import { ITreeNode } from '../interfaces/ITreeNode';
+
+import { TreeNode } from './TreeNode'
+
+@singleton()
+export class Tree implements ITree {
+  // #region Properties (1)
+
+  readonly #root = new TreeNode('root');
+
+  // #endregion Properties (1)
+
+  // #region Constructors (1)
+
+  constructor() { }
+
+  // #endregion Constructors (1)
+
+  // #region Public Accessors (1)
+
+  public get root(): ITreeNode {
+    return this.#root;
+  }
+
+  // #endregion Public Accessors (1)
+
+  // #region Public Methods (6)
+
+  public addNode(node: ITreeNode, parent: ITreeNode = this.#root, root: ITreeNode = this.#root): boolean {
+    if (root === parent) {
+      root.addChild(node);
+      return true;
+    }
+
+    for (let i = 0; i < root.children.length; i++) {
+      const child = root.children[i];
+      if (child && this.addNode(node, parent, child)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  public addNodeAtPath(node: ITreeNode, path: string = this.root.getPath(), root: ITreeNode = this.#root): boolean {
+    if (root.name === path) {
+      root.addChild(node);
+      return true;
+    }
+
+    const pathStart = path.substr(0, path.indexOf('.'));
+    if (root.name === pathStart) {
+      const shortenedPath = path.substr(pathStart.length + 1, path.length);
+
+      for (let i = 0; i < root.children.length; i++) {
+        const child = root.children[i];
+        if (child && this.addNodeAtPath(node, shortenedPath, child)) {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  public getNodeAtPath(path: string = this.root.getPath(), root: ITreeNode = this.#root): ITreeNode | null {
+    if (root.name === path) 
+      return root;
+
+    const pathStart = path.substr(0, path.indexOf('.'));
+    if (root.name === pathStart) {
+      const shortenedPath = path.substr(pathStart.length + 1, path.length);
+
+      for (let i = 0; i < root.children.length; i++) {
+        const child = root.children[i];
+        const res = this.getNodeAtPath(shortenedPath, child);
+        if(res) return res;
+      }
+    }
+    return null;
+  }
+
+  public removeNode(node: ITreeNode, root: ITreeNode = this.#root): boolean {
+    if (root.hasChild(node)) {
+      root.removeChild(node);
+      return true;
+    }
+
+    for (let i = 0; i < root.children.length; i++) {
+      const child = root.children[i];
+      if (child && this.removeNode(node, child)) {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  public removeNodeAtPath(path: string, root: ITreeNode = this.#root): boolean {
+    if (root.name === path) {
+      root.parent?.removeChild(root);
+      return true;
+    }
+
+    const pathStart = path.substr(0, path.indexOf('.'));
+    if (root.name === pathStart) {
+      const shortenedPath = path.substr(pathStart.length + 1, path.length);
+
+      for (let i = 0; i < root.children.length; i++) {
+        const child = root.children[i];
+        if (child && this.removeNodeAtPath(shortenedPath, child)) {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  // #endregion Public Methods (6)
+}