@itwin/core-geometry 4.0.0-dev.22 → 4.0.0-dev.24

package/lib/cjs/polyface/FacetLocationDetail.d.ts

@@ -0,0 +1,264 @@
+/** @packageDocumentation
+ * @module Polyface
+ */
+import { Point2d } from "../geometry3d/Point2dVector2d";
+import { Point3d, Vector3d } from "../geometry3d/Point3dVector3d";
+import { TriangleLocationDetail } from "../geometry3d/BarycentricTriangle";
+import { PolygonLocation } from "../Geometry";
+import { PolyfaceVisitor } from "./Polyface";
+import { PolygonLocationDetail } from "../geometry3d/PolygonOps";
+import { IndexedXYZCollection } from "../geometry3d/IndexedXYZCollection";
+import { IndexedXYCollection } from "../geometry3d/IndexedXYCollection";
+/** Callback for processing the detail for an intersected facet.
+ * @param detail reference to the intersection data, with `detail.IsInsideOn === true`. Note that `detail` is owned by the caller; to persist, use `detail.clone`.
+ * @param visitor at currently intersected facet
+ * @returns true to accept this intersection and stop processing; false to continue to the next facet
+ */
+export declare type FacetIntersectCallback = (detail: FacetLocationDetail, visitor: PolyfaceVisitor) => boolean;
+/** Options for computing and processing facet intersection methods.
+ * @see PolyfaceQuery.intersectRay3d
+ */
+export declare class FacetIntersectOptions {
+    /** distance tolerance for testing coincidence with facet boundary */
+    distanceTolerance: number;
+    /** fractional tolerance for snapping barycentric coordinates to a triangular facet edge */
+    parameterTolerance: number;
+    /** whether to compute the normal at the intersection point */
+    needNormal?: boolean;
+    /** whether to compute the uv parameter at the intersection point */
+    needParam?: boolean;
+    /** whether to compute the color at the intersection point */
+    needColor?: boolean;
+    /** whether to compute the barycentric coordinates of the point for a convex facet */
+    needBarycentricCoordinates?: boolean;
+    /** optional callback to accept an intersected facet */
+    acceptIntersection?: FacetIntersectCallback;
+    /** constructor with defaults */
+    constructor();
+}
+/**
+ * Carries data about a point in the plane of a facet of a mesh.
+ * @see PolyfaceQuery.intersectRay3d
+ * @public
+ */
+export interface FacetLocationDetail {
+    /** Get the index of the referenced facet. */
+    get facetIndex(): number;
+    /** Get the number of edges of this facet. */
+    get edgeCount(): number;
+    /** Get the world coordinates of the point. */
+    get point(): Point3d;
+    /** Get the application-specific number. */
+    get a(): number;
+    /** Get the projection of the point onto the closest facet edge. */
+    get closestEdge(): {
+        startVertexIndex: number;
+        edgeParam: number;
+    };
+    /** Whether this instance specifies a valid location. */
+    get isValid(): boolean;
+    /** Whether the facet is convex. */
+    get isConvex(): boolean;
+    /** Whether the point is inside or on the facet. */
+    get isInsideOrOn(): boolean;
+    /** Get the code that classifies the location of the point with respect to the facet. */
+    get classify(): PolygonLocation;
+    /** Clone the instance */
+    clone(): FacetLocationDetail;
+    /** Set the instance contents from the other detail */
+    copyContentsFrom(other: FacetLocationDetail): void;
+    /** Get reference to cached normal interpolated from facet data. Inputs may be used to compute the cache. */
+    getNormal(facetNormals?: IndexedXYZCollection, facetVertices?: IndexedXYZCollection, distanceTolerance?: number): Vector3d | undefined;
+    /** Get reference to cached uv parameter interpolated from facet data. Inputs may be used to compute the cache. */
+    getParam(facetParams?: IndexedXYCollection, facetVertices?: IndexedXYZCollection, distanceTolerance?: number): Point2d | undefined;
+    /** Get cached color interpolated from facet data. Inputs may be used to compute the cache. */
+    getColor(facetColors?: number[], facetVertices?: IndexedXYZCollection, distanceTolerance?: number): number | undefined;
+    /** Get reference to cached barycentric coordinates of the point. Inputs may be used to compute the cache. */
+    getBarycentricCoordinates(facetVertices?: IndexedXYZCollection, distanceTolerance?: number): number[] | undefined;
+}
+/**
+ * Implementation of `FacetLocationDetail` for a triangular facet.
+ * @public
+ */
+export declare class TriangularFacetLocationDetail implements FacetLocationDetail {
+    private _facetIndex;
+    private _detail;
+    private _normal?;
+    private _param?;
+    private _color?;
+    /** captures the detail if provided */
+    private constructor();
+    /** Invalidate this detail. */
+    invalidate(deep?: boolean): void;
+    /** Create a detail.
+     * @param result optional pre-allocated object to fill and return
+     */
+    static create(facetIndex: number, detail?: TriangleLocationDetail, result?: TriangularFacetLocationDetail): TriangularFacetLocationDetail;
+    /** Get the facet index. */
+    get facetIndex(): number;
+    /** Get the edge count of this facet. */
+    get edgeCount(): number;
+    /** Get the world coordinates of the point. */
+    get point(): Point3d;
+    /** Get the application-specific number. */
+    get a(): number;
+    /** Get the projection of the point onto the closest facet edge. */
+    get closestEdge(): {
+        startVertexIndex: number;
+        edgeParam: number;
+    };
+    /** Test validity of fields other than _detail. */
+    private get _isValid();
+    /** Whether this instance specifies a valid location. */
+    get isValid(): boolean;
+    /** Whether the facet is convex. */
+    get isConvex(): boolean;
+    /** Whether the point is inside or on the polygon. */
+    get isInsideOrOn(): boolean;
+    /** Get the code that classifies the location of the point with respect to the facet. */
+    get classify(): PolygonLocation;
+    /** Clone the instance */
+    clone(): TriangularFacetLocationDetail;
+    /** Set the instance contents from the other detail.
+     * @param other detail to clone
+     */
+    copyContentsFrom(other: TriangularFacetLocationDetail): void;
+    /** Get normal interpolated from facet data.
+     * @param facetNormals used to compute the normal cache
+     * @returns reference to cached normal
+     */
+    getNormal(facetNormals?: IndexedXYZCollection): Vector3d | undefined;
+    /** Get uv parameter interpolated from facet data.
+     * @param facetParams used to compute the uv parameter cache
+     * @returns reference to cached uv parameter
+     */
+    getParam(facetParams?: IndexedXYCollection): Point2d | undefined;
+    /** Get color interpolated from facet data.
+     * * Assumes barycentric coordinates are already computed in the TriangleLocationDetail member.
+     * @param facetColors used to compute the color cache
+     * @returns cached color
+     */
+    getColor(facetColors?: number[]): number | undefined;
+    /** Get the barycentric coordinates of this location.
+     * @returns cached barycentric coordinates
+    */
+    getBarycentricCoordinates(): number[];
+}
+/**
+ * Implementation of `FacetLocationDetail` for a non-convex facet.
+ * * Facet vertex data interpolation is not available.
+ * @public
+ */
+export declare class NonConvexFacetLocationDetail implements FacetLocationDetail {
+    private _facetIndex;
+    private _edgeCount;
+    protected _detail: PolygonLocationDetail;
+    /** captures the detail if provided */
+    protected constructor(facetIndex?: number, edgeCount?: number, detail?: PolygonLocationDetail);
+    /** Invalidate this detail. */
+    invalidate(deep?: boolean): void;
+    /** Create a detail.
+     * @param result optional pre-allocated object to fill and return
+     */
+    static create(facetIndex: number, edgeCount: number, detail?: PolygonLocationDetail, result?: NonConvexFacetLocationDetail): NonConvexFacetLocationDetail;
+    /** Get the facet index. */
+    get facetIndex(): number;
+    /** Get the edge count of this facet. */
+    get edgeCount(): number;
+    /** Get the world coordinates of the point. */
+    get point(): Point3d;
+    /** Get the application-specific number. */
+    get a(): number;
+    /** Get the projection of the point onto the closest facet edge. */
+    get closestEdge(): {
+        startVertexIndex: number;
+        edgeParam: number;
+    };
+    /** Test validity of fields other than _detail. */
+    private get _isValid();
+    /** Whether this instance specifies a valid location. */
+    get isValid(): boolean;
+    /** Whether the facet is convex. */
+    get isConvex(): boolean;
+    /** Whether the point is inside or on the polygon. */
+    get isInsideOrOn(): boolean;
+    /** Get the code that classifies the location of the point with respect to the facet. */
+    get classify(): PolygonLocation;
+    /** Clone the instance */
+    clone(): NonConvexFacetLocationDetail;
+    /** Set the instance contents from the other detail.
+     * @param other detail to clone
+     */
+    copyContentsFrom(other: NonConvexFacetLocationDetail): void;
+    /** Interpolated data is not defined for a non-convex facet.
+     * @returns undefined
+    */
+    getNormal(): Vector3d | undefined;
+    /** Interpolated data is not defined for a non-convex facet.
+     * @returns undefined
+    */
+    getParam(): Point2d | undefined;
+    /** Interpolated data is not defined for a non-convex facet.
+     * @returns undefined
+    */
+    getColor(): number | undefined;
+    /** Barycentric coordinates are not defined for a non-convex facet.
+     * @returns undefined
+     */
+    getBarycentricCoordinates(): number[] | undefined;
+}
+/**
+ * Implementation of `FacetLocationDetail` for a convex facet.
+ * * If `edgeCount` is 3, `TriangularFacetLocationDetail` is more efficient.
+ * @public
+ */
+export declare class ConvexFacetLocationDetail extends NonConvexFacetLocationDetail {
+    private _normal?;
+    private _param?;
+    private _color?;
+    private _barycentricCoordinates?;
+    /** captures the detail if provided */
+    private constructor();
+    /** Invalidate this detail. */
+    invalidate(deep?: boolean): void;
+    /** Create a detail.
+     * @param result optional pre-allocated object to fill and return
+     */
+    static create(facetIndex: number, edgeCount: number, detail?: PolygonLocationDetail, result?: ConvexFacetLocationDetail): ConvexFacetLocationDetail;
+    /** Whether the facet is convex. */
+    get isConvex(): boolean;
+    /** Clone the instance */
+    clone(): ConvexFacetLocationDetail;
+    /** Set the instance contents from the other detail.
+     * @param other detail to clone
+     */
+    copyContentsFrom(other: ConvexFacetLocationDetail): void;
+    /** Get normal interpolated from facet data.
+     * @param facetNormals used to compute the normal cache
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns reference to cached normal
+     */
+    getNormal(facetNormals?: IndexedXYZCollection, facetVertices?: IndexedXYZCollection, distanceTolerance?: number): Vector3d | undefined;
+    /** Get uv parameter interpolated from facet data.
+     * @param facetParams used to compute the uv parameter cache
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns reference to cached uv parameter
+     */
+    getParam(facetParams?: IndexedXYCollection, facetVertices?: IndexedXYZCollection, distanceTolerance?: number): Point2d | undefined;
+    /** Get color interpolated from facet data.
+     * @param facetColors used to compute the color cache
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns cached color
+     */
+    getColor(facetColors?: number[], facetVertices?: IndexedXYZCollection, distanceTolerance?: number): number | undefined;
+    /** Get the barycentric coordinates of this location, if they have been computed.
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns cached barycentric coordinates
+    */
+    getBarycentricCoordinates(facetVertices?: IndexedXYZCollection, distanceTolerance?: number): number[] | undefined;
+}
+//# sourceMappingURL=FacetLocationDetail.d.ts.map

