brepjs API Reference
    Preparing search index...

    Interface KernelMeasureOps

    interface KernelMeasureOps {
        area(shape: any): number;
        boundingBox(
            shape: any,
        ): { max: [number, number, number]; min: [number, number, number] };
        centerOfMass(shape: any): [number, number, number];
        createDistanceQuery(
            referenceShape: any,
        ): {
            dispose(): void;
            distanceTo(
                shape: any,
            ): {
                point1: [number, number, number];
                point2: [number, number, number];
                value: number;
            };
        };
        distance(shape1: any, shape2: any): DistanceResult;
        inertia?(shape: any): Matrix3;
        length(shape: any): number;
        linearCenterOfMass(shape: any): [number, number, number];
        measureBulk(shape: any, includeLinear?: boolean): BulkMeasurement;
        surfaceCenterOfMass(face: any): [number, number, number];
        surfaceCurvature(
            face: any,
            u: number,
            v: number,
        ): {
            gaussian: number;
            max: number;
            maxDirection: [number, number, number];
            mean: number;
            min: number;
            minDirection: [number, number, number];
        };
        volume(shape: any): number;
    }
    Index
    area boundingBox centerOfMass createDistanceQuery distance inertia? length linearCenterOfMass measureBulk surfaceCenterOfMass surfaceCurvature volume

    • Parameters

      • shape: any

      Returns { max: [number, number, number]; min: [number, number, number] }

    • Create a persistent distance query tool for repeated measurements.

      Parameters

      • referenceShape: any

      Returns {
          dispose(): void;
          distanceTo(
              shape: any,
          ): {
              point1: [number, number, number];
              point2: [number, number, number];
              value: number;
          };
      }

    • Minimum distance between two shapes with witness points.

      Parameters

      • shape1: any
      • shape2: any

      Returns DistanceResult

    • Volume matrix of inertia about the center of mass (unit density), in axes parallel to world X/Y/Z. Products of inertia carry the tensor's negative sign, so the matrix is symmetric with [1]==[3], [2]==[6], [5]==[7]. Optional: kernels without it cannot answer principal-axes queries.

      Parameters

      • shape: any

      Returns Matrix3

    • Compute volume, area, length, center-of-mass, and bounding box in one call.

      Parameters

      • shape: any
      • OptionalincludeLinear: boolean

      Returns BulkMeasurement

    • Surface-based center of mass (uses surface properties, not volume).

      Parameters

      • face: any

      Returns [number, number, number]

    • Compute surface curvature at a UV point on a face.

      Parameters

      • face: any
      • u: number
      • v: number

      Returns {
          gaussian: number;
          max: number;
          maxDirection: [number, number, number];
          mean: number;
          min: number;
          minDirection: [number, number, number];
      }

    Settings
    Member Visibility

    On This Page
    Methods