@itwin/core-geometry 3.0.0-dev.76 → 3.0.0-dev.80

package/lib/esm/topology/Graph.d.ts

@@ -0,0 +1,591 @@
+/** @packageDocumentation
+ * @module Topology
+ */
+import { LineSegment3d } from "../curve/LineSegment3d";
+import { Point2d, Vector2d } from "../geometry3d/Point2dVector2d";
+import { Point3d, Vector3d } from "../geometry3d/Point3dVector3d";
+import { Transform } from "../geometry3d/Transform";
+import { XAndY, XYAndZ } from "../geometry3d/XYZProps";
+/**
+ * * Each node of the graph has a mask member.
+ * * The mask member is a number which is used as set of single bit boolean values.
+ * * Particular meanings of the various bits are HIGHLY application dependent.
+ *   * The EXTERIOR mask bit is widely used to mark nodes that are "outside" the active areas
+ *   * The PRIMARY_EDGE bit is widely used to indicate linework created directly from input data, hence protected from triangle edge flipping.
+ *   * The BOUNDARY bit is widely used to indicate that crossing this edge is a transition from outside to inside.
+ *   * VISITED is used locally in many searches.
+ *      * Never use VISITED unless the search logic is highly self contained.
+ * @internal
+ */
+export declare enum HalfEdgeMask {
+    /**  Mask commonly set consistently around exterior faces.
+     * * A boundary edge with interior to one side, exterior to the other will have EXTERIOR only on the outside.
+     * * An an edge inserted "within a purely exterior face" can have EXTERIOR on both MediaStreamAudioDestinationNode[Symbol]
+     * * An interior edges (such as added during triangulation) will have no EXTERIOR bits.
+     */
+    EXTERIOR = 1,
+    /** Mask commonly set (on both sides) of original geometry edges that are transition from outside from to inside.
+     * * At the moment of creating an edge from primary user boundary loop coordinates, the fact that an edge is BOUNDARY is often clear even though
+     *  there is uncertainty about which side should be EXTERIOR.
+     */
+    BOUNDARY_EDGE = 2,
+    /** Mask commonly set (on both sides) of original geometry edges, but NOT indicating that the edge is certainly a boundary between outside and inside.
+     * * For instance, if geometry is provided as stray sticks (not loops), it can be marked PRIMARY_EDGE but neither BOUNDARY_EDGE nor EXTERIOR_EDGE
+     */
+    PRIMARY_EDGE = 4,
+    /** Mask used for low level searches to identify previously-visited nodes */
+    VISITED = 16,
+    /** Mask applied to triangles by earcut triangulator */
+    TRIANGULATED_FACE = 256,
+    /** mask applied in a face with 2 edges. */
+    NULL_FACE = 512,
+    /** no mask bits */
+    NULL_MASK = 0,
+    /** The "upper 12 " bits of 32 bit integer. */
+    ALL_GRAB_DROP_MASKS = 4293918720,
+    /** all mask bits */
+    ALL_MASK = 4294967295
+}
+/** function signature for function of one node with no return type restrictions
+ * @internal
+ */
+export declare type NodeFunction = (node: HalfEdge) => any;
+/** function signature for function of one node, returning a number
+ * @internal
+ */
+export declare type NodeToNumberFunction = (node: HalfEdge) => number;
+/** function signature for function of one node, returning a boolean
+ * @internal
+ */
+export declare type HalfEdgeToBooleanFunction = (node: HalfEdge) => boolean;
+/** function signature for function of a node and a mask, returning a number
+ * @internal
+ */
+export declare type HalfEdgeAndMaskToBooleanFunction = (node: HalfEdge, mask: HalfEdgeMask) => boolean;
+/** function signature for function of a graph and a node, returning a boolean
+ * @internal
+ */
+export declare type GraphNodeFunction = (graph: HalfEdgeGraph, node: HalfEdge) => boolean;
+/**
+ *
+ * * A HalfEdge is "one side of an edge" in a structure of faces, edges and vertices.  From a node there are navigational links to:
+ * ** "faceSuccessor" -- the next half edge in a loop around a face.
+ * ** "facePredecessor" -- the previous half edge in a loop around a face.
+ * ** "edgeMate"  -- the node's partner on the other side of the edge.
+ * * The next, prev, and mate are the essential connectivity.  Additional node content is for application-specific
+ *     uses.  The most useful ones are:
+ * ** x,y -- coordinates in the xy plane
+ * ** z -- z coordinate.  This is normally ignored during planar setup, but used for output.
+ * ** buffer -- a integer value manipulated as individual bits.
+ * * In properly connected planar graph, interior face loops are counterclockwise.  But that property (along with
+ *      expected masking) is a result of extensive validation of inputs, and is not true in intermediate phases
+ *      of graph manipulation.
+ * @internal
+ */
+export declare class HalfEdge {
+    /** Vertex index in some parent object's numbering. */
+    i: number;
+    /** bitmask bits, used to mark nodes as part of a triangle(idx 0) or visited when flipping(idx 1) */
+    maskBits: number;
+    /** Vertex x coordinate */
+    x: number;
+    /** Vertex y coordinate */
+    y: number;
+    /** Vertex z coordinate */
+    z: number;
+    /** angle used for sort-around-vertex */
+    sortAngle?: number;
+    /** numeric value for application-specific tagging (e.g. sorting) */
+    sortData?: number;
+    /** application-specific data for the edge identifier.
+     * * edge split operations are expected to copy this to new sub-edges.
+     */
+    edgeTag?: any;
+    private _id;
+    /** id assigned sequentially during construction --- useful for debugging. */
+    get id(): any;
+    private _facePredecessor;
+    private _faceSuccessor;
+    private _edgeMate;
+    /** previous half edge "around the face"
+     */
+    get facePredecessor(): HalfEdge;
+    /** next half edge "around the face" */
+    get faceSuccessor(): HalfEdge;
+    /** Half edge on the other side of this edge.
+     */
+    get edgeMate(): HalfEdge;
+    /** Take numStep face steps and return y coordinate
+     * * positive steps are through faceSuccessor
+     * * negative steps are through facePredecessor
+     */
+    faceStepY(numStep: number): number;
+    /**
+     * * Create 2 half edges.
+     * * 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.
+     * @returns Returns the reference to the first half edge created
+     */
+    static createHalfEdgePair(heArray: HalfEdge[] | undefined): HalfEdge;
+    /**
+     * * Create 2 half edges.
+     * * 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.
+     * * Properties x,y,z,i are inserted in each
+     * @returns Returns the reference to the first half edge created
+     */
+    static createHalfEdgePairWithCoordinates(xA: number | undefined, yA: number | undefined, zA: number | undefined, iA: number | undefined, xB: number | undefined, yB: number | undefined, zB: number | undefined, iB: number | undefined, heArray: HalfEdge[] | undefined): HalfEdge;
+    /**
+     * * set heA <==> heB pointer relation through heA._faceSuccessor and heB._facePredecessor
+     * * This changes heA._faceSuccessor and heB._facePredecessor, but not heA._facePredecessor and heB._faceSuccessor.
+     * * this must always be done with another call to reestablish the entire double-linked list.
+     */
+    private static setFaceLinks;
+    /**
+     * * set heA <==> heB pointer relation edgeMate
+     */
+    private static setEdgeMates;
+    /**
+     * * Create a new vertex within the edge from base.
+     * * 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.
+     * * on each side, if edgeTag is present it is copied to the new edge.
+     * @returns Returns the reference to the half edge created.
+     */
+    static splitEdge(baseA: undefined | HalfEdge, xA: number | undefined, yA: number | undefined, zA: number | undefined, iA: number | undefined, heArray: HalfEdge[] | undefined): HalfEdge;
+    private static _edgePropertyMasks;
+    /**
+     * Copy "edge based" content of fromNode to toNode
+     * * edgeTag
+     * * masks in _edgePropertyMasks: EXTERIOR, BOUNDARY_EDGE, NULL_FACE, PRIMARY_EDGE
+     * @param fromNode
+     * @param toNode
+     */
+    static transferEdgeProperties(fromNode: HalfEdge, toNode: HalfEdge): void;
+    private static _totalNodesCreated;
+    constructor(x?: number, y?: number, z?: number, i?: number);
+    /**
+     * Return the next outbound half edge around this vertex in the CCW direction
+     */
+    get vertexSuccessor(): HalfEdge;
+    /**
+     * Return the next outbound half edge around this vertex in the CW direction
+     */
+    get vertexPredecessor(): HalfEdge;
+    /**
+     * Set mask bits on this HalfEdge
+     * @param mask mask to apply
+     */
+    setMask(mask: HalfEdgeMask): void;
+    /**
+     * Get mask bits from this HalfEdge
+     * @param mask mask to query
+     */
+    getMask(mask: HalfEdgeMask): number;
+    /**
+     * Clear mask bits from this HalfEdge
+     * @param mask mask to clear
+     */
+    clearMask(mask: HalfEdgeMask): void;
+    /**
+     * Set a mask at all nodes around a vertex.
+     * @param mask mask to apply to the half edges around this HalfEdge's vertex loop
+     */
+    setMaskAroundVertex(mask: HalfEdgeMask): void;
+    /**
+     * Set x,y,z at all nodes around a vertex.
+     * @param mask mask to apply to the half edges around this HalfEdge's vertex loop
+     */
+    setXYZAroundVertex(x: number, y: number, z: number): void;
+    /**
+     * Apply a mask to all edges around a face.
+     * @param mask mask to apply to the half edges around this HalfEdge's face loop
+     */
+    setMaskAroundFace(mask: HalfEdgeMask): void;
+    /**
+     * Apply a mask to both sides of an edge.
+     * @param mask mask to apply to this edge and its `edgeMate`
+     */
+    setMaskAroundEdge(mask: HalfEdgeMask): void;
+    /**
+     * Apply a mask to both sides of an edge.
+     * @param mask mask to apply to this edge and its `edgeMate`
+     */
+    clearMaskAroundEdge(mask: HalfEdgeMask): void;
+    /** Returns the number of edges around this face. */
+    countEdgesAroundFace(): number;
+    /** Return true of other is in the vertex loop around this. */
+    findAroundVertex(other: HalfEdge): boolean;
+    /** Return true of other is in the face loop around this. */
+    findAroundFace(other: HalfEdge): boolean;
+    /**
+     * Apply a edgeTag and mask to all edges around a face.
+     * optionally apply it to all edge mates.
+     * @param edgeTag tag to apply
+     * @param bothSides If true, also apply the tag to the mates around the face.
+     */
+    setMaskAndEdgeTagAroundFace(mask: HalfEdgeMask, tag: any, applyToMate?: boolean): void;
+    /** Returns the number of edges around vertex. */
+    countEdgesAroundVertex(): number;
+    /** Returns the number of nodes found with the given mask value around this vertex loop. */
+    countMaskAroundFace(mask: HalfEdgeMask, value?: boolean): number;
+    /** Returns the number of nodes found with the given mask value around this vertex loop.   */
+    countMaskAroundVertex(mask: HalfEdgeMask, value?: boolean): number;
+    /** Set a mask, and return prior value.
+     * @param mask mask to apply
+     */
+    testAndSetMask(mask: HalfEdgeMask): number;
+    /**
+     * Set (copy) the this.x, this.y, this.z from node.x, node.y, node.z
+     * @param node node containing xyz
+     */
+    setXYZFrom(node: HalfEdge): void;
+    /**
+     * 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
+     */
+    isMaskSet(mask: HalfEdgeMask): boolean;
+    /** (static!) method to test if a mask is set on a node.
+     * This is used as filter in searches.
+     * @returns true iff `node.isMaskSet (mask)`
+     */
+    static filterIsMaskOn(node: HalfEdge, mask: HalfEdgeMask): boolean;
+    /** (static!) method to test if a mask is set on a node.
+     * This is used as filter in searches.
+     * @returns true iff `!node.isMaskSet (mask)`
+     */
+    static filterIsMaskOff(node: HalfEdge, mask: HalfEdgeMask): boolean;
+    /**
+     * Create an edge with initial id,x,y at each end.
+     * @param id0 id for first node
+     * @param x0  x coordinate for first node
+     * @param y0  y coordinate for first node
+     * @param id1 id for second node
+     * @param x1 x coordinate for second node
+     * @param y1 y coordinate for second node
+     */
+    static createEdgeXYXY(id0: any, x0: number, y0: number, id1: any, x1: number, y1: number): HalfEdge;
+    /** "pinch" ...
+     *
+     * * is the universal manipulator for manipulating a node's next and prev pointers
+     * * swaps face predecessors of nodeA and nodeB.
+     * *  is its own inverse.
+     * *  if nodeA, nodeB are in different face loops, the loops join to one loop.
+     * *  if nodeA, nodeB are in the same face loop, the loop splits into two loops.
+     */
+    static pinch(nodeA: HalfEdge, nodeB: HalfEdge): void;
+    /**
+     * Pinch this half edge out of its base vertex loop.
+     * * if this  the half edge (possibly undefined)
+     */
+    yankFromVertexLoop(): HalfEdge | undefined;
+    /** Turn all pointers to undefined so garbage collector can reuse the object.
+     *  This is to be called only by a Graph object that is being decommissioned.
+     */
+    decommission(): void;
+    /** Return the node. This identity function is useful as the NodeFunction in collector methods. */
+    static nodeToSelf(node: HalfEdge): any;
+    /** Return the id of a node.  Useful for collector methods. */
+    static nodeToId(node: HalfEdge): any;
+    /** Return the id of a node.Useful for collector methods. */
+    static nodeToIdString(node: HalfEdge): any;
+    /** Return the [id, [x,y]] of a node.  Useful for collector methods. */
+    static nodeToIdMaskXY(node: HalfEdge): {
+        id: any;
+        mask: any;
+        xy: number[];
+    };
+    /** Return the [id, [x,y]] of a node.  Useful for collector methods. */
+    static nodeToIdXYString(node: HalfEdge): string;
+    /** Create a string representation of the mask
+     * * Null mask is empty string.
+     * * Appended characters B,P,X for Boundary, Primary, Exterior mask bits.
+     */
+    static nodeToMaskString(node: HalfEdge): string;
+    /** Return [x,y] with coordinates of node */
+    static nodeToXY(node: HalfEdge): number[];
+    /** Return Vector2d to face successor, with only xy coordinates */
+    vectorToFaceSuccessorXY(result?: Vector2d): Vector2d;
+    /** Return Vector3d to face successor */
+    vectorToFaceSuccessor(result?: Vector3d): Vector3d;
+    /** test if spaceNode is in the sector at sectorNode */
+    static isNodeVisibleInSector(spaceNode: HalfEdge, sectorNode: HalfEdge): boolean;
+    /** Returns Return cross product (2d) of vectors from baseA to targetA and baseB to targetB */
+    static crossProductXYToTargets(base: HalfEdge, targetA: HalfEdge, targetB: HalfEdge): number;
+    /** Returns Return dot product (2d) of vectors along two edges. */
+    static dotProductNodeToNodeVectorsXY(baseA: HalfEdge, targetA: HalfEdge, baseB: HalfEdge, targetB: HalfEdge): number;
+    /** Return cross product (2d) of vectors from nodeA to nodeB and nodeB to nodeC
+     */
+    static crossProductXYAlongChain(nodeA: HalfEdge, nodeB: HalfEdge, nodeC: HalfEdge): number;
+    /** Return true if `this` is lexically below `other`, comparing y first then x. */
+    belowYX(other: HalfEdge): boolean;
+    /** Returns Returns true if the node does NOT have Mask.EXTERIOR_MASK set. */
+    static testNodeMaskNotExterior(node: HalfEdge): boolean;
+    /** Returns Returns true if the node does NOT have Mask.EXTERIOR_MASK set. */
+    static testMateMaskExterior(node: HalfEdge): boolean;
+    /** Returns Returns true if the face has positive area in xy parts. */
+    static testFacePositiveAreaXY(node: HalfEdge): boolean;
+    /** Return true if x and y coordinates of this and other are exactly equal */
+    isEqualXY(other: XAndY): boolean;
+    /** Return true if x and y coordinates of this and other are exactly equal */
+    distanceXY(other: HalfEdge): number;
+    /** Return true if x and y coordinates of this and other are exactly equal */
+    distanceXYZ(other: HalfEdge): number;
+    /**
+     *
+     * * Evaluate f(node) at each node around a face loop.
+     * * Collect the function values.
+     * @returns Return the array of function values.
+     */
+    collectAroundFace(f?: NodeFunction): any[];
+    /**
+     *
+     * * Evaluate f(node) at each outbound node around this node's vertex loop.
+     * * Collect the function values.
+     * @returns Return the array of function values.
+     */
+    collectAroundVertex(f?: NodeFunction): any[];
+    /**
+     *
+     * * Evaluate f(node) at each node around a face loop.
+     * * Sum the function values
+     * @returns Return the sum
+     */
+    sumAroundFace(f: NodeToNumberFunction): number;
+    /**
+     *
+     * * Evaluate f(node) at each outbound node around this node's vertex loop.
+     * * Sum the function values
+     * @returns Return the sum
+     */
+    sumAroundVertex(f: NodeToNumberFunction): number;
+    /** For all the nodes in the face loop of the given node, clear out the mask given */
+    clearMaskAroundFace(mask: HalfEdgeMask): void;
+    /** For all the nodes in the vertex loop of the given node, clear out the mask given */
+    clearMaskAroundVertex(mask: HalfEdgeMask): void;
+    /** Returns the signed sum of xy areas of triangles from first node to edges.
+     *
+     * * A positive area is counterclockwise.
+     * * A negative area is clockwise.
+     */
+    signedFaceArea(): number;
+    /**
+     * interpolate xy coordinates between this node and its face successor.
+     * @param fraction fractional position along this edge.
+     * @param result xy coordinates
+     */
+    fractionToPoint2d(fraction: number, result?: Point2d): Point2d;
+    /**
+     * interpolate xy coordinates between this node and its face successor.
+     * @param fraction fractional position along this edge.
+     * @param result xy coordinates
+     */
+    fractionToPoint3d(fraction: number, result?: Point3d): Point3d;
+    /**
+     * * interpolate xy coordinates at fractionAlong between this node and its face successor.
+     * * shift to left by fractionPerpendicular
+     * @param fraction fractional position along this edge.
+     * @param result xy coordinates
+     */
+    fractionAlongAndPerpendicularToPoint2d(fractionAlong: number, fractionPerpendicular: number, result?: Point2d): Point2d;
+    /**
+     * return the 3d coordinates at this half edge base
+     */
+    getPoint3d(result?: Point3d): Point3d;
+    /**
+     * return the 2d coordinates at this half edge base
+     */
+    getPoint2d(result?: Point2d): Point2d;
+    /**
+     * return a 3d vector from start to end of this half edge.
+     */
+    getVector3dAlongEdge(result?: Vector3d): Vector3d;
+    /**
+     * return a 2d vector from start to end of this half edge
+     */
+    getVector2dAlongEdge(result?: Vector2d): Vector2d;
+    /**
+     * Return the interpolated x coordinate between this node and its face successor.
+     * @param fraction fractional position along this edge.
+     */
+    fractionToX(fraction: number): number;
+    /**
+     * Return the interpolated y coordinate between this node and its face successor.
+     * @param fraction fractional position along this edge.
+     */
+    fractionToY(fraction: number): number;
+    /**
+     * Return the interpolated z coordinate between this node and its face successor.
+     * @param fraction fractional position along this edge.
+     */
+    fractionToZ(fraction: number): number;
+    /**
+     * * Compute fractional coordinates of the intersection of edges from given base nodes
+     * * If parallel or colinear, return undefined.
+     * * If (possibly extended) lines intersect, return the fractions of intersection as x,y in the result.
+     * @param nodeA0 Base node of edge A
+     * @param nodeB0 Base node of edge B
+     * @param result optional preallocated result
+     */
+    static transverseIntersectionFractions(nodeA0: HalfEdge, nodeB0: HalfEdge, result?: Vector2d): Vector2d | undefined;
+    /**
+     * * Compute fractional coordinates of the intersection of a horizontal line with an edge.
+     * * 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
+     */
+    static horizontalScanFraction(node0: HalfEdge, y: number): number | undefined | 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
+     */
+    static horizontalScanFraction01(node0: HalfEdge, y: number): number | undefined;
+}
+/**
+ * A HalfEdgeGraph has:
+ * * An array of (pointers to ) HalfEdge objects.
+ * * A pool of masks for grab/drop use by algorithms.
+ * @internal
+ */
+export declare class HalfEdgeGraph {
+    /** Simple array with pointers to all the half edges in the graph. */
+    allHalfEdges: HalfEdge[];
+    private _maskManager;
+    private _numNodesCreated;
+    constructor();
+    /** Ask for a mask (from the graph's free pool.) for caller's use.
+     * * Optionally clear the mask throughout the graph.
+     */
+    grabMask(clearInAllHalfEdges?: boolean): HalfEdgeMask;
+    /**
+     * Return `mask` to the free pool.
+     */
+    dropMask(mask: HalfEdgeMask): void;
+    /**
+     * * 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
+     * @returns Return pointer to the first half edge created.
+     */
+    createEdgeXYZXYZ(xA?: number, yA?: number, zA?: number, iA?: number, xB?: number, yB?: number, zB?: number, iB?: number): HalfEdge;
+    /**
+     * * 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
+     */
+    createEdgeXYZHalfEdge(xA: number | undefined, yA: number | undefined, zA: number | undefined, iA: number | undefined, node: HalfEdge, iB?: number): HalfEdge;
+    /**
+     * * 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
+     */
+    createEdgeHalfEdgeHalfEdge(nodeA: HalfEdge, idA: number, nodeB: HalfEdge, idB?: number): HalfEdge;
+    /**
+     * * 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
+     * @returns Return pointer to the first half edge created.
+     */
+    createEdgeXYAndZ(xyz0: XYAndZ, id0: number, xyz1: XYAndZ, id1: number): HalfEdge;
+    /**
+     * * Insert a vertex in the edge beginning at base.
+     * * this creates two half edges.
+     * * The base of the new edge is 'after' the (possibly undefined) start node in its face loop.
+     * * The existing mate retains its base xyz and i properties but is no longer the mate of base.
+     * * The base and existing mate each become mates with a new half edge.
+     * @returns Returns the reference to the half edge created.
+     */
+    splitEdge(base: undefined | HalfEdge, xA?: number, yA?: number, zA?: number, iA?: number): HalfEdge;
+    /**
+     * * Insert a vertex in the edge beginning at base, with coordinates specified as a fraction along the existing edge.
+     * * this creates two half edges.
+     * * The base of the new edge is 'after' the (possibly undefined) start node in its face loop.
+     * * The existing mate retains its base xyz and i properties but is no longer the mate of base.
+     * * The base and existing mate each become mates with a new half edge.
+     * @returns Returns the reference to the half edge created.
+     */
+    splitEdgeAtFraction(base: HalfEdge, fraction: number): HalfEdge;
+    /** This is a destructor-like action that eliminates all interconnection among the graph's nodes.
+     * After this is called the graph is unusable.
+     */
+    decommission(): void;
+    /** create two nodes of a new edge.
+     * @returns Return one of the two nodes, which the caller may consider as the start of the edge.
+     */
+    addEdgeXY(x0: number, y0: number, x1: number, y1: number): HalfEdge;
+    /** Clear selected bits in all nodes of the graph. */
+    clearMask(mask: HalfEdgeMask): void;
+    /** Set selected bits in all nodes of the graph. */
+    setMask(mask: HalfEdgeMask): void;
+    /** toggle selected bits in all nodes of the graph. */
+    reverseMask(mask: HalfEdgeMask): void;
+    /**
+     * Return the number of nodes that have a specified mask bit set.
+     * @param mask mask to count
+     */
+    countMask(mask: HalfEdgeMask): number;
+    /** Return an array LineSegment3d.
+     * * The array has one segment per edge
+     * * The coordinates are taken from a node and its face successor.
+     * * On each edge, the line segment start at the HalfEdge with lower id than its edgeMate.
+     */
+    collectSegments(): LineSegment3d[];
+    /** Returns the number of vertex loops in a graph structure */
+    countVertexLoops(): number;
+    /** Returns the number of face loops */
+    countFaceLoops(): number;
+    /**
+     * Returns the number of face loops satisfying a filter function with mask argument.
+     *
+     */
+    countFaceLoopsWithMaskFilter(filter: HalfEdgeAndMaskToBooleanFunction, mask: HalfEdgeMask): number;
+    /** Returns an array of nodes, where each node represents a starting point of a face loop.
+     */
+    collectFaceLoops(): HalfEdge[];
+    /** Returns an array of nodes, where each node represents a starting point of a vertex loop.
+     */
+    collectVertexLoops(): HalfEdge[];
+    /**
+     * * Visit each facet of the graph once.
+     * * Call the announceFace function
+     * * continue search if announceFace(graph, node) returns true
+     * * terminate search if announce face (graph, node) returns false
+     * @param  announceFace function to apply at one node of each face.
+     */
+    announceFaceLoops(announceFace: GraphNodeFunction): void;
+    /**
+     * * Visit each vertex loop of the graph once.
+     * * Call the announceVertex function
+     * * continue search if announceVertex(graph, node) returns true
+     * * terminate search if announce vertex (graph, node) returns false
+     * @param  announceVertex function to apply at one node of each face.
+     */
+    announceVertexLoops(announceVertex: GraphNodeFunction): void;
+    /**
+     * * Visit each vertex loop of the graph once.
+     * * Call the announceVertex 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.
+     */
+    announceNodes(announceNode: GraphNodeFunction): void;
+    /** Return the number of nodes in the graph */
+    countNodes(): number;
+    /** Apply transform to the xyz coordinates in the graph. */
+    transformInPlace(transform: Transform): void;
+    /**
+     * disconnect and delete all nodes that satisfy a filter condition.
+     * @param deleteThisNode returns true to delete the node given.
+     * @returns the number of nodes deleted.
+     */
+    yankAndDeleteEdges(deleteThisNode: NodeFunction): number;
+}
+//# sourceMappingURL=Graph.d.ts.map