package/lib/cjs/polyface/FacetLocationDetail.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FacetLocationDetail.d.ts","sourceRoot":"","sources":["../../../src/polyface/FacetLocationDetail.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAY,eAAe,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAc,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAGxE;;;;GAIG;AACH,oBAAY,sBAAsB,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC;AAExG;;GAEG;AACH,qBAAa,qBAAqB;IAChC,qEAAqE;IAC9D,iBAAiB,EAAE,MAAM,CAAC;IACjC,2FAA2F;IACpF,kBAAkB,EAAE,MAAM,CAAC;IAClC,8DAA8D;IACvD,UAAU,CAAC,EAAE,OAAO,CAAC;IAC5B,oEAAoE;IAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;IAC3B,6DAA6D;IACtD,SAAS,CAAC,EAAE,OAAO,CAAC;IAC3B,qFAAqF;IAC9E,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAC5C,uDAAuD;IAChD,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;IACnD,gCAAgC;;CAKjC;AACD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,IAAI,UAAU,IAAI,MAAM,CAAC;IACzB,6CAA6C;IAC7C,IAAI,SAAS,IAAI,MAAM,CAAC;IACxB,8CAA8C;IAC9C,IAAI,KAAK,IAAI,OAAO,CAAC;IACrB,2CAA2C;IAC3C,IAAI,CAAC,IAAI,MAAM,CAAC;IAChB,mEAAmE;IACnE,IAAI,WAAW,IAAI;QAAE,gBAAgB,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IACnE,wDAAwD;IACxD,IAAI,OAAO,IAAI,OAAO,CAAC;IACvB,mCAAmC;IACnC,IAAI,QAAQ,IAAI,OAAO,CAAC;IACxB,mDAAmD;IACnD,IAAI,YAAY,IAAI,OAAO,CAAC;IAC5B,wFAAwF;IACxF,IAAI,QAAQ,IAAI,eAAe,CAAC;IAChC,yBAAyB;IACzB,KAAK,IAAI,mBAAmB,CAAC;IAC7B,sDAAsD;IACtD,gBAAgB,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACnD,4GAA4G;IAC5G,SAAS,CAAC,YAAY,CAAC,EAAE,oBAAoB,EAAE,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACvI,kHAAkH;IAClH,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACnI,8FAA8F;IAC9F,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACvH,6GAA6G;IAC7G,yBAAyB,CAAC,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;CACnH;AAED;;;GAGG;AACH,qBAAa,6BAA8B,YAAW,mBAAmB;IACvE,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,OAAO,CAAyB;IACxC,OAAO,CAAC,OAAO,CAAC,CAAW;IAC3B,OAAO,CAAC,MAAM,CAAC,CAAU;IACzB,OAAO,CAAC,MAAM,CAAC,CAAS;IAExB,sCAAsC;IACtC,OAAO;IAIP,8BAA8B;IACvB,UAAU,CAAC,IAAI,GAAE,OAAc;IAQtC;;OAEG;WACW,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,sBAAsB,EAAE,MAAM,CAAC,EAAE,6BAA6B,GAAG,6BAA6B;IAShJ,2BAA2B;IAC3B,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,wCAAwC;IACxC,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD,8CAA8C;IAC9C,IAAW,KAAK,IAAI,OAAO,CAE1B;IACD,2CAA2C;IAC3C,IAAW,CAAC,IAAI,MAAM,CAErB;IACD,mEAAmE;IACnE,IAAW,WAAW,IAAI;QAAE,gBAAgB,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAExE;IACD,kDAAkD;IAClD,OAAO,KAAK,QAAQ,GAEnB;IACD,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD,mCAAmC;IACnC,IAAW,QAAQ,IAAI,OAAO,CAE7B;IACD,qDAAqD;IACrD,IAAW,YAAY,IAAI,OAAO,CAEjC;IACD,wFAAwF;IACxF,IAAW,QAAQ,IAAI,eAAe,CAErC;IACD,yBAAyB;IAClB,KAAK,IAAI,6BAA6B;IAK7C;;OAEG;IACI,gBAAgB,CAAC,KAAK,EAAE,6BAA6B;IAO5D;;;OAGG;IACI,SAAS,CAAC,YAAY,CAAC,EAAE,oBAAoB,GAAG,QAAQ,GAAG,SAAS;IAQ3E;;;OAGG;IACI,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,GAAG,OAAO,GAAG,SAAS;IAQvE;;;;OAIG;IACI,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS;IAO3D;;MAEE;IACK,yBAAyB,IAAI,MAAM,EAAE;CAG7C;AACD;;;;GAIG;AACH,qBAAa,4BAA6B,YAAW,mBAAmB;IACtE,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAS;IAC3B,SAAS,CAAC,OAAO,EAAE,qBAAqB,CAAC;IAEzC,sCAAsC;IACtC,SAAS,aAAa,UAAU,GAAE,MAAW,EAAE,SAAS,GAAE,MAAU,EAAE,MAAM,CAAC,EAAE,qBAAqB;IAKpG,8BAA8B;IACvB,UAAU,CAAC,IAAI,GAAE,OAAc;IAMtC;;OAEG;WACW,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,4BAA4B,GAAG,4BAA4B;IAUhK,2BAA2B;IAC3B,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,wCAAwC;IACxC,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD,8CAA8C;IAC9C,IAAW,KAAK,IAAI,OAAO,CAE1B;IACD,2CAA2C;IAC3C,IAAW,CAAC,IAAI,MAAM,CAErB;IACD,mEAAmE;IACnE,IAAW,WAAW,IAAI;QAAE,gBAAgB,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAExE;IACD,kDAAkD;IAClD,OAAO,KAAK,QAAQ,GAEnB;IACD,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD,mCAAmC;IACnC,IAAW,QAAQ,IAAI,OAAO,CAE7B;IACD,qDAAqD;IACrD,IAAW,YAAY,IAAI,OAAO,CAEjC;IACD,wFAAwF;IACxF,IAAW,QAAQ,IAAI,eAAe,CAErC;IACD,yBAAyB;IAClB,KAAK,IAAI,4BAA4B;IAK5C;;OAEG;IACI,gBAAgB,CAAC,KAAK,EAAE,4BAA4B;IAK3D;;MAEE;IACK,SAAS,IAAI,QAAQ,GAAG,SAAS;IAGxC;;MAEE;IACK,QAAQ,IAAI,OAAO,GAAG,SAAS;IAGtC;;MAEE;IACK,QAAQ,IAAI,MAAM,GAAG,SAAS;IAGrC;;OAEG;IACI,yBAAyB,IAAI,MAAM,EAAE,GAAG,SAAS;CAGzD;AACD;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,4BAA4B;IACzE,OAAO,CAAC,OAAO,CAAC,CAAW;IAC3B,OAAO,CAAC,MAAM,CAAC,CAAU;IACzB,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,uBAAuB,CAAC,CAAW;IAE3C,sCAAsC;IACtC,OAAO;IAGP,8BAA8B;IACd,UAAU,CAAC,IAAI,GAAE,OAAc;IAO/C;;OAEG;WACoB,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAKnK,mCAAmC;IACnC,IAAoB,QAAQ,IAAI,OAAO,CAEtC;IACD,yBAAyB;IACT,KAAK,IAAI,yBAAyB;IAKlD;;OAEG;IACa,gBAAgB,CAAC,KAAK,EAAE,yBAAyB;IAOjE;;;;;OAKG;IACa,SAAS,CAAC,YAAY,CAAC,EAAE,oBAAoB,EAAE,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,GAAE,MAAqC,GAAG,QAAQ,GAAG,SAAS;IAUpL;;;;;OAKG;IACa,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,GAAE,MAAqC,GAAG,OAAO,GAAG,SAAS;IAUhL;;;;;OAKG;IACa,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,GAAE,MAAqC,GAAG,MAAM,GAAG,SAAS;IAQpK;;;;MAIE;IACc,yBAAyB,CAAC,aAAa,CAAC,EAAE,oBAAoB,EAAE,iBAAiB,GAAE,MAAqC,GAAG,MAAM,EAAE,GAAG,SAAS;CAMhK"}

