@equinor/esv-intersection 1.4.3 → 1.5.2

package/README.md

@@ -36,7 +36,7 @@ $ npm run storybook
 import { Controller, GridLayer } from '@equinor/esv-intersection';
 
 const container = document.createElement('div');
-const controller = new Controller(container);
+const controller = new Controller({container: container});
 
 // the controller initially has zero height
 controller.adjustToSize(400, 400);

package/dist/control/ExtendedCurveInterpolator.d.ts

@@ -0,0 +1,58 @@
+import { CurveInterpolator } from 'curve-interpolator';
+import { Vector } from 'curve-interpolator/dist/src/interfaces';
+import { CurveInterpolatorOptions } from 'curve-interpolator/dist/src/curve-interpolator';
+export declare class ExtendedCurveInterpolator extends CurveInterpolator {
+    arcLengthLookup: number[];
+    constructor(points: Vector[], options?: CurveInterpolatorOptions);
+    /**
+     * Function which finds t value for arc length
+     * @param {Number} arcLength Target arc length
+     * @param {Number} tolerance Tolerance for result
+     * @param {Number} iterations Max number of iterations to use
+     */
+    findTForArcLength(arcLength: number, options?: {
+        approxT?: boolean;
+        quickT?: boolean;
+        normalizedLength?: number;
+    }): number;
+    /**
+     * Function which finds t value for arc length by finding root
+     * @param {Number} arcLength Target arc length
+     * @param {Number} tolerance Tolerance for result
+     * @param {Number} iterations Max number of iterations to use
+     */
+    findTByRootForArcLength(arcLength: number, tolerance?: number, iterations?: number): number;
+    /**
+     * Function which finds t value for arc length by simple approximation
+     * @param {Number} arcLength Target arclength
+     */
+    findApproxTForArcLength(arcLength: number, normalizedLength?: number): number;
+    /**
+     * Function which finds t value for arc length using lookup table
+     * @param {Number} arcLength Target arclength
+     */
+    findTQuickForArcLength(arcLength: number): number;
+    generateArcLengthLookup(segments?: number): void;
+    /**
+     * Function calculating length along curve using interpolator.
+     * @param {Number} from t at start (default = 0)
+     * @param {Number} to t at end (default = 1)
+     */
+    getArcLength(from?: number, to?: number): number;
+    /**
+     * Function calculating length along curve using interpolator.
+     * @param {Number} from t at start (default = 0)
+     * @param {Number} to t at end (default = 1)
+     */
+    getQuickArcLength(from?: number, to?: number): number;
+    /**
+     * Function getting a point at curve length.
+     * @param {Number} arcLength
+     */
+    getPointAtArcLength(arcLength: number, options?: {
+        approxT?: boolean;
+        quickT?: boolean;
+        normalizedLength?: number;
+    }): Vector;
+    getPointAt(t: number): Vector;
+}

package/dist/control/IntersectionReferenceSystem.d.ts

@@ -1,4 +1,4 @@
-import { Interpolator, Trajectory, ReferenceSystemOptions, MDPoint } from '../interfaces';
+import { Interpolators, Trajectory, ReferenceSystemOptions, MDPoint } from '../interfaces';
 export declare class IntersectionReferenceSystem {
     options: ReferenceSystemOptions;
     path: number[][];
@@ -9,7 +9,7 @@ export declare class IntersectionReferenceSystem {
     depthReference: number;
     wellboreId: number;
     trajectoryOffset: number;
-    interpolators: Interpolator;
+    interpolators: Interpolators;
     startVector: number[];
     endVector: number[];
     _curtainPathCache: MDPoint[];
@@ -70,11 +70,11 @@ export declare class IntersectionReferenceSystem {
     static toDisplacement(points: number[][], offset?: number): number[][];
     /**
      * returns a normalized vector
-     * @param interp interpolated curve
+     * @param interpolator interpolated curve
      * @param from number between 0 and 1
      * @param to number between 0 and 1
      */
-    static getDirectionVector(interp: any, from: number, to: number): number[];
+    static getDirectionVector(interpolator: any, from: number, to: number): number[];
     get length(): number;
     get offset(): number;
     set offset(offset: number);

package/dist/datautils/seismicimage.d.ts

@@ -24,7 +24,7 @@ export declare function getSeismicInfo(data: {
 export declare function generateSeismicSliceImage(data: {
     datapoints: number[][];
     yAxisValues: number[];
-}, trajectory: number[][], colormap: string[], options: {
+}, trajectory: number[][], colormap: string[], options?: {
     isLeftToRight: true;
     seismicRange?: number;
     seismicMin?: number;