@equinor/videx-map 1.12.4 → 1.13.0-beta.1

package/dist/utils/Rect.d.ts

@@ -0,0 +1,27 @@
+import Vector2 from '@equinor/videx-vector2';
+import { VectorLike } from '@equinor/videx-linear-algebra';
+export default class Rect {
+    lowerLeft: Vector2;
+    width: number;
+    height: number;
+    rotation: number;
+    constructor(lowerLeft: Vector2, width: number, height: number, rotation: number);
+    /**
+     * Check if a point is inside.
+     * @param vector Vector to evaluate
+     * @returns True if point is inside rectangle
+     */
+    isInside(vector: VectorLike): boolean;
+    /**
+     * Check if a point is inside.
+     * @param x X position to evaluate
+     * @param y Y position to evaluate
+     * @returns True if point is inside rectangle
+     */
+    isInside(x: number, y: number): boolean;
+    /**
+     * Transforms position from world space to local space.
+     * @param position
+     */
+    inverseTransformPoint(x: number, y: number): Vector2;
+}

package/dist/utils/TriangleDictionary.d.ts

@@ -1,4 +1,4 @@
-declare type vec2 = [number, number];
+type vec2 = [number, number];
 interface Triangle {
     v1: vec2;
     v2: vec2;

package/dist/utils/centerOfMass.d.ts

@@ -1,4 +1,4 @@
-import Vector2 from "@equinor/videx-vector2";
+import Vector2 from '@equinor/videx-vector2';
 /**
  * Get the center of mass of a polygon.
  * @param vertices Vertices of polygon

package/dist/utils/fields/Highlighter.d.ts

@@ -1,5 +1,5 @@
 import { FieldMesh } from '../../FieldModule';
-declare type vec3 = [number, number, number];
+type vec3 = [number, number, number];
 interface Cache {
     fillCol1: vec3;
     fillCol2: vec3;

package/dist/utils/fields/LabelManager.d.ts

@@ -1,7 +1,7 @@
 import * as PIXI from 'pixi.js';
 import Vector2 from '@equinor/videx-vector2';
 /** Data for label. */
-export declare type LabelData = {
+export type LabelData = {
     position: Vector2;
     mass: number;
 };
@@ -12,7 +12,7 @@ interface Field {
     instance?: PIXI.Text;
 }
 /** Instance of a multi-label entry. */
-export declare type Label = {
+export type Label = {
     position: Vector2;
     mass: number;
     instance: PIXI.Text;

package/dist/utils/generateCircle.d.ts

@@ -1,4 +1,4 @@
-import Vector2 from "@equinor/videx-vector2";
+import Vector2 from '@equinor/videx-vector2';
 import * as PIXI from 'pixi.js';
 /**
  *

package/dist/utils/lineReducer.d.ts

@@ -0,0 +1,9 @@
+import { VectorLike } from '@equinor/videx-linear-algebra';
+/**
+ * Reduce complexity of a line by removing points with little information.
+ * @param points Collection of points to reduce
+ * @param maxDeviation Max deviation of a single point
+ * @param distanceWeight Scale allowed deviatin by distance from last point
+ * @returns Reduced line
+ */
+export declare function reduce<T extends VectorLike>(points: T[], maxDeviation: number, distanceWeight: number): T[];

package/dist/utils/wellbores/Colors.d.ts

@@ -1,4 +1,4 @@
-declare type vec3 = [number, number, number];
+type vec3 = [number, number, number];
 export interface Color {
     col1: vec3;
     col2: vec3;

package/dist/utils/wellbores/Config.d.ts

@@ -1,6 +1,6 @@
-import { WellboreEventData } from "./data";
-import { HighlightEvent } from "./data/WellboreEventData";
-import { EventHandler } from "../../EventHandler";
+import { WellboreEventData } from './data';
+import { HighlightEvent } from './data/WellboreEventData';
+import { EventHandler } from '../../EventHandler';
 import { ResizeConfig } from '../../ResizeConfigInterface';
 export interface TickConfig {
     width: number;

package/dist/utils/wellbores/DataManager.d.ts

@@ -0,0 +1,15 @@
+import { SourceData, WellboreData, RootData, Group } from './data';
+export default abstract class DataManager {
+    wellbores: {
+        [key: number]: WellboreData;
+    };
+    roots: {
+        [key: number]: RootData;
+    };
+    /** Map group keys ('Drilled', 'Planned', etc.) to keys in wellbores dictionary. */
+    groups: {
+        [key: string]: Group;
+    };
+    addWellbore(_key: number, _data: SourceData): void;
+    removeWellbore(_key: number): void;
+}

package/dist/utils/wellbores/Highlight.d.ts

@@ -1,4 +1,4 @@
-import { WellboreData, RootData } from "./data";
+import { WellboreData, RootData } from './data';
 export declare class Highlight {
     active: boolean;
     root: RootData;

package/dist/utils/wellbores/LabelType.d.ts

@@ -0,0 +1,9 @@
+/** Enum for dividing labels into three groups. */
+export declare enum LabelType {
+    /** Labels attached to wellbores. */
+    Wellbore = 0,
+    /** Multiple wellbore-labels or under root. */
+    Multi = 1,
+    /** Single label under root. */
+    Single = 2
+}

package/dist/utils/wellbores/Projector.d.ts

@@ -1,5 +1,5 @@
 import Vector2 from '@equinor/videx-vector2';
-declare type projectFunction = (coord: [number, number], zoom?: number) => {
+type projectFunction = (coord: [number, number], zoom?: number) => {
     x: number;
     y: number;
 };

package/dist/utils/wellbores/RealtimeWellbore.d.ts

@@ -1,6 +1,6 @@
 import { WellboreData } from './data/WellboreData';
 import { pixiOverlayBase } from '../../pixiOverlayInterfaces';
-declare type vec2 = [number, number];
+type vec2 = [number, number];
 /** Class for handling realtime position of wellbore. */
 export default class RealtimeWellbore {
     private map;

package/dist/utils/wellbores/Shader.d.ts

@@ -1,6 +1,6 @@
 import * as PIXI from 'pixi.js';
 import { Color } from './Colors';
-declare type vec3 = [number, number, number];
+type vec3 = [number, number, number];
 /** Uniforms used by the shader. */
 export interface WellboreUniforms {
     /** Color of lighted wellbore on the format: [R, G, B]. */
@@ -13,32 +13,29 @@ export interface WellboreUniforms {
     wellboreVisible: boolean;
     status: number;
 }
-/**
- * Get shader for wellbore.
- * @param color Color used for wellbore
- * @param wellboreWidth Width of wellbore
- * @return PIXI shader
- */
-export declare function getWellboreShader(color: Color, completionVisible: boolean, wellboreVisible: boolean): PIXI.Shader;
 export declare class WellboreShader {
+    private static program;
+    /**
+   * Get shader for wellbore.
+   * @param color Color used for wellbore
+   * @param wellboreWidth Width of wellbore
+   * @return PIXI shader
+   */
+    static get(color: Color, completionVisible: boolean, wellboreVisible: boolean): PIXI.Shader;
     /** Build wellbore shader with assigned variables. */
     static build(maxScale: number, wellboreDash: number): void;
-    /** Vertex shader */
-    static vertexShader: string;
-    /** Fragment shader */
-    static fragmentShader: string;
 }
 export interface RootUniforms {
     active: boolean;
     circleColor1: [number, number, number];
     circleColor2: [number, number, number];
+    rootRadius: number;
 }
 export declare class RootShader {
+    private static program;
     /** Get root shader */
     static get(): PIXI.Shader;
     /** Build vertex shader from given resize configs */
     static build(maxScale: number): void;
-    static vertexShader: string;
-    static fragmentShader: string;
 }
 export {};

package/dist/utils/wellbores/data/Group.d.ts

@@ -10,7 +10,7 @@ interface WellboreState {
     completionVisible: boolean;
     wellboreVisible: boolean;
 }
-declare type Filter = (data: SourceData) => boolean;
+type Filter = (data: SourceData) => boolean;
 export declare class Group {
     key: string;
     colors: Colors;

package/dist/utils/wellbores/data/RootData.d.ts

@@ -1,5 +1,6 @@
-import { WellboreData } from './WellboreData';
+import * as PIXI from 'pixi.js';
 import Vector2 from '@equinor/videx-vector2';
+import { WellboreData } from './WellboreData';
 export declare class RootData {
     mesh: PIXI.Mesh;
     wellbores: WellboreData[];

package/dist/utils/wellbores/data/SourceData.d.ts

@@ -0,0 +1,25 @@
+/** Date for each interval. */
+export interface Interval {
+    /** Type of interval [Screen, Perforation]. */
+    type: string;
+    /** Start of interval as distance along wellbore. */
+    start: number;
+    /** End of interval as distance along wellbore. */
+    end: number;
+    /** Start of interval along wellbore as a value between 0 and 1. */
+    l1: number;
+    /** End of interval along wellbore as a value between 0 and 1. */
+    l2: number;
+}
+/** Wellbore data. */
+export interface SourceData {
+    [key: string]: any;
+    /** Collection of intervals. */
+    intervals: Interval[];
+    /** Full label of wellbore. */
+    label: string;
+    /** Short label of wellbore, ie. no country code. */
+    labelShort: string;
+    /** Path along wellbore on lat/long format. */
+    path: [number, number][];
+}

package/dist/utils/wellbores/data/WellboreData.d.ts

@@ -32,6 +32,10 @@ export declare enum FilterStatus {
     hard = 2
 }
 export declare class WellboreData {
+    static state: {
+        wellboreRadius: number;
+        rootRadius: number;
+    };
     data: SourceData;
     group: Group;
     wellboreWidth: number;

package/dist/utils/wellbores/data/WellboreEventData.d.ts

@@ -1,5 +1,5 @@
-import { SourceData } from "./SourceData";
-import { WellboreData } from "./WellboreData";
+import { SourceData } from './SourceData';
+import { WellboreData } from './WellboreData';
 export declare class WellboreEventData {
     group: string;
     data: SourceData;

package/dist/utils/wellbores/highlight-helper.d.ts

@@ -1,6 +1,6 @@
-import { WellboreData, HighlightEvent } from "./data";
-import Vector2 from "@equinor/videx-vector2";
-import WellboreModule from "../../WellboreModule";
+import Vector2 from '@equinor/videx-vector2';
+import { WellboreData, HighlightEvent } from './data';
+import WellboreModule from '../../WellboreModule';
 export declare function updateHighlighted(module: WellboreModule, pos: Vector2, onHighlightOn?: (event: HighlightEvent) => void, onHighlightOff?: () => void, originalEvent?: any): void;
 export declare function forceHighlight(module: WellboreModule, wellbore: WellboreData): void;
 export declare function clearHighlight(module: WellboreModule, onHighlightOff?: () => void): void;

package/dist/utils/wellbores/labels/Label.d.ts

@@ -15,7 +15,8 @@ export declare class Label {
     private static style;
     static config: Common;
     static height: number;
-    text: PIXI.Text;
+    container: PIXI.Container;
+    private text;
     background: PIXI.Graphics;
     metrics: PIXI.TextMetrics;
     private _attachToRoot;
@@ -30,6 +31,7 @@ export declare class Label {
     constructor(label: string, fontColor: number, bgColor: number);
     get visible(): boolean;
     set visible(flag: boolean);
+    set fontColor(color: number);
     get attachToRoot(): boolean;
     set attachToRoot(val: boolean);
     getBoundingBox(): PIXI.Rectangle;

package/dist/utils/wellbores/labels/label-helper.d.ts

@@ -1,3 +1,3 @@
-import { WellboreData } from "../data";
+import { WellboreData } from '../data';
 export declare function positionAtRoot(wellbore: WellboreData, position: number): void;
 export declare function positionAlongWellbore(wellbore: WellboreData): void;

package/dist/utils/wellbores/registries/CallbackRegistry.d.ts

@@ -0,0 +1,23 @@
+type Callback = (wellboreId: number) => void;
+export declare class CallbackRegistry {
+    /** Internal callback register. */
+    registry: {
+        [key: string]: Callback;
+    };
+    /** Can map multiple strings to same callback. */
+    map: {
+        [key: string]: Callback;
+    };
+    constructor();
+    /** Register callback */
+    register(key: string, callback: Callback): void;
+    /**
+     * Used to map key given as first parameter in 'WellboreModule' with a callback in internal registy.
+     * If key is blank, will try to retrieve 'setKey' from registry. Else key will map to default callback.
+     * @param setKey Key to map to registry.
+     * @param key Key in registry.
+     */
+    mapKey(setKey: string, key?: string): void;
+    get(setKey?: string): Callback;
+}
+export {};

package/dist/utils/wellbores/registries/ColorRegistry.d.ts

@@ -0,0 +1,22 @@
+import { Colors } from '../Colors';
+export declare class ColorRegistry {
+    /** Internal color register. */
+    registry: {
+        [key: string]: Colors;
+    };
+    /** Can map multiple strings to same instance in registry. */
+    map: {
+        [key: string]: Colors;
+    };
+    constructor();
+    /** Color collection */
+    register(key: string, colors: Colors): void;
+    /**
+     * Used to map key given as first parameter in 'WellboreModule' with a color collection in internal registy.
+     * If key is blank, will try to retrieve 'setKey' from registry. Else key will map to default color configurations.
+     * @param setKey Key to map to registry.
+     * @param key Key in registry.
+     */
+    mapKey(setKey: string, key?: string): void;
+    get(setKey?: string): Colors;
+}

package/dist/utils/wellbores/registries/index.d.ts

@@ -0,0 +1,2 @@
+export { ColorRegistry } from './ColorRegistry';
+export { CallbackRegistry } from './CallbackRegistry';

package/package.json

@@ -1,89 +1,101 @@
-{
-  "name": "@equinor/videx-map",
-  "version": "1.12.4",
-  "description": "Component for Pixi-overlay in Leaflet.",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "browser": "dist/index.umd.js",
-  "files": [
-    "dist"
-  ],
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "start": "start-storybook",
-    "prebuild": "rimraf dist",
-    "build": "rollup -c",
-    "prepub": "npm run build",
-    "pub": "npm publish --access=public",
-    "test": "jest",
-    "test:watch": "jest --watchAll",
-    "predocs": "rimraf docs",
-    "docs": "typedoc --out docs src",
-    "postdocs": "copyfiles images/* docs && copyfiles .nojekyll docs"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/equinor/videx-map.git"
-  },
-  "keywords": [
-    "videx",
-    "leaflet",
-    "pixi.js",
-    "typescript"
-  ],
-  "author": "Tom Kristian Tjemsland",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/equinor/videx-map/issues"
-  },
-  "homepage": "https://github.com/equinor/videx-map#readme",
-  "devDependencies": {
-    "@babel/core": "^7.11.6",
-    "@equinor/videx-storybook-input": "^1.0.0",
-    "@storybook/html": "^6.2.3",
-    "@types/d3": "^5.7.2",
-    "@types/earcut": "^2.1.1",
-    "@types/geojson": "^7946.0.3",
-    "@types/jest": "^26.0.13",
-    "@types/leaflet": "^1.5.17",
-    "@types/uuid": "^8.3.0",
-    "awesome-typescript-loader": "^5.2.1",
-    "babel-loader": "^8.1.0",
-    "copyfiles": "^2.3.0",
-    "d3": "^6.1.1",
-    "eslint": "^7.8.1",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.22.0",
-    "jest": "^26.4.2",
-    "jest-canvas-mock": "^2.2.0",
-    "leaflet": "^1.7.1",
-    "leaflet-pixi-overlay": "^1.8.1",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.45.2",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-typescript2": "^0.30.0",
-    "simplex-noise": "^2.4.0",
-    "ts-jest": "^26.3.0",
-    "tslib": "^2.2.0",
-    "typedoc": "^0.20.28",
-    "typescript": "^4.2.4"
-  },
-  "jest": {
-    "transform": {
-      ".(ts|tsx)": "ts-jest"
-    },
-    "testRegex": "(/tests/.*|(\\.|/)test)\\.ts$",
-    "setupFiles": [
-      "jest-canvas-mock"
-    ]
-  },
-  "dependencies": {
-    "@equinor/videx-linear-algebra": "^1.0.7",
-    "@equinor/videx-math": "^1.1.0",
-    "@equinor/videx-vector2": "^1.0.44",
-    "earcut": "^2.2.2",
-    "pixi.js": "5.3.3",
-    "uuid": "^8.3.2"
-  }
-}
+{
+  "name": "@equinor/videx-map",
+  "version": "1.13.0-beta.1",
+  "description": "Component for Pixi-overlay in Leaflet.",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "browser": "dist/index.umd.js",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "start": "start-storybook",
+    "prebuild": "rimraf dist",
+    "build": "rollup -c",
+    "prepub": "npm run build",
+    "pub": "npm publish --access=public",
+    "test": "jest",
+    "test:watch": "jest --watchAll",
+    "lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",
+    "lint:ci": "eslint --ext .js,.jsx,.ts,.tsx src --color --format table --quiet",
+    "lint:fix": "eslint --ext .js,.jsx,.ts,.tsx src --fix",
+    "predocs": "rimraf docs",
+    "docs": "typedoc --out docs src",
+    "postdocs": "copyfiles images/* docs && copyfiles .nojekyll docs",
+    "lint-staged": "lint-staged",
+    "prepare": "husky install"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/equinor/videx-map.git"
+  },
+  "keywords": [
+    "videx",
+    "leaflet",
+    "pixi.js",
+    "typescript"
+  ],
+  "author": "Tom Kristian Tjemsland",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/equinor/videx-map/issues"
+  },
+  "homepage": "https://github.com/equinor/videx-map#readme",
+  "devDependencies": {
+    "@babel/core": "^7.11.6",
+    "@equinor/videx-storybook-input": "^1.0.0",
+    "@storybook/html": "^6.2.3",
+    "@types/d3": "^5.7.2",
+    "@types/earcut": "^2.1.1",
+    "@types/geojson": "^7946.0.3",
+    "@types/jest": "^26.0.13",
+    "@types/leaflet": "^1.5.17",
+    "@types/uuid": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^5.46.1",
+    "@typescript-eslint/parser": "^5.46.1",
+    "babel-loader": "^8.1.0",
+    "copyfiles": "^2.3.0",
+    "eslint-formatter-table": "^7.32.1",
+    "husky": "^8.0.3",
+    "jest": "^26.4.2",
+    "jest-canvas-mock": "^2.2.0",
+    "leaflet": "^1.7.1",
+    "leaflet-pixi-overlay": "^1.8.2",
+    "lint-staged": "^11.1.2",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.45.2",
+    "rollup-plugin-node-resolve": "^5.2.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.30.0",
+    "simplex-noise": "^2.4.0",
+    "ts-jest": "^26.3.0",
+    "ts-loader": "^9.4.2",
+    "tslib": "^2.4.1",
+    "typedoc": "^0.23.23",
+    "typescript": "^4.9.4"
+  },
+  "jest": {
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    },
+    "testRegex": "(/tests/.*|(\\.|/)test)\\.ts$",
+    "setupFiles": [
+      "jest-canvas-mock"
+    ]
+  },
+  "lint-staged": {
+    "*.ts": [
+      "npm run lint:ci"
+    ]
+  },
+  "dependencies": {
+    "@equinor/videx-linear-algebra": "^1.0.7",
+    "@equinor/videx-math": "^1.1.0",
+    "@equinor/videx-vector2": "^1.0.44",
+    "d3-color": "^3.1.0",
+    "earcut": "^2.2.2",
+    "pixi.js": "^7.1.2",
+    "uuid": "^8.3.2"
+  }
+}