@itwin/core-geometry 4.0.0-dev.4 → 4.0.0-dev.41

package/lib/esm/topology/Graph.js

@@ -7,6 +7,7 @@
  */
 import { LineSegment3d } from "../curve/LineSegment3d";
 import { Geometry } from "../Geometry";
+import { Angle } from "../geometry3d/Angle";
 import { Point2d, Vector2d } from "../geometry3d/Point2dVector2d";
 import { Point3d, Vector3d } from "../geometry3d/Point3dVector3d";
 import { SmallSystem } from "../numerics/Polynomials";
@@ -98,6 +99,7 @@ export class HalfEdge {
         this.sortAngle = undefined;
         this.sortData = undefined;
         this.edgeTag = undefined;
+        this.faceTag = undefined;
         // Always created in pairs, init here to make TS compiler and JS runtime happy
         this._facePredecessor = this;
         this._faceSuccessor = this;
@@ -218,6 +220,36 @@ export class HalfEdge {
         }
         return newA;
     }
+    /**
+     * * Create a new sliver face "inside" an existing edge.
+     * * Insert it "within" the base edge.
+     * * This requires two new half edges.
+     * * if the base is undefined, create a single-edge loop.
+     * * This (unlike pinch) breaks the edgeMate pairing of the base edge.
+     * * This preserves xyz and i properties at all existing vertices.
+     * * The two new half edges are a sliver face (via their predecessor and successor)
+     * * Each new edge mates to one existing edge.
+     * @returns Returns the reference to the half edge created.
+     */
+    static splitEdgeCreateSliverFace(baseA, heArray) {
+        // raw edges ...
+        const newA = new HalfEdge();
+        const newB = new HalfEdge();
+        const baseB = baseA.edgeMate;
+        if (heArray) {
+            heArray.push(newA);
+            heArray.push(newB);
+        }
+        newA._faceSuccessor = newA._facePredecessor = newB;
+        newB._faceSuccessor = newB._facePredecessor = newA;
+        // newA is in vertex loop with baseA etc.
+        // newA mates to baseB
+        HalfEdge.setEdgeMates(newA, baseB);
+        HalfEdge.setEdgeMates(newB, baseA);
+        newA.copyDataFrom(baseA, true, true, false, false);
+        newB.copyDataFrom(baseB, true, true, false, false);
+        return newA;
+    }
     /**
      * Copy "edge based" content of fromNode to toNode
      * * edgeTag
@@ -428,6 +460,35 @@ export class HalfEdge {
         }
         return count;
     }
+    /** Returns the first node with given mask value around this vertex loop.   */
+    findMaskAroundVertex(mask, value = true) {
+        let node = this;
+        do {
+            if (node.isMaskSet(mask) === value)
+                return node;
+            node = node.vertexSuccessor;
+        } while (node !== this);
+        return undefined;
+    }
+    /** Returns the first node with given mask value around this face loop.   */
+    findMaskAroundFace(mask, value = true) {
+        let node = this;
+        do {
+            if (node.isMaskSet(mask) === value)
+                return node;
+            node = node.faceSuccessor;
+        } while (node !== this);
+        return undefined;
+    }
+    /** Returns the first node with given mask value on this edge (i.e. examining this and this.mate)  */
+    findMaskAroundEdge(mask, value = true) {
+        if (this.isMaskSet(mask) === value)
+            return this;
+        const mate = this.edgeMate;
+        if (mate.isMaskSet(mask) === value)
+            return mate;
+        return undefined;
+    }
     /** Set a mask, and return prior value.
      * @param mask mask to apply
      */
@@ -445,6 +506,15 @@ export class HalfEdge {
         this.y = node.y;
         this.z = node.z;
     }
