@zephyr3d/scene 0.1.0 → 0.1.2

package/dist/scene/octree.js

@@ -12,9 +12,9 @@ var OctreePlacement;
     OctreePlacement[OctreePlacement["NNP"] = 6] = "NNP";
     OctreePlacement[OctreePlacement["NNN"] = 7] = "NNN";
 })(OctreePlacement || (OctreePlacement = {}));
-/**
- * Octree node
- * @public
+/**
+ * Octree node
+ * @public
  */ class OctreeNode {
     /** @internal */ _chunk;
     /** @internal */ _position;
@@ -22,8 +22,8 @@ var OctreePlacement;
     /** @internal */ _nodes;
     /** @internal */ _box;
     /** @internal */ _boxLoosed;
-    /**
-   * Creates an instance of octree node
+    /**
+   * Creates an instance of octree node
    */ constructor(){
         this._chunk = null;
         this._position = 0;
@@ -32,29 +32,29 @@ var OctreePlacement;
         this._box = null;
         this._boxLoosed = null;
     }
-    /**
-   * Get all the scene nodes that this octree node contains
-   * @returns An array of the scene nodes
+    /**
+   * Get all the scene nodes that this octree node contains
+   * @returns An array of the scene nodes
    */ getNodes() {
         return this._nodes;
     }
-    /**
-   * Gets the level index of the octree node
-   * @returns The level index
+    /**
+   * Gets the level index of the octree node
+   * @returns The level index
    */ getLevel() {
         return this._chunk.getLevel();
     }
-    /**
-   * Adds a scene node to this node
-   * @param node - The scene node to be added
+    /**
+   * Adds a scene node to this node
+   * @param node - The scene node to be added
    */ addNode(node) {
         if (node && this._nodes.indexOf(node) < 0) {
             this._nodes.push(node);
         }
     }
-    /**
-   * Removes a scene node from this node
-   * @param node - The scene node to be removed
+    /**
+   * Removes a scene node from this node
+   * @param node - The scene node to be removed
    */ removeNode(node) {
         const index = this._nodes.indexOf(node);
         if (index >= 0) {
@@ -64,40 +64,40 @@ var OctreePlacement;
     /** Removes all the scene nodes that this octree node contains */ clearNodes() {
         this._nodes = [];
     }
-    /**
-   * Sets the octree chunk
-   * @param chunk - The octree chunk to be set
+    /**
+   * Sets the octree chunk
+   * @param chunk - The octree chunk to be set
    */ setChunk(chunk) {
         console.assert(!!chunk, 'Invalid chunk');
         this._chunk = chunk;
     }
-    /**
-   * Gets the octree chunk
-   * @returns The octree chunk
+    /**
+   * Gets the octree chunk
+   * @returns The octree chunk
    */ getChunk() {
         return this._chunk;
     }
-    /**
-   * Sets the position of the node
-   * @param index - Position of the node
+    /**
+   * Sets the position of the node
+   * @param index - Position of the node
    */ setPosition(index) {
         this._position = index;
     }
-    /**
-   * Gets the position of the octree node
-   * @returns Position of the octree node
+    /**
+   * Gets the position of the octree node
+   * @returns Position of the octree node
    */ getPosition() {
         return this._position;
     }
-    /**
-   * Invalidates the cached box
+    /**
+   * Invalidates the cached box
    */ invalidateBox() {
         this._box = null;
         this.getParent()?.invalidateBox();
     }
-    /**
-   * Get the bounding box of the octree node
-   * @returns The bounding box of the octree node
+    /**
+   * Get the bounding box of the octree node
+   * @returns The bounding box of the octree node
    */ getBox() {
         if (this._box === null) {
             const box = new AABB();
@@ -127,9 +127,9 @@ var OctreePlacement;
         }
         return this._box;
     }
-    /**
-   * Gets the loosed bounding box of the node
-   * @returns The loosed bounding box of the node
+    /**
+   * Gets the loosed bounding box of the node
+   * @returns The loosed bounding box of the node
    */ getBoxLoosed() {
         if (this._boxLoosed === null) {
             console.assert(!!this._chunk, 'Invalid chunk');
@@ -145,9 +145,9 @@ var OctreePlacement;
         }
         return this._boxLoosed;
     }
-    /**
-   * Gets min point of the node
-   * @returns Min point of the node
+    /**
+   * Gets min point of the node
+   * @returns Min point of the node
    */ getMinPoint() {
         console.assert(!!this._chunk, 'Invalid chunk');
         const d = this._chunk.getDimension();
@@ -158,9 +158,9 @@ var OctreePlacement;
         const pz = Math.floor(Math.floor(this._position / d) / d);
         return new Vector3(px, py, pz).scaleBy(nodeSize).subBy(new Vector3(halfWorldSize, halfWorldSize, halfWorldSize));
     }
-    /**
-   * Gets max point of the node
-   * @returns Max point of the node
+    /**
+   * Gets max point of the node
+   * @returns Max point of the node
    */ getMaxPoint() {
         console.assert(!!this._chunk, 'Invalid chunk');
         const d = this._chunk.getDimension();
@@ -171,62 +171,62 @@ var OctreePlacement;
         const pz = Math.floor(Math.floor(this._position / d) / d) + 1;
         return new Vector3(px, py, pz).scaleBy(nodeSize).subBy(new Vector3(halfWorldSize, halfWorldSize, halfWorldSize));
     }
-    /**
-   * Gets the loosed min point of the node
-   * @returns Loosed min point of the node
+    /**
+   * Gets the loosed min point of the node
+   * @returns Loosed min point of the node
    */ getMinPointLoosed() {
         const halfNodeSize = this._chunk.getNodeSize() * 0.5;
         return this.getMinPoint().subBy(new Vector3(halfNodeSize, halfNodeSize, halfNodeSize));
     }
-    /**
-   * Gets the loosed max point of the node
-   * @returns Loosed max point of the node
+    /**
+   * Gets the loosed max point of the node
+   * @returns Loosed max point of the node
    */ getMaxPointLoosed() {
         const halfNodeSize = this._chunk.getNodeSize() * 0.5;
         return this.getMaxPoint().addBy(new Vector3(halfNodeSize, halfNodeSize, halfNodeSize));
     }
-    /**
-   * Get reference of the node
-   * @returns Reference of the node
+    /**
+   * Get reference of the node
+   * @returns Reference of the node
    */ getReference() {
         return this._references;
     }
-    /**
-   * Gets the child node by a given placement
-   * @param placement - The placement
-   * @returns Child node at the given placement
+    /**
+   * Gets the child node by a given placement
+   * @param placement - The placement
+   * @returns Child node at the given placement
    */ getChild(placement) {
         console.assert(!!this._chunk, 'Invalid chunk');
         const next = this._chunk.getNext();
         return next ? next.getNode(this._chunk.getChildIndex(this._position, placement)) : null;
     }
-    /**
-   * Gets or creates a child node by a given placement
-   * @param placement - The placement
-   * @returns The child node fetched
+    /**
+   * Gets or creates a child node by a given placement
+   * @param placement - The placement
+   * @returns The child node fetched
    */ getOrCreateChild(placement) {
         console.assert(!!this._chunk, 'Invalid chunk');
         const next = this._chunk.getNext();
         return next ? next.getOrCreateNode(this._chunk.getChildIndex(this._position, placement)) : null;
     }
-    /**
-   * Gets parent of the node
-   * @returns Parent of the node
+    /**
+   * Gets parent of the node
+   * @returns Parent of the node
    */ getParent() {
         console.assert(!!this._chunk, 'Invalid chunk');
         const prev = this._chunk.getPrev();
         return prev ? prev.getNode(this._chunk.getParentIndex(this._position)) : null;
     }
-    /**
-   * Gets or creates the parent node
-   * @returns The parent node
+    /**
+   * Gets or creates the parent node
+   * @returns The parent node
    */ getOrCreateParent() {
         console.assert(!!this._chunk, 'Invalid chunk');
         const prev = this._chunk.getPrev();
         return prev ? prev.getOrCreateNode(this._chunk.getParentIndex(this._position)) : null;
     }
-    /**
-   * Creates all children of this node
+    /**
+   * Creates all children of this node
    */ createChildren() {
         this.getOrCreateChild(OctreePlacement.PPP);
         this.getOrCreateChild(OctreePlacement.PPN);
@@ -237,9 +237,9 @@ var OctreePlacement;
         this.getOrCreateChild(OctreePlacement.NNP);
         this.getOrCreateChild(OctreePlacement.NNN);
     }
-    /**
-   * Free up all empty children
-   * @returns true if some children were freed
+    /**
+   * Free up all empty children
+   * @returns true if some children were freed
    */ tidy() {
         this._references = 8;
         for(let i = 0; i < 8; i++){
@@ -254,9 +254,9 @@ var OctreePlacement;
         }
         return false;
     }
-    /**
-   * Traverse this node by a visitor
-   * @param v - The visitor
+    /**
+   * Traverse this node by a visitor
+   * @param v - The visitor
    */ traverse(v) {
         if (v.visit(this)) {
             for(let i = 0; i < 8; i++){
@@ -268,9 +268,9 @@ var OctreePlacement;
         }
     }
 }
-/**
- * Octree node chunk
- * @public
+/**
+ * Octree node chunk
+ * @public
  */ class OctreeNodeChunk {
     /** @internal */ _level;
     /** @internal */ _dimension;
@@ -279,9 +279,9 @@ var OctreePlacement;
     /** @internal */ _next;
     /** @internal */ _octree;
     /** @internal */ _nodeMap;
-    /**
-   * Creates an instance of octree chunk
-   * @param octree - Octree to which the chunk belongs
+    /**
+   * Creates an instance of octree chunk
+   * @param octree - Octree to which the chunk belongs
    */ constructor(octree){
         this._octree = octree;
         this._level = 0;
@@ -291,17 +291,17 @@ var OctreePlacement;
         this._prev = null;
         this._nodeMap = new Map();
     }
-    /**
-   * Gets an octree node at a given index
-   * @param index - Index of the node
-   * @returns The octree node
+    /**
+   * Gets an octree node at a given index
+   * @param index - Index of the node
+   * @returns The octree node
    */ getNode(index) {
         return this._nodeMap.get(index) || null;
     }
-    /**
-   * Gets or creates an octree node at a given index
-   * @param index - Index of the node
-   * @returns The octree node
+    /**
+   * Gets or creates an octree node at a given index
+   * @param index - Index of the node
+   * @returns The octree node
    */ getOrCreateNode(index) {
         let node = this.getNode(index);
         if (!node) {
@@ -312,10 +312,10 @@ var OctreePlacement;
         }
         return node;
     }
-    /**
-   * Gets or creates an octree node chain at a given index
-   * @param index - Index of the head node
-   * @returns The head node of the chain
+    /**
+   * Gets or creates an octree node chain at a given index
+   * @param index - Index of the head node
+   * @returns The head node of the chain
    */ getOrCreateNodeChain(index) {
         const node = this.getOrCreateNode(index);
         if (this._prev) {
@@ -323,9 +323,9 @@ var OctreePlacement;
         }
         return node;
     }
-    /**
-   * Removes an octree node at given index
-   * @param index - Index of the node
+    /**
+   * Removes an octree node at given index
+   * @param index - Index of the node
    */ freeNodeByIndex(index) {
         const node = this._nodeMap.get(index);
         if (node) {
@@ -333,28 +333,28 @@ var OctreePlacement;
             this._nodeMap.delete(index);
         }
     }
-    /**
-   * Removes an octree node
-   * @param node - The octree node to be removed
+    /**
+   * Removes an octree node
+   * @param node - The octree node to be removed
    */ freeNode(node) {
         if (node) {
             console.assert(node.getChunk() === this, 'Invalid chunk');
             this.freeNodeByIndex(node.getPosition());
         }
     }
-    /**
-   * Removes all octree nodes of this chunk
+    /**
+   * Removes all octree nodes of this chunk
    */ clearNodes() {
         for (const key of this._nodeMap.keys()){
             this._nodeMap.get(key).clearNodes();
             this._nodeMap.delete(key);
         }
     }
-    /**
-   * Gets the index of a child node at given placement
-   * @param index - Index of the parent node
-   * @param placement - The placement
-   * @returns Index of the child
+    /**
+   * Gets the index of a child node at given placement
+   * @param index - Index of the parent node
+   * @param placement - The placement
+   * @returns Index of the child
    */ getChildIndex(index, placement) {
         const dim = this._dimension;
         let px = 2 * (index % dim);
@@ -396,10 +396,10 @@ var OctreePlacement;
         const dimension2 = 2 * dim;
         return pz * dimension2 * dimension2 + py * dimension2 + px;
     }
-    /**
-   * Gets the index of the parent node
-   * @param index - Index of the child node
-   * @returns Index of the parent node
+    /**
+   * Gets the index of the parent node
+   * @param index - Index of the child node
+   * @returns Index of the parent node
    */ getParentIndex(index) {
         const dim = this._dimension;
         const px = index % dim >> 1;
@@ -408,88 +408,88 @@ var OctreePlacement;
         const d = dim >> 1;
         return px + py * d + pz * d * d;
     }
-    /**
-   * Gets the size of the node in this chunk
-   * @returns The size of the node in this chunk
+    /**
+   * Gets the size of the node in this chunk
+   * @returns The size of the node in this chunk
    */ getNodeSize() {
         return this._nodeSize;
     }
-    /**
-   * Gets the root size of the octree
-   * @returns The root size of the octree
+    /**
+   * Gets the root size of the octree
+   * @returns The root size of the octree
    */ getWorldSize() {
         return this._octree.getRootSize();
     }
-    /**
-   * Gets the dimension of this chunk
-   * @returns Dimension of this chunk
+    /**
+   * Gets the dimension of this chunk
+   * @returns Dimension of this chunk
    */ getDimension() {
         return this._dimension;
     }
-    /**
-   * Gets the level index of this chunk
-   * @returns Level index of this chunk
+    /**
+   * Gets the level index of this chunk
+   * @returns Level index of this chunk
    */ getLevel() {
         return this._level;
     }
-    /**
-   * Check if this chunk is empty
-   * @returns true if this chunk is empty, otherwise false
+    /**
+   * Check if this chunk is empty
+   * @returns true if this chunk is empty, otherwise false
    */ empty() {
         return this._nodeMap.size === 0;
     }
-    /**
-   * Gets the chunk next to this chunk
-   * @returns The next chunk
+    /**
+   * Gets the chunk next to this chunk
+   * @returns The next chunk
    */ getNext() {
         return this._next;
     }
-    /**
-   * Gets the chunk previous to this chunk
-   * @returns The previous chunk
+    /**
+   * Gets the chunk previous to this chunk
+   * @returns The previous chunk
    */ getPrev() {
         return this._prev;
     }
-    /**
-   * Gets the octree that the chunk belongs to
-   * @returns The octree
+    /**
+   * Gets the octree that the chunk belongs to
+   * @returns The octree
    */ getOctree() {
         return this._octree;
     }
-    /**
-   * Sets the level index of this chunk
-   * @param level - The level index to set
+    /**
+   * Sets the level index of this chunk
+   * @param level - The level index to set
    */ setLevel(level) {
         this._level = level;
     }
-    /**
-   * Sets the dimension of this chunk
-   * @param dimension - The dimension to set
+    /**
+   * Sets the dimension of this chunk
+   * @param dimension - The dimension to set
    */ setDimension(dimension) {
         this._dimension = dimension;
     }
-    /**
-   * Sets the size of octree node in this chunk
-   * @param size - The node size to set
+    /**
+   * Sets the size of octree node in this chunk
+   * @param size - The node size to set
    */ setNodeSize(size) {
         this._nodeSize = size;
     }
-    /**
-   * Sets the next chunk
-   * @param chunk - The chunk to set
+    /**
+   * Sets the next chunk
+   * @param chunk - The chunk to set
    */ setNext(chunk) {
         this._next = chunk;
     }
-    /**
-   * Sets the previous chunk
-   * @param chunk - The chunk to set
+    /**
+   * Sets the previous chunk
+   * @param chunk - The chunk to set
    */ setPrev(chunk) {
         this._prev = chunk;
     }
 }
-/**
- * Octree class
- * @public
+/**
+ * Octree class
+ * @public
  */ class Octree {
     /** @internal */ _scene;
     /** @internal */ _chunks;
@@ -497,11 +497,11 @@ var OctreePlacement;
     /** @internal */ _leafSize;
     /** @internal */ _rootNode;
     /** @internal */ _nodeMap;
-    /**
-   * Creates an instance of octree
-   * @param scene - The scene to which the octree belongs
-   * @param rootSize - Root size of the octre
-   * @param leafSize - Leaf size of the octree
+    /**
+   * Creates an instance of octree
+   * @param scene - The scene to which the octree belongs
+   * @param rootSize - Root size of the octre
+   * @param leafSize - Leaf size of the octree
    */ constructor(scene, rootSize = 4096, leafSize = 64){
         this._scene = scene;
         this._chunks = [];
@@ -511,10 +511,10 @@ var OctreePlacement;
         this._nodeMap = new WeakMap();
         this.initialize(rootSize, leafSize);
     }
-    /**
-   * Initialize the octree with specified root size and leaf size
-   * @param rootSize - Root size of the octree
-   * @param leafSize - Leaf size of the octree
+    /**
+   * Initialize the octree with specified root size and leaf size
+   * @param rootSize - Root size of the octree
+   * @param leafSize - Leaf size of the octree
    */ initialize(rootSize, leafSize) {
         console.assert(rootSize >= leafSize && leafSize > 0, 'Invalid rootSize or leafSize for octree');
         this.finalize();
@@ -541,30 +541,30 @@ var OctreePlacement;
         this._rootNode = null;
         this._nodeMap = new WeakMap();
     }
-    /**
-   * Gets the scene to which the octree belongs
-   * @returns The scene
+    /**
+   * Gets the scene to which the octree belongs
+   * @returns The scene
    */ getScene() {
         return this._scene;
     }
-    /**
-   * Gets the root size of the octree
-   * @returns The root size of the octree
+    /**
+   * Gets the root size of the octree
+   * @returns The root size of the octree
    */ getRootSize() {
         return this._rootSize;
     }
-    /**
-   * Gets the leaf size of the octree
-   * @returns The leaf size of the octree
+    /**
+   * Gets the leaf size of the octree
+   * @returns The leaf size of the octree
    */ getLeafSize() {
         return this._leafSize;
     }
-    /**
-   * Locates a node chain in the octree by a sphere
-   * @param candidate - The candidate node
-   * @param center - center of the sphere
-   * @param radius - radius of the sphere
-   * @returns Head node of the located node chain
+    /**
+   * Locates a node chain in the octree by a sphere
+   * @param candidate - The candidate node
+   * @param center - center of the sphere
+   * @param radius - radius of the sphere
+   * @returns Head node of the located node chain
    */ locateNodeChain(candidate, center, radius) {
         let level = this._chunks.length - 1;
         while(level && this._chunks[level].getNodeSize() < 4 * radius){
@@ -587,31 +587,31 @@ var OctreePlacement;
         }
         return this._chunks[level].getOrCreateNodeChain(index);
     }
-    /**
-   * Gets the root node of the octree
-   * @returns Root node of the octree
+    /**
+   * Gets the root node of the octree
+   * @returns Root node of the octree
    */ getRootNode() {
         if (!this._rootNode) {
             this._rootNode = this._chunks[0].getOrCreateNode(0);
         }
         return this._rootNode;
     }
-    /**
-   * Gets the number of chunks in the octree
-   * @returns The number of chunks in the octree
+    /**
+   * Gets the number of chunks in the octree
+   * @returns The number of chunks in the octree
    */ getNumChunks() {
         return this._chunks.length;
     }
-    /**
-   * Gets the chunk by a given index
-   * @param level - The chunk index
-   * @returns The chunk at given index
+    /**
+   * Gets the chunk by a given index
+   * @param level - The chunk index
+   * @returns The chunk at given index
    */ getChunk(level) {
         return this._chunks[level];
     }
-    /**
-   * Place a scene node into the octree
-   * @param node - The scene node to be placed
+    /**
+   * Place a scene node into the octree
+   * @param node - The scene node to be placed
    */ placeNode(node) {
         const curNode = this._nodeMap.get(node) || null;
         let locatedNode = this.getRootNode();
@@ -632,9 +632,9 @@ var OctreePlacement;
             locatedNode?.invalidateBox();
         }
     }
-    /**
-   * Removes a scene node from the octree
-   * @param node - The scene node to be removed
+    /**
+   * Removes a scene node from the octree
+   * @param node - The scene node to be removed
    */ removeNode(node) {
         if (node.isGraphNode()) {
             const curNode = this._nodeMap.get(node) || null;