@equinor/videx-3d 5.1.0-beta

package/dist/types/components/Html/WellMap/WellMap.d.ts

@@ -0,0 +1,47 @@
+import { PropsWithChildren } from 'react';
+import { WellboreHeader } from '../../../sdk/data/types/WellboreHeader';
+import { WellMapStyles } from './themes';
+/**
+ * WellMap props
+ * @expand
+ */
+export type WellMapProps = {
+    wellIdentifier: string;
+    excluded?: string[];
+    selected?: string;
+    onSelect?: (wellbore: string, depth: number) => void;
+    depth?: number;
+    onDepthChanged?: (depth: number) => void;
+    onWellboreOver?: (wellbore: WellboreHeader | null, depth: number | undefined) => void;
+    color?: string;
+    colors?: Record<string, string> | ((wellbore: WellboreHeader, slot: number) => string);
+    interactive?: boolean;
+    headless?: boolean;
+    depthCursor?: boolean;
+    theme?: WellMapStyles;
+};
+/**
+ * This HTML component visualizes the trajectories of a well side-by-side according to the measured depth. It shows
+ * each wellbore from its kickoff depth to the terminal end point.
+ *
+ * The well map supports various interactions, which can be used to control selection and camera position/focus.
+ * You can customize colors by providing a color dictionary or color selection function via the `colors` prop.
+ *
+ * For other colors, use the `theme` prop.
+ *
+ * @example
+ * <WellMap wellIdentifier="NO 16/2-D-1" />
+ *
+ * @remarks
+ * The WellMap must be placed as a child of the `DataProvider` component, but outside of the R3F fiber `Canvas` component.
+ *
+ * @see [Storybook](/videx-3d/?path=/docs/components-html-wellmap--docs)
+ * @see {@link WellMapStyles}
+ * @see {@link WellMapCasingShoes}
+ * @see {@link WellMapCompletionIntervals}
+ * @see {@link WellMapFormations}
+ * @see {@link WellMapTvd}
+ * @see {@link WellMapContext}
+ * @group Components
+ */
+export declare const WellMap: ({ wellIdentifier, excluded, selected, onSelect, depth, onDepthChanged, onWellboreOver, color, colors, interactive, headless, depthCursor, theme, children, }: PropsWithChildren<WellMapProps>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Html/WellMap/addons/WellMapCasingShoes.d.ts

@@ -0,0 +1,14 @@
+/**
+ * WellMapCasingShoes props
+ * @expand
+ */
+export type WellMapCasingShoesProps = {
+    color?: string;
+};
+/**
+ * Casing shoes display addon for `WellMap`
+ * @group Components
+ *
+ * @see {@link WellMap}
+ */
+export declare const WellMapCasingShoes: ({ color, }: WellMapCasingShoesProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/Html/WellMap/addons/WellMapCompletionIntervals.d.ts

@@ -0,0 +1,15 @@
+/**
+ * WellMapCompletionIntervals props
+ * @expand
+ */
+export type WellMapCompletionIntervalsProps = {
+    colorScreen?: string;
+    colorPerforation?: string;
+};
+/**
+ * Completion intervals display addon for `WellMap`
+ * @group Components
+ *
+ * @see {@link WellMap}
+ */
+export declare const WellMapCompletionIntervals: ({ colorScreen, colorPerforation, }: WellMapCompletionIntervalsProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/Html/WellMap/addons/WellMapFormations.d.ts

@@ -0,0 +1,14 @@
+/**
+ * WellMapFormations props
+ * @expand
+ */
+export type WellMapFormationsProps = {
+    stratColumnId: string;
+};
+/**
+ * Formations addon for `WellMap`
+ * @group Components
+ *
+ * @see {@link WellMap}
+ */
+export declare const WellMapFormations: ({ stratColumnId, }: WellMapFormationsProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/Html/WellMap/addons/WellMapTvd.d.ts

@@ -0,0 +1,14 @@
+/**
+ * WellMapTvd props
+ * @expand
+ */
+export type WellMapTvdProps = {
+    color?: string;
+};
+/**
+ * TVD depth display addon for `WellMap`
+ * @group Components
+ *
+ * @see {@link WellMap}
+ */
+export declare const WellMapTvd: ({ color, }: WellMapTvdProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/Html/WellMap/addons/index.d.ts

@@ -0,0 +1,4 @@
+export * from './WellMapCasingShoes';
+export * from './WellMapCompletionIntervals';
+export * from './WellMapFormations';
+export * from './WellMapTvd';

package/dist/types/components/Html/WellMap/index.d.ts

@@ -0,0 +1,4 @@
+export * from './WellMap';
+export * from './themes';
+export * from './well-map-context';
+export * from './addons';

package/dist/types/components/Html/WellMap/themes.d.ts

@@ -0,0 +1,13 @@
+export type WellMapStyles = {
+    depthAxisWidth: number;
+    depthAxisColor: string;
+    kickoffAxisColor: string;
+    cursorColor: string;
+    rulerColor: string;
+    activeTrackColor: string;
+    readoutColor: string;
+    textColor: string;
+    darkMode: boolean;
+};
+export declare const DarkTheme: WellMapStyles;
+export declare const LightTheme: WellMapStyles;

package/dist/types/components/Html/WellMap/well-map-context.d.ts

@@ -0,0 +1,34 @@
+import { StoreApi, UseBoundStore } from 'zustand';
+import { WellMapState } from './well-map-state';
+/**
+ * Context for providing `WellMap` state.
+ *
+ * @see {@link useWellMapState}
+ * @see {@link WellMap}
+ *
+ * @group Contexts
+ */
+export declare const WellMapContext: import('react').Context<UseBoundStore<StoreApi<WellMapState>>>;
+/**
+ * Allow child components of the `WellMap` component to get information from the well map state
+ *
+ * @example
+ * const wellMapState = useWellMapState()
+ *
+ * const wellboresById = wellMapState(state => state.wellboresById)
+ * const wellboresByName = wellMapState(state => state.wellboresByName)
+ * const ratio = wellMapState(state => state.measures.ratio)
+ * const domain = wellMapState(state => state.domain)
+ * const range = wellMapState(state => state.measures.range)
+ * const slotsById = wellMapState(state => state.slotsById)
+ * const styles = wellMapState(state => state.styles)
+ * const getSlotPosition = wellMapState(state => state.measures.getSlotPosition)
+ *
+ * @remarks
+ * This is meant to be used for WellMap addons
+ *
+ * @see {@link WellMap}
+ *
+ * @group Hooks
+ */
+export declare const useWellMapState: () => UseBoundStore<StoreApi<WellMapState>>;

package/dist/types/components/Html/WellMap/well-map-state.d.ts

@@ -0,0 +1,38 @@
+import { WellboreHeader } from '../../../sdk';
+import { WellMapStyles } from './themes';
+export type WellMapPadding = {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+};
+export type WellMapMeasures = {
+    svgWidth: number;
+    svgHeight: number;
+    tracksWidth: number;
+    trackWidth: number;
+    padding: WellMapPadding;
+    ratio: number;
+    range: [number, number];
+    getSlotPosition: (slot: number) => number;
+};
+export type WellMapState = {
+    _allWellbores: WellboreHeader[];
+    wellbores: WellboreHeader[];
+    wellboreIds: string[];
+    wellboresByName: Record<string, WellboreHeader>;
+    wellboresById: Record<string, WellboreHeader>;
+    segments: Record<string, [number, number]>;
+    tracksOrder: string[];
+    slotsById: Record<string, number>;
+    activeDepths: Record<string, number>;
+    depth?: number;
+    domain: [number, number];
+    measures: WellMapMeasures;
+    styles: WellMapStyles;
+    setStyles: (theme: WellMapStyles) => void;
+    setDepth: (depth: number | undefined) => void;
+    setMeasure: (width: number, height: number) => void;
+    setWellbores: (wellboreHeaders: WellboreHeader[]) => void;
+};
+export declare const createWellMapState: () => import('zustand').UseBoundStore<import('zustand').StoreApi<WellMapState>>;

package/dist/types/components/Html/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Panel/Panel';
+export * from './OutputPanel';
+export * from './WellMap';
+export * from './WellMap/well-map-context';
+export * from './WellMap/well-map-state';

package/dist/types/components/ObservableGroup/ObservableGroup.d.ts

@@ -0,0 +1,38 @@
+import { ThreeElements } from '@react-three/fiber';
+import { PropsWithChildren } from 'react';
+import { Vec3 } from '../../sdk';
+/**
+ * ObservableGroup state
+ */
+export type ObservableGroupState = {
+    center: Vec3;
+    size: Vec3;
+};
+export type BoxPadding = {
+    x0?: number;
+    x1?: number;
+    y0?: number;
+    y1?: number;
+    z0?: number;
+    z1?: number;
+};
+/**
+ * ObservableGroup props
+ * @expand
+ */
+export type ObservableGroupProps = ThreeElements['group'] & {
+    padding?: number | Vec3 | BoxPadding;
+    snapTo?: number;
+    updateRate?: number;
+    enabled?: boolean;
+    onChange?: (state: ObservableGroupState) => void;
+};
+/**
+ * Monitors the bounds of its children and will invoke a callback when it
+ * changes.
+ *
+ * This feature is used by the `BoxGrid` component if `autoSize` is enabled.
+ *
+ * @group Components
+ */
+export declare const ObservableGroup: (props: PropsWithChildren<ObservableGroupProps>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/SDFTest/SDFTest.d.ts

@@ -0,0 +1,12 @@
+type Props = {
+    text: string;
+    inBias?: number;
+    outBias?: number;
+    fontSize?: number;
+    rotation?: number;
+    spacing?: number;
+    verticalAlign?: number;
+    horizontalAlign?: number;
+};
+export declare const SDFTest: ({ text, inBias, outBias, fontSize, rotation, spacing, verticalAlign, horizontalAlign, }: Props) => import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/types/components/Surfaces/Surface.d.ts

@@ -0,0 +1,46 @@
+import { Texture } from 'three';
+import { CommonComponentProps } from '../../common/types';
+import { PointerEvents } from '../../events/interaction-events';
+import { SurfaceMeta, Vec2 } from '../../sdk';
+import { ContourColorMode } from './SurfaceMaterial';
+/**
+ * Surface props
+ * @expand
+ */
+export type SurfaceProps = CommonComponentProps & PointerEvents & {
+    meta: SurfaceMeta;
+    color?: string;
+    colorRamp?: number;
+    rampMin?: number;
+    rampMax?: number;
+    reverseRamp?: boolean;
+    useColorRamp?: boolean;
+    showContours?: boolean;
+    contoursInterval?: number;
+    contoursColorMode?: ContourColorMode;
+    contoursColorModeFactor?: number;
+    contoursThickness?: number;
+    contoursColor?: string;
+    opacity?: number;
+    priority?: number;
+    maxError?: number;
+    doubleSide?: boolean;
+    wireframe?: boolean;
+    normalMap?: Texture;
+    normalScale?: Vec2;
+    debug?: boolean;
+};
+/**
+ * This component renderes a TIN model from an elevation map, according to the `SurfaceMeta` and `SurfaveValues` data types.
+ *
+ * It has several customization options for rendering the surfaces, including color ramps, contour lines and transparency.
+ *
+ * Surface values are expected to be in a regular grid. An optimized triangulation is used for the geometry, but color ramp
+ * values and contour lines are always using the full resolution of the data for accuracy.
+ *
+ * @example
+ * <Surface meta={meta} />
+ *
+ * @group Components
+ */
+export declare const Surface: ({ meta, color, colorRamp, rampMin, rampMax, reverseRamp, useColorRamp, showContours, contoursInterval, contoursColorMode, contoursColorModeFactor, contoursThickness, contoursColor, opacity, priority, maxError, doubleSide, wireframe, normalMap, normalScale, name, userData, receiveShadow, castShadow, layers, position, renderOrder, visible, debug, onPointerClick, onPointerEnter, onPointerLeave, onPointerMove, }: SurfaceProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/Surfaces/SurfaceMaterial.d.ts

@@ -0,0 +1,53 @@
+import { Color, MeshLambertMaterialParameters, ShaderMaterial, ShaderMaterialParameters, Texture, Vector2 } from 'three';
+export declare enum ContourColorMode {
+    darken = 0,
+    lighten = 1,
+    mixed = 2
+}
+export type SurfaceMaterialParameters = ShaderMaterialParameters & MeshLambertMaterialParameters & {
+    useColorRamp?: boolean;
+    saturation?: number;
+    brightness?: number;
+    colorRampIndex?: number;
+    colorRampReverse?: boolean;
+    colorRampMin?: number;
+    colorRampMax?: number;
+    referenceDepth?: number;
+    showContours?: boolean;
+    contoursInterval?: number;
+    contoursColorMode?: ContourColorMode;
+    contoursColorModeFactor?: number;
+    contoursColor?: string | number | Color;
+    elevationTexture?: Texture;
+    normalTexture?: Texture;
+    debug?: boolean;
+};
+/**
+ * Shader material for `Surface` component.
+ *
+ * @see {@link Surface}
+ */
+export declare class SurfaceMaterial extends ShaderMaterial {
+    isMeshSurfaceShader: boolean;
+    normalScale: Vector2;
+    map?: Texture;
+    normalMap?: Texture;
+    wireframeLinecap: string;
+    wireframeLinejoin: string;
+    flatShading: boolean;
+    combine: number;
+    normalMapType: number;
+    constructor(parameters: SurfaceMaterialParameters);
+    get color(): string;
+    set color(value: string);
+    get contoursColor(): string;
+    set contoursColor(value: string);
+    get useColorRamp(): any;
+    set useColorRamp(value: any);
+    get showContours(): any;
+    set showContours(value: any);
+    get debug(): any;
+    set debug(value: any);
+    dispose(): void;
+    onBeforeCompile(): void;
+}

package/dist/types/components/Surfaces/index.d.ts

@@ -0,0 +1,4 @@
+export * from '../../common/color-ramps';
+export * from './Surface';
+export * from './SurfaceMaterial';
+export * from './surface-defs';

package/dist/types/components/Surfaces/surface-defs.d.ts

@@ -0,0 +1,7 @@
+import { PackedBufferGeometry } from '../../sdk';
+export declare const surfaceGeometry = "surfaceGeometry";
+export declare const surfaceTextures = "surfaceTextures";
+export type SurfaceGeometryResponse = PackedBufferGeometry;
+export type SurfaceTexturesResponse = {
+    elevationImageBuffer: Float32Array;
+};

package/dist/types/components/Symbol/Symbol.d.ts

@@ -0,0 +1,45 @@
+import { BufferGeometry, Group, Material } from 'three';
+import { CommonComponentProps } from '../../common/types';
+import { PointerEvents } from '../../events/interaction-events';
+import { SymbolsType } from '../../sdk/data/types/Symbol';
+/**
+ * Symbol props
+ * @expand
+ */
+export type SymbolProps = {
+    geometry: BufferGeometry;
+    material: Material | Material[];
+    data: SymbolsType;
+    customDepthMaterial?: Material;
+    customDistanceMaterial?: Material;
+} & PointerEvents & CommonComponentProps;
+/**
+ * A generic component used for simplifying mesh instancing. Use this component if you need a large number of
+ * meshes sharing the same base geometry and material, but that may be transformed or colored individually.
+ *
+ * Typical use case is for visualizations of data along a wellbore, such as in the `Shoes` and `FormationMarkers` component.
+ *
+ * @remarks
+ * Data, including colors, transformations and user defined data, must be mapped to the `SymbolsType` type.
+ *
+ * @example
+ *  <Symbols
+ *    position={position}
+ *    data={data}
+ *    geometry={geometry}
+ *    material={material}
+ *    layers={layers}
+ *  />
+ *
+ * @see {@link SymbolsType}
+ * @see [InstancedMesh](https://threejs.org/docs/#api/en/objects/InstancedMesh)
+ *
+ * @group Components
+ */
+export declare const Symbols: import('react').ForwardRefExoticComponent<{
+    geometry: BufferGeometry;
+    material: Material | Material[];
+    data: SymbolsType;
+    customDepthMaterial?: Material;
+    customDistanceMaterial?: Material;
+} & PointerEvents & CommonComponentProps & import('react').RefAttributes<Group<import('three').Object3DEventMap>>>;

package/dist/types/components/Symbol/index.d.ts

@@ -0,0 +1 @@
+export * from './Symbol';

package/dist/types/components/UtmArea/UtmArea.d.ts

@@ -0,0 +1,37 @@
+import { CRS } from '../../sdk/projection/crs';
+import { Vec3 } from '../../sdk/types/common';
+/**
+ * UtmArea props
+ * @expand
+ */
+export type UtmAreaProps = {
+    crsInstance?: CRS;
+    utmZone?: string;
+    origin: [number, number];
+    originUnits?: 'utm' | 'lnglat';
+    offset?: Vec3;
+    utmProjectionDef?: string;
+};
+/**
+ * A container component that maps a UTM reference point to a 3d world space origin. This can be used by sub components to
+ * position themselves by using UTM or Wgs84 coordinates as well as converting between these and 3d space coordinates.
+ *
+ * @example
+ * <UtmArea utmZone={utmZone} origin={origin} originUnits={originUnits} offset={offset}>
+ *  { children }
+ * </UtmArea>
+ *
+ * @remarks
+ * This component will return the internal CRS instance when passing a ref
+ *
+ * @see [Storybook](/videx-3d/?path=/docs/components-containers-utmarea--docs)
+ * @see {@link UtmPosition}
+ * @see {@link Wgs84Position}
+ * @see {@link UtmAreaContext}
+ * @see {@link CRS}
+ *
+ * @group Components
+ */
+export declare const UtmArea: import('react').ForwardRefExoticComponent<UtmAreaProps & {
+    children?: import('react').ReactNode | undefined;
+} & import('react').RefAttributes<CRS>>;

package/dist/types/components/UtmArea/UtmAreaContext.d.ts

@@ -0,0 +1,32 @@
+import { Vec2, Vec3 } from '../../sdk';
+export type UtmCoords = {
+    easting: number;
+    northing: number;
+    altitude: number;
+};
+export type Wgs84Coords = {
+    lng: number;
+    lat: number;
+    alt: number;
+};
+/**
+ * UtmAreaContext props
+ * @expand
+ */
+export type UtmAreaContextProps = {
+    originUtm: Vec2;
+    originWgs84: Vec2;
+    utmToArea: (easting: number, northing: number, altitude?: number) => Vec3;
+    wgs84ToArea: (longitude: number, latitude: number, altitude?: number) => Vec3;
+    areaToUtm: (x: number, y: number, z: number) => UtmCoords;
+    worldToUtm: (x: number, y: number, z: number) => UtmCoords;
+    areaToWgs84: (x: number, y: number, z: number) => Wgs84Coords;
+    worldToWgs84: (x: number, y: number, z: number) => Wgs84Coords;
+    getUtmOrigin: () => Vec3;
+    getWorldPosition: () => Vec3;
+};
+/**
+ * Utm Area context
+ * @group Contexts
+ */
+export declare const UtmAreaContext: import('react').Context<UtmAreaContextProps>;

package/dist/types/components/UtmArea/UtmPosition.d.ts

@@ -0,0 +1,26 @@
+import { PropsWithChildren } from 'react';
+/**
+ * UtmPosition props
+ * @expand
+ */
+export type UtmPositionProps = {
+    easting: number;
+    northing: number;
+    altitude?: number;
+};
+/**
+ * Container component which allows sub components positioned relative to a UTM coordinate. Used with the `UtmArea`
+ * component.
+ *
+ * @example
+ * <UtmArea utmZone="31N" origin={[474000, 6522000]}>
+ *  <UtmPosition easing={easting} northing={northing}>
+ *    { children }
+ *  </UtmPosition>
+ * </UtmArea>
+ *
+ * @see {@link UtmArea}
+ *
+ * @group Components
+ */
+export declare const UtmPosition: ({ easting, northing, altitude, children, }: PropsWithChildren<UtmPositionProps>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/UtmArea/Wgs84Position.d.ts

@@ -0,0 +1,26 @@
+import { PropsWithChildren } from 'react';
+/**
+ * Wgs84Position props
+ * @expand
+ */
+export type Wgs84PositionProps = {
+    long: number;
+    lat: number;
+    altitude?: number;
+};
+/**
+ * Container component which allows sub components positioned relative to a long lat coordinate. Used with the `UtmArea`
+ * component.
+ *
+ * @example
+ * <UtmArea utmZone="31N" origin={[474000, 6522000]}>
+ *  <Wgs84Position long={long} lat={lat}>
+ *    { children }
+ *  </Wgs84Position>
+ * </UtmArea>
+ *
+ * @see {@link UtmArea}
+ *
+ * @group Components
+ */
+export declare const Wgs84Position: ({ long, lat, altitude, children, }: PropsWithChildren<Wgs84PositionProps>) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/UtmArea/index.d.ts

@@ -0,0 +1,4 @@
+export * from './UtmArea';
+export * from './UtmAreaContext';
+export * from './UtmPosition';
+export * from './Wgs84Position';

package/dist/types/components/Wellbores/BasicTrajectory/BasicTrajectory.d.ts

@@ -0,0 +1,27 @@
+import { CommonComponentProps, CustomMaterialProps } from '../../../common/types';
+/**
+ * BasicTrajectory props
+ * @expand
+ */
+export type BasicTrajectoryProps = CommonComponentProps & CustomMaterialProps & {
+    color?: string;
+    priority?: number;
+};
+/**
+ * The BasicTrajectory renders a wellbore trajectory as a 1 pixel line.
+ * This component must be a child of the `Wellbore` component.
+ *
+ * @example
+ * <Wellbore id="abc">
+ *  <BasicTrajectory />
+ * </Wellbore>
+ *
+ * @remarks
+ * This component depends on the {@link basicTrajectory} generator.
+ *
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-basictrajectory--docs)
+ * @see [Generators](/videx-3d/docs/documents/generators.html)
+ *
+ * @group Components
+ */
+export declare const BasicTrajectory: ({ name, userData, position, castShadow, receiveShadow, layers, renderOrder, visible, customDepthMaterial, customDistanceMaterial, customMaterial, onMaterialPropertiesChange, color, priority, }: BasicTrajectoryProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/Wellbores/BasicTrajectory/basic-trajectory-defs.d.ts

@@ -0,0 +1,3 @@
+import { PackedBufferGeometry } from '../../../sdk';
+export declare const basicTrajectory = "basicTrajectory";
+export type BasicTrajectoryGeneratorResponse = PackedBufferGeometry;

package/dist/types/components/Wellbores/BasicTrajectory/index.d.ts

@@ -0,0 +1,2 @@
+export * from './BasicTrajectory';
+export * from './basic-trajectory-defs';

package/dist/types/components/Wellbores/Casings/CasingAnnotations/CasingAnnotations.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Adds annotations for casing data. This component needs to be a child of the `Wellbore` component.
+ *
+ * @see {@link Wellbore}
+ * @see {@link Annotations}
+ *
+ * @group Components
+ */
+export declare const CasingAnnotations: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Wellbores/Casings/CasingAnnotations/CasingLabel.d.ts

@@ -0,0 +1,9 @@
+import { AnnotationComponentProps } from '../../../Annotations/types';
+/**
+ * Annotation label for `CasingAnnotations`
+ *
+ * @see {@link CasingAnnotations}
+ *
+ * @group Components
+ */
+export declare const CasingLabel: ({ id, name, data }: AnnotationComponentProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Wellbores/Casings/CasingAnnotations/casing-annotations-defs.d.ts

@@ -0,0 +1 @@
+export declare const casingAnnotations = "casingToolAnnotations";