package/lib/esm/topology/Graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Graph.d.ts","sourceRoot":"","sources":["../../../src/topology/Graph.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AASvD;;;;;;;;;;GAUG;AACH,oBAAY,YAAY;IACtB;;;;OAIG;IACH,QAAQ,IAAa;IACrB;;;OAGG;IACH,aAAa,IAAa;IAS1B;;OAEG;IACH,YAAY,IAAa;IAEzB,4EAA4E;IAC5E,OAAO,KAAY;IAEnB,uDAAuD;IACvD,iBAAiB,MAAa;IAC9B,2CAA2C;IAC3C,SAAS,MAAa;IAEtB,mBAAmB;IACnB,SAAS,IAAa;IACtB,8CAA8C;IAC9C,mBAAmB,aAAa;IAChC,oBAAoB;IACpB,QAAQ,aAAa;CAMtB;AAED;;GAEG;AACH,oBAAY,YAAY,GAAG,CAAC,IAAI,EAAE,QAAQ,KAAK,GAAG,CAAC;AACnD;;GAEG;AACH,oBAAY,oBAAoB,GAAG,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC;AAC9D;;GAEG;AACH,oBAAY,yBAAyB,GAAG,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC;AACpE;;GAEG;AACH,oBAAY,gCAAgC,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC;AAC/F;;GAEG;AACH,oBAAY,iBAAiB,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC;AAClF;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,QAAQ;IACnB,sDAAsD;IAC/C,CAAC,EAAE,MAAM,CAAC;IACjB,oGAAoG;IAC7F,QAAQ,EAAE,MAAM,CAAC;IACxB,0BAA0B;IACnB,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IACnB,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IACnB,CAAC,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC1B,oEAAoE;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACI,OAAO,CAAC,EAAE,GAAG,CAAC;IACrB,OAAO,CAAC,GAAG,CAAM;IACjB,6EAA6E;IAC7E,IAAW,EAAE,QAAuB;IACpC,OAAO,CAAC,gBAAgB,CAAW;IACnC,OAAO,CAAC,cAAc,CAAW;IACjC,OAAO,CAAC,SAAS,CAAW;IAC5B;OACG;IACH,IAAW,eAAe,IAAI,QAAQ,CAAkC;IACxE,uCAAuC;IACvC,IAAW,aAAa,IAAI,QAAQ,CAAgC;IACpE;OACG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAA2B;IAC1D;;;OAGG;IACI,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAQzC;;;;;OAKG;WACW,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,SAAS,GAAG,QAAQ;IAc3E;;;;;;OAMG;WACW,iCAAiC,CAC7C,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,OAAO,EAAE,QAAQ,EAAE,GAAG,SAAS,GAAG,QAAQ;IAO5C;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAI3B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAK3B;;;;;;;;;OASG;WACW,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,QAAQ,EACjD,EAAE,oBAAY,EAAE,EAAE,oBAAY,EAAE,EAAE,oBAAY,EAAE,EAAE,oBAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,SAAS,GAAG,QAAQ;IA2B5G,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0H;IAC3J;;;;;;OAMG;WACW,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ;IASzE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAK;gBACnB,CAAC,GAAE,MAAU,EAAE,CAAC,GAAE,MAAU,EAAE,CAAC,GAAE,MAAU,EAAE,CAAC,GAAE,MAAU;IAiB7E;;OAEG;IACH,IAAW,eAAe,IAAI,QAAQ,CAA0C;IAChF;;OAEG;IACH,IAAW,iBAAiB,IAAI,QAAQ,CAAwC;IAChF;;;OAGG;IACI,OAAO,CAAC,IAAI,EAAE,YAAY;IACjC;;;OAGG;IACI,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM;IAC1C;;;OAGG;IACI,SAAS,CAAC,IAAI,EAAE,YAAY;IACnC;;;OAGG;IACI,mBAAmB,CAAC,IAAI,EAAE,YAAY;IAQ7C;;;OAGG;IACI,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAOzD;;;OAGG;IACI,iBAAiB,CAAC,IAAI,EAAE,YAAY;IAQ3C;;;OAGG;IACI,iBAAiB,CAAC,IAAI,EAAE,YAAY;IAK3C;;;OAGG;IACI,mBAAmB,CAAC,IAAI,EAAE,YAAY;IAK7C,oDAAoD;IAC7C,oBAAoB,IAAI,MAAM;IASvC,8DAA8D;IACrD,gBAAgB,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAUnD,4DAA4D;IACrD,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAU7C;;;;;OAKG;IACI,2BAA2B,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,GAAE,OAAe;IAc7F,iDAAiD;IAC1C,sBAAsB,IAAI,MAAM;IAUvC,2FAA2F;IACpF,mBAAmB,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,GAAE,OAAc,GAAG,MAAM;IAiB7E,6FAA6F;IACtF,qBAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,GAAE,OAAc,GAAG,MAAM;IAiB/E;;OAEG;IACI,cAAc,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM;IAKjD;;;OAGG;IACI,UAAU,CAAC,IAAI,EAAE,QAAQ;IAMhC;;;OAGG;IACI,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO;IAE7C;;;OAGG;WACW,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO;IAGzE;;;OAGG;WACW,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO;IAI1E;;;;;;;;OAQG;WACW,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,QAAQ;IAU1G;;;;;;;OAOG;WACW,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ;IAWpD;;;OAGG;IACI,kBAAkB,IAAI,QAAQ,GAAG,SAAS;IAQjD;;OAEG;IACI,YAAY;IAMnB,kGAAkG;WACpF,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,GAAG;IAC7C,8DAA8D;WAChD,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,GAAG;IAC3C,4DAA4D;WAC9C,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,GAAG;IAEjD,uEAAuE;WACzD,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG;QAAE,EAAE,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,GAAG,CAAC;QAAC,EAAE,EAAE,MAAM,EAAE,CAAA;KAAE;IAGlF,uEAAuE;WACzD,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;IAKtD;;;OAGG;WACW,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;IAQtD,4CAA4C;WAC9B,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,EAAE;IAChD,kEAAkE;IAC3D,uBAAuB,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ;IAG3D,wCAAwC;IACjC,qBAAqB,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ;IAOzD,uDAAuD;WACzC,qBAAqB,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,GAAG,OAAO;IAgDvF,8FAA8F;WAChF,uBAAuB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAG,MAAM;IAMnG,kEAAkE;WACpD,6BAA6B,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,GAAG,MAAM;IAM3H;OACG;WACW,wBAAwB,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,GAAG,MAAM;IAKjG,kFAAkF;IAC3E,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAcxC,6EAA6E;WAC/D,uBAAuB,CAAC,IAAI,EAAE,QAAQ;IAEpD,6EAA6E;WAC/D,oBAAoB,CAAC,IAAI,EAAE,QAAQ;IAEjD,sEAAsE;WACxD,sBAAsB,CAAC,IAAI,EAAE,QAAQ;IAInD,6EAA6E;IACtE,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAIvC,6EAA6E;IACtE,UAAU,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAI1C,6EAA6E;IACtE,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAG3C;;;;;OAKG;IACI,iBAAiB,CAAC,CAAC,CAAC,EAAE,YAAY,GAAG,GAAG,EAAE;IAUjD;;;;;OAKG;IACI,mBAAmB,CAAC,CAAC,CAAC,EAAE,YAAY,GAAG,GAAG,EAAE;IAUnD;;;;;OAKG;IACI,aAAa,CAAC,CAAC,EAAE,oBAAoB,GAAG,MAAM;IAUrD;;;;;OAKG;IACI,eAAe,CAAC,CAAC,EAAE,oBAAoB,GAAG,MAAM;IASvD,qFAAqF;IAC9E,mBAAmB,CAAC,IAAI,EAAE,YAAY;IAQ7C,uFAAuF;IAChF,qBAAqB,CAAC,IAAI,EAAE,YAAY;IAO/C;;;;OAIG;IACI,cAAc,IAAI,MAAM;IAwB/B;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAOrE;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAQrE;;;;;OAKG;IACI,sCAAsC,CAAC,aAAa,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAU9H;;OAEG;IACI,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAG5C;;OAEG;IACI,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAG5C;;OAEG;IACI,oBAAoB,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ;IAKxD;;OAEG;IACI,oBAAoB,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ;IAIxD;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAK5C;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;;;;OAOG;WACW,+BAA+B,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAa1H;;;;;;;OAOG;WACW,sBAAsB,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ;IAU/F;;;;;;OAMG;WACW,wBAAwB,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAYvF;AACD;;;;;GAKG;AACH,qBAAa,aAAa;IACxB,qEAAqE;IAC9D,YAAY,EAAE,QAAQ,EAAE,CAAC;IAChC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,gBAAgB,CAAK;;IAK7B;;OAEG;IACI,QAAQ,CAAC,mBAAmB,GAAE,OAAc,GAAG,YAAY;IAOlE;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,YAAY;IAClC;;;;;;OAMG;IACI,gBAAgB,CACrB,EAAE,GAAE,MAAU,EACd,EAAE,GAAE,MAAU,EACd,EAAE,GAAE,MAAU,EACd,EAAE,GAAE,MAAU,EACd,EAAE,GAAE,MAAU,EACd,EAAE,GAAE,MAAU,EACd,EAAE,GAAE,MAAU,EACd,EAAE,GAAE,MAAU,GAAG,QAAQ;IAI3B;;;OAGG;IACI,qBAAqB,CAC1B,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,EAAE,oBAAY,EACd,IAAI,EAAE,QAAQ,EACd,EAAE,GAAE,MAAU,GAAG,QAAQ;IAM3B;;;OAGG;IACI,0BAA0B,CAC/B,KAAK,EAAE,QAAQ,EACf,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,QAAQ,EACf,GAAG,GAAE,MAAU,GAAG,QAAQ;IAQ5B;;;;;;OAMG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ;IAKvF;;;;;;;OAOG;IACI,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,QAAQ,EACzC,EAAE,GAAE,MAAU,EAAE,EAAE,GAAE,MAAU,EAAE,EAAE,GAAE,MAAU,EAAE,EAAE,GAAE,MAAU,GAAG,QAAQ;IAK3E;;;;;;;OAOG;IACI,mBAAmB,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,QAAQ;IAItE;;OAEG;IACI,YAAY;IAKnB;;OAEG;IACI,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,QAAQ;IAQ1E,qDAAqD;IAC9C,SAAS,CAAC,IAAI,EAAE,YAAY;IAInC,mDAAmD;IAC5C,OAAO,CAAC,IAAI,EAAE,YAAY;IAIjC,sDAAsD;IAC/C,WAAW,CAAC,IAAI,EAAE,YAAY;IAKrC;;;OAGG;IACI,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM;IAO5C;;;;OAIG;IACI,eAAe,IAAI,aAAa,EAAE;IASzC,8DAA8D;IACvD,gBAAgB,IAAI,MAAM;IAOjC,uCAAuC;IAChC,cAAc,IAAI,MAAM;IAM/B;;;OAGG;IACI,4BAA4B,CAAC,MAAM,EAAE,gCAAgC,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM;IAWzG;OACG;IACI,gBAAgB,IAAI,QAAQ,EAAE;IAOrC;OACG;IACI,kBAAkB,IAAI,QAAQ,EAAE;IAavC;;;;;;OAMG;IACI,iBAAiB,CAAC,YAAY,EAAE,iBAAiB;IAWxD;;;;;;OAMG;IACI,mBAAmB,CAAC,cAAc,EAAE,iBAAiB;IAU5D;;;;;;OAMG;IACI,aAAa,CAAC,YAAY,EAAE,iBAAiB;IAOpD,8CAA8C;IACvC,UAAU,IAAI,MAAM;IAC3B,2DAA2D;IACpD,gBAAgB,CAAC,SAAS,EAAE,SAAS;IAK5C;;;;OAIG;IACI,kBAAkB,CAAC,cAAc,EAAE,YAAY,GAAG,MAAM;CAkBhE"}