+    /**
+     * Set (copy) the this.x, this.y, this.z from xyz.x, xyz.y, xyz.z
+     * @param node source with x,y,z properties
+     */
+    setXYZ(xyz) {
+        this.x = xyz.x;
+        this.y = xyz.y;
+        this.z = xyz.z;
+    }
     /**
      * Test if mask bits are set in the node's bitMask.
      * @return Return true (as a simple boolean, not a mask) if any bits of the mask parameter match bits of the node's bitMask
@@ -534,6 +604,10 @@ export class HalfEdge {
         const s = `${node.id.toString()}+${HalfEdge.nodeToMaskString(node)}[${node.x},${node.y}]`;
         return s;
     }
+    /** Return the [id, [x,y],z] of a node.  Useful for collector methods. */
+    static nodeToIdXYZString(node) {
+        return `[${node.id.toString()}: ${node.x},${node.y},${node.z}]`;
+    }
     /** Create a string representation of the mask
      * * Null mask is empty string.
      * * Appended characters B,P,X for Boundary, Primary, Exterior mask bits.
@@ -558,7 +632,13 @@ export class HalfEdge {
     }
     /** Return Vector3d to face successor */
     vectorToFaceSuccessor(result) {
-        return Vector3d.create(this.faceSuccessor.x - this.x, this.faceSuccessor.y - this.y, this.faceSuccessor.z - this.z, result);
+        const other = this.faceSuccessor;
+        return Vector3d.create(other.x - this.x, other.y - this.y, other.z - this.z, result);
+    }
+    /** Return Vector3d to face successor */
+    vectorToFacePredecessor(result) {
+        const other = this.facePredecessor;
+        return Vector3d.create(other.x - this.x, other.y - this.y, other.z - this.z, result);
     }
     /** test if spaceNode is in the sector at sectorNode */
     static isNodeVisibleInSector(spaceNode, sectorNode) {
@@ -682,6 +762,14 @@ export class HalfEdge {
     static testNodeMaskNotExterior(node) { return !node.isMaskSet(HalfEdgeMask.EXTERIOR); }
     /** Returns Returns true if the node does NOT have Mask.EXTERIOR_MASK set. */
     static testMateMaskExterior(node) { return node.edgeMate.isMaskSet(HalfEdgeMask.EXTERIOR); }
+    /** Returns radians between this edge and its face predecessor edge, using all three coordinates x,y,z and given normal to resolve sweep direction.
+     *   * The returned angle is positive, i.e. may be larger than PI radians.
+    */
+    static sectorSweepRadiansXYZ(node, normal) {
+        const nodeB = node.faceSuccessor;
+        const nodeC = node.facePredecessor;
+        return Angle.orientedRadiansBetweenVectorsXYZ(nodeB.x - node.x, nodeB.y - node.y, nodeB.z - node.z, nodeC.x - node.x, nodeC.y - node.y, nodeC.z - node.z, normal.x, normal.y, normal.z, true);
+    }
     /** Returns Returns true if the face has positive area in xy parts. */
     static testFacePositiveAreaXY(node) {
         return node.countEdgesAroundFace() > 2 && node.signedFaceArea() > 0.0;
@@ -713,6 +801,26 @@ export class HalfEdge {
         } while (node !== this);
         return nodes;
     }
+    /**
+     * search around a vertex for nodes that have a specified mask setting.
+     * @param vertexSeed first node to search
+     * @param mask target mask
+     * @param value target value for mask on half edges.
+     * @param collectedNodes optional array to be cleared and receive masked nodes
+     */
+    collectMaskedEdgesAroundVertex(mask, value = true, result) {
+        if (result === undefined)
+            result = [];
+        else
+            result.length = 0;
+        let node = this;
+        do {
+            if (node.isMaskSet(mask) === value)
+                result.push(node);
+            node = node.vertexSuccessor;
+        } while (node !== this);
+        return result;
+    }
     /**
      *
      * * Evaluate f(node) at each outbound node around this node's vertex loop.
@@ -905,8 +1013,7 @@ export class HalfEdge {
      * * If the edge is horizontal with (approximate) identical y, return the node.
      * * If the edge is horizontal with different y, return undefined.
      * * If the edge is not horizontal, return the fractional position (possibly outside 0..1) of the intersection.
-     * @param nodeA Base node of edge
-     * @param result optional preallocated result
+     * @param node0 Base node of edge
      */
     static horizontalScanFraction(node0, y) {
         const node1 = node0.faceSuccessor;
@@ -921,8 +1028,7 @@ export class HalfEdge {
      * * Compute fractional coordinates of the intersection of a horizontal line with an edge.
      * * If the edge is horizontal return undefined (no test for horizontal at y!!!)
      * * If the edge is not horizontal and y is between its end y's, return the fraction
-     * @param nodeA Base node of edge
-     * @param result optional preallocated result
+     * @param node0 Base node of edge
      */
     static horizontalScanFraction01(node0, y) {
         const node1 = node0.faceSuccessor;
@@ -936,6 +1042,31 @@ export class HalfEdge {
             return fraction;
         return undefined;
     }
+    /**
+     * Copy various data from source to this.
+     * @param source other half edge.
+     * @param XYZ copy simple coordinates
+     * @param copyVertexData true to copy data belonging to the vertex. (i.e. the "i" member)
+     * @param copyVertexData true to copy data belonging to the edge. (i.e. call transferEdgeData)
+     * @param copyFaceData true to copy faceTag
+     */
+    copyDataFrom(source, copyXYZ, copyVertexData, copyEdgeData, copyFaceData) {
+        if (copyXYZ) {
+            this.x = source.x;
+            this.y = source.y;
+            this.z = source.z;
+        }
+        if (copyVertexData) {
+            this.i = source.i;
+        }
+        if (copyEdgeData) {
+            HalfEdge.transferEdgeProperties(source, this);
+            this.edgeTag = source.edgeTag;
+        }
+        if (copyFaceData) {
+            this.faceTag = source.faceTag;
+        }
+    }
 }
 HalfEdge._edgePropertyMasks = [HalfEdgeMask.BOUNDARY_EDGE, HalfEdgeMask.EXTERIOR, HalfEdgeMask.PRIMARY_EDGE, HalfEdgeMask.NULL_FACE];
 HalfEdge._totalNodesCreated = 0;
@@ -976,6 +1107,19 @@ export class HalfEdgeGraph {
         const a = HalfEdge.createHalfEdgePairWithCoordinates(xA, yA, zA, iA, xB, yB, zB, iB, this.allHalfEdges);
         return a;
     }
+    /**
+     * * Create 2 half edges forming 2 vertices, 1 edge, and 1 face
+     * * The two edges are joined as edgeMate pair.
+     * * The two edges are a 2-half-edge face loop in both the faceSuccessor and facePredecessor directions.
+     * * The two edges are added to the graph's HalfEdge set
+     * * Coordinates are set to zero.
+     * * ids are installed in the two half edges.
+     * @returns Return pointer to the first half edge created.  (This has idA as its id.)
+     */
+    createEdgeIdId(iA = 0, iB = 0) {
+        const a = HalfEdge.createHalfEdgePairWithCoordinates(0.0, 0.0, 0.0, iA, 0.0, 0.0, 0.0, iB, this.allHalfEdges);
+        return a;
+    }
     /**
      * * create an edge from coordinates x,y,z to (the tail of) an existing half edge.
      * @returns Return pointer to the half edge with tail at x,y,z
@@ -1020,6 +1164,20 @@ export class HalfEdgeGraph {
         const he = HalfEdge.splitEdge(base, xA, yA, zA, iA, this.allHalfEdges);
         return he;
     }
+    /**
+     * * Create a sliver face "within" an edge.
+     * * this creates two half edges.
+     * * The existing edges both stay in their same face loops and retain coordinates and i value.
+     * * Each existing edge's mate is a new edge (rather than original mate)
+     * * Coordinates are copied to the new edges at respective vertices.
+     * * New faceTag and edgeTag undefined.
+     * * i members are copied around their respective vertices.
+     * @returns Returns the reference to the half edge created.
+     */
+    splitEdgeCreateSliverFace(base) {
+        const he = HalfEdge.splitEdgeCreateSliverFace(base, this.allHalfEdges);
+        return he;
+    }
     /**
      * * Insert a vertex in the edge beginning at base, with coordinates specified as a fraction along the existing edge.
      * * this creates two half edges.
@@ -1157,6 +1315,26 @@ export class HalfEdgeGraph {
                 break;
         }
     }
+    /**
+       * * Visit each edge of the graph once.
+       * * Call the announceEdge function.
+       * * the edge mate will NOT appear in an announceEdge call.
+       * * continue search if announceEdge(graph, node) returns true
+       * * terminate search if announceEdge (graph, node) returns false
+       * @param  announceEdge function to apply at one node of each edge.
+       */
+    announceEdges(announceEdge) {
+        this.clearMask(HalfEdgeMask.VISITED);
+        for (const node of this.allHalfEdges) {
+            if (node.getMask(HalfEdgeMask.VISITED))
+                continue;
+            const mate = node.edgeMate;
+            node.setMask(HalfEdgeMask.VISITED);
+            mate.setMask(HalfEdgeMask.VISITED);
+            if (!announceEdge(this, node))
+                break;
+        }
+    }
     /**
      * * Visit each vertex loop of the graph once.
      * * Call the announceVertex function
@@ -1175,8 +1353,8 @@ export class HalfEdgeGraph {
         }
     }
     /**
-     * * Visit each vertex loop of the graph once.
-     * * Call the announceVertex function
+     * * Visit each half edge (node) of the graph once.
+     * * Call the announceNode function
      * * continue search if announceNode(graph, node) returns true
      * * terminate search if announce face (graph, node) returns false
      * @param  announceNode function to apply at one node of each face.