package/lib/cjs/polyface/FacetLocationDetail.js

@@ -0,0 +1,378 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Polyface
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConvexFacetLocationDetail = exports.NonConvexFacetLocationDetail = exports.TriangularFacetLocationDetail = exports.FacetIntersectOptions = void 0;
+const Point2dVector2d_1 = require("../geometry3d/Point2dVector2d");
+const Point3dVector3d_1 = require("../geometry3d/Point3dVector3d");
+const BarycentricTriangle_1 = require("../geometry3d/BarycentricTriangle");
+const Geometry_1 = require("../Geometry");
+const PolygonOps_1 = require("../geometry3d/PolygonOps");
+const PointHelpers_1 = require("../geometry3d/PointHelpers");
+/** Options for computing and processing facet intersection methods.
+ * @see PolyfaceQuery.intersectRay3d
+ */
+class FacetIntersectOptions {
+    /** constructor with defaults */
+    constructor() {
+        this.distanceTolerance = Geometry_1.Geometry.smallMetricDistance;
+        this.parameterTolerance = Geometry_1.Geometry.smallFraction;
+    }
+}
+exports.FacetIntersectOptions = FacetIntersectOptions;
+/**
+ * Implementation of `FacetLocationDetail` for a triangular facet.
+ * @public
+ */
+class TriangularFacetLocationDetail {
+    /** captures the detail if provided */
+    constructor(facetIndex = -1, detail) {
+        this._facetIndex = facetIndex;
+        this._detail = detail ? detail : BarycentricTriangle_1.TriangleLocationDetail.create();
+    }
+    /** Invalidate this detail. */
+    invalidate(deep = true) {
+        this._facetIndex = -1;
+        if (deep)
+            this._detail.invalidate();
+        this._normal = undefined;
+        this._param = undefined;
+        this._color = undefined;
+    }
+    /** Create a detail.
+     * @param result optional pre-allocated object to fill and return
+     */
+    static create(facetIndex, detail, result) {
+        if (undefined === result)
+            return new TriangularFacetLocationDetail(facetIndex, detail);
+        result.invalidate(false); // detail might be owned by result!
+        result._facetIndex = facetIndex;
+        if (undefined !== detail)
+            result._detail.copyContentsFrom(detail);
+        return result;
+    }
+    /** Get the facet index. */
+    get facetIndex() {
+        return this._facetIndex;
+    }
+    /** Get the edge count of this facet. */
+    get edgeCount() {
+        return 3;
+    }
+    /** Get the world coordinates of the point. */
+    get point() {
+        return this._detail.world;
+    }
+    /** Get the application-specific number. */
+    get a() {
+        return this._detail.a;
+    }
+    /** Get the projection of the point onto the closest facet edge. */
+    get closestEdge() {
+        return { startVertexIndex: this._detail.closestEdgeIndex, edgeParam: this._detail.closestEdgeParam };
+    }
+    /** Test validity of fields other than _detail. */
+    get _isValid() {
+        return this._facetIndex >= 0;
+    }
+    /** Whether this instance specifies a valid location. */
+    get isValid() {
+        return this._isValid && this._detail.isValid;
+    }
+    /** Whether the facet is convex. */
+    get isConvex() {
+        return true;
+    }
+    /** Whether the point is inside or on the polygon. */
+    get isInsideOrOn() {
+        return this._isValid && this._detail.isInsideOrOn;
+    }
+    /** Get the code that classifies the location of the point with respect to the facet. */
+    get classify() {
+        return this._detail.classify;
+    }
+    /** Clone the instance */
+    clone() {
+        const detail = new TriangularFacetLocationDetail();
+        detail.copyContentsFrom(this);
+        return detail;
+    }
+    /** Set the instance contents from the other detail.
+     * @param other detail to clone
+     */
+    copyContentsFrom(other) {
+        var _a, _b;
+        this._facetIndex = other._facetIndex;
+        this._detail.copyContentsFrom(other._detail);
+        this._normal = (_a = other._normal) === null || _a === void 0 ? void 0 : _a.clone();
+        this._param = (_b = other._param) === null || _b === void 0 ? void 0 : _b.clone();
+        this._color = other._color;
+    }
+    /** Get normal interpolated from facet data.
+     * @param facetNormals used to compute the normal cache
+     * @returns reference to cached normal
+     */
+    getNormal(facetNormals) {
+        if (this._detail.isValid && undefined === this._normal && undefined !== facetNormals) {
+            this._normal = Point3dVector3d_1.Vector3d.create();
+            const scales = [this._detail.local.x, this._detail.local.y, this._detail.local.z];
+            facetNormals.linearCombination(scales, this._normal);
+        }
+        return this._normal;
+    }
+    /** Get uv parameter interpolated from facet data.
+     * @param facetParams used to compute the uv parameter cache
+     * @returns reference to cached uv parameter
+     */
+    getParam(facetParams) {
+        if (this._detail.isValid && undefined === this._param && undefined !== facetParams) {
+            this._param = Point2dVector2d_1.Point2d.create();
+            const scales = [this._detail.local.x, this._detail.local.y, this._detail.local.z];
+            facetParams.linearCombination(scales, this._param);
+        }
+        return this._param;
+    }
+    /** Get color interpolated from facet data.
+     * * Assumes barycentric coordinates are already computed in the TriangleLocationDetail member.
+     * @param facetColors used to compute the color cache
+     * @returns cached color
+     */
+    getColor(facetColors) {
+        if (this._detail.isValid && undefined === this._color && undefined !== facetColors) {
+            const scales = [this._detail.local.x, this._detail.local.y, this._detail.local.z];
+            this._color = PointHelpers_1.NumberArray.linearCombinationOfColors(facetColors, scales);
+        }
+        return this._color;
+    }
+    /** Get the barycentric coordinates of this location.
+     * @returns cached barycentric coordinates
+    */
+    getBarycentricCoordinates() {
+        return [this._detail.local.x, this._detail.local.y, this._detail.local.z];
+    }
+}
+exports.TriangularFacetLocationDetail = TriangularFacetLocationDetail;
+/**
+ * Implementation of `FacetLocationDetail` for a non-convex facet.
+ * * Facet vertex data interpolation is not available.
+ * @public
+ */
+class NonConvexFacetLocationDetail {
+    /** captures the detail if provided */
+    constructor(facetIndex = -1, edgeCount = 0, detail) {
+        this._facetIndex = facetIndex;
+        this._edgeCount = edgeCount;
+        this._detail = detail ? detail : PolygonOps_1.PolygonLocationDetail.create();
+    }
+    /** Invalidate this detail. */
+    invalidate(deep = true) {
+        this._facetIndex = -1;
+        this._edgeCount = 0;
+        if (deep)
+            this._detail.invalidate();
+    }
+    /** Create a detail.
+     * @param result optional pre-allocated object to fill and return
+     */
+    static create(facetIndex, edgeCount, detail, result) {
+        if (undefined === result)
+            return new NonConvexFacetLocationDetail(facetIndex, edgeCount, detail);
+        result.invalidate(false); // detail might be owned by result!
+        result._facetIndex = facetIndex;
+        result._edgeCount = edgeCount;
+        if (undefined !== detail && result._detail !== detail)
+            result._detail.copyContentsFrom(detail);
+        return result;
+    }
+    /** Get the facet index. */
+    get facetIndex() {
+        return this._facetIndex;
+    }
+    /** Get the edge count of this facet. */
+    get edgeCount() {
+        return this._edgeCount;
+    }
+    /** Get the world coordinates of the point. */
+    get point() {
+        return this._detail.point;
+    }
+    /** Get the application-specific number. */
+    get a() {
+        return this._detail.a;
+    }
+    /** Get the projection of the point onto the closest facet edge. */
+    get closestEdge() {
+        return { startVertexIndex: this._detail.closestEdgeIndex, edgeParam: this._detail.closestEdgeParam };
+    }
+    /** Test validity of fields other than _detail. */
+    get _isValid() {
+        return this._facetIndex >= 0 && this._edgeCount >= 3;
+    }
+    /** Whether this instance specifies a valid location. */
+    get isValid() {
+        return this._isValid && this._detail.isValid;
+    }
+    /** Whether the facet is convex. */
+    get isConvex() {
+        return false;
+    }
+    /** Whether the point is inside or on the polygon. */
+    get isInsideOrOn() {
+        return this._isValid && this._detail.isInsideOrOn;
+    }
+    /** Get the code that classifies the location of the point with respect to the facet. */
+    get classify() {
+        return this._detail.code;
+    }
+    /** Clone the instance */
+    clone() {
+        const detail = new NonConvexFacetLocationDetail();
+        detail.copyContentsFrom(this);
+        return detail;
+    }
+    /** Set the instance contents from the other detail.
+     * @param other detail to clone
+     */
+    copyContentsFrom(other) {
+        this._facetIndex = other._facetIndex;
+        this._edgeCount = other._edgeCount;
+        this._detail.copyContentsFrom(other._detail);
+    }
+    /** Interpolated data is not defined for a non-convex facet.
+     * @returns undefined
+    */
+    getNormal() {
+        return undefined;
+    }
+    /** Interpolated data is not defined for a non-convex facet.
+     * @returns undefined
+    */
+    getParam() {
+        return undefined;
+    }
+    /** Interpolated data is not defined for a non-convex facet.
+     * @returns undefined
+    */
+    getColor() {
+        return undefined;
+    }
+    /** Barycentric coordinates are not defined for a non-convex facet.
+     * @returns undefined
+     */
+    getBarycentricCoordinates() {
+        return undefined;
+    }
+}
+exports.NonConvexFacetLocationDetail = NonConvexFacetLocationDetail;
+/**
+ * Implementation of `FacetLocationDetail` for a convex facet.
+ * * If `edgeCount` is 3, `TriangularFacetLocationDetail` is more efficient.
+ * @public
+ */
+class ConvexFacetLocationDetail extends NonConvexFacetLocationDetail {
+    /** captures the detail if provided */
+    constructor(facetIndex = -1, edgeCount = 0, detail) {
+        super(facetIndex, edgeCount, detail);
+    }
+    /** Invalidate this detail. */
+    invalidate(deep = true) {
+        super.invalidate(deep);
+        this._normal = undefined;
+        this._param = undefined;
+        this._color = undefined;
+        this._barycentricCoordinates = undefined;
+    }
+    /** Create a detail.
+     * @param result optional pre-allocated object to fill and return
+     */
+    static create(facetIndex, edgeCount, detail, result) {
+        if (undefined === result)
+            return new ConvexFacetLocationDetail(facetIndex, edgeCount, detail);
+        return super.create(facetIndex, edgeCount, detail, result);
+    }
+    /** Whether the facet is convex. */
+    get isConvex() {
+        return true;
+    }
+    /** Clone the instance */
+    clone() {
+        const detail = new ConvexFacetLocationDetail();
+        detail.copyContentsFrom(this);
+        return detail;
+    }
+    /** Set the instance contents from the other detail.
+     * @param other detail to clone
+     */
+    copyContentsFrom(other) {
+        var _a, _b, _c;
+        super.copyContentsFrom(other);
+        this._normal = (_a = other._normal) === null || _a === void 0 ? void 0 : _a.clone();
+        this._param = (_b = other._param) === null || _b === void 0 ? void 0 : _b.clone();
+        this._color = other._color;
+        this._barycentricCoordinates = (_c = other._barycentricCoordinates) === null || _c === void 0 ? void 0 : _c.slice();
+    }
+    /** Get normal interpolated from facet data.
+     * @param facetNormals used to compute the normal cache
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns reference to cached normal
+     */
+    getNormal(facetNormals, facetVertices, distanceTolerance = Geometry_1.Geometry.smallMetricDistance) {
+        if (this._detail.isValid && undefined === this._normal && undefined !== facetNormals) {
+            const scales = this.getBarycentricCoordinates(facetVertices, distanceTolerance);
+            if (undefined !== scales) {
+                this._normal = Point3dVector3d_1.Vector3d.create();
+                facetNormals.linearCombination(scales, this._normal);
+            }
+        }
+        return this._normal;
+    }
+    /** Get uv parameter interpolated from facet data.
+     * @param facetParams used to compute the uv parameter cache
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns reference to cached uv parameter
+     */
+    getParam(facetParams, facetVertices, distanceTolerance = Geometry_1.Geometry.smallMetricDistance) {
+        if (this._detail.isValid && undefined === this._param && undefined !== facetParams) {
+            const scales = this.getBarycentricCoordinates(facetVertices, distanceTolerance);
+            if (undefined !== scales) {
+                this._param = Point2dVector2d_1.Point2d.create();
+                facetParams.linearCombination(scales, this._param);
+            }
+        }
+        return this._param;
+    }
+    /** Get color interpolated from facet data.
+     * @param facetColors used to compute the color cache
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns cached color
+     */
+    getColor(facetColors, facetVertices, distanceTolerance = Geometry_1.Geometry.smallMetricDistance) {
+        if (this._detail.isValid && undefined === this._color && undefined !== facetColors) {
+            const scales = this.getBarycentricCoordinates(facetVertices, distanceTolerance);
+            if (undefined !== scales)
+                this._color = PointHelpers_1.NumberArray.linearCombinationOfColors(facetColors, scales);
+        }
+        return this._color;
+    }
+    /** Get the barycentric coordinates of this location, if they have been computed.
+     * @param facetVertices used to compute the barycentric coordinate cache
+     * @param distanceTolerance used to compute the barycentric coordinate cache
+     * @returns cached barycentric coordinates
+    */
+    getBarycentricCoordinates(facetVertices, distanceTolerance = Geometry_1.Geometry.smallMetricDistance) {
+        if (this._detail.isValid && undefined === this._barycentricCoordinates && undefined !== facetVertices) {
+            this._barycentricCoordinates = PolygonOps_1.PolygonOps.convexBarycentricCoordinates(facetVertices, this._detail.point, distanceTolerance);
+        }
+        return this._barycentricCoordinates;
+    }
+}
+exports.ConvexFacetLocationDetail = ConvexFacetLocationDetail;
+//# sourceMappingURL=FacetLocationDetail.js.map