@equinor/videx-3d 5.1.0-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (235) hide show
  1. package/LICENSE.md +21 -0
  2. package/README.md +120 -0
  3. package/dist/chunk-BX-cez1_.js +23 -0
  4. package/dist/chunk-CnY6Tmof.js +358 -0
  5. package/dist/chunk-MFzFdEWm.js +591 -0
  6. package/dist/chunk-iY0wQ9Z6.js +887 -0
  7. package/dist/generators.js +711 -0
  8. package/dist/main.js +8405 -0
  9. package/dist/sdk.js +610 -0
  10. package/dist/shaderLib/color-conversion.glsl +33 -0
  11. package/dist/shaderLib/colors.glsl +8 -0
  12. package/dist/shaderLib/glyphs.glsl +78 -0
  13. package/dist/shaderLib/random.glsl +3 -0
  14. package/dist/shaderLib/remap.glsl +13 -0
  15. package/dist/shaderLib/render-number.glsl +74 -0
  16. package/dist/shaderLib/render-text.glsl +66 -0
  17. package/dist/shaderLib/rotation.glsl +19 -0
  18. package/dist/shaderLib/sdf-functions.glsl +18 -0
  19. package/dist/textures/normal_map.jpg +0 -0
  20. package/dist/types/common/color-ramps.d.ts +5 -0
  21. package/dist/types/common/types.d.ts +25 -0
  22. package/dist/types/components/Annotations/Annotations.d.ts +42 -0
  23. package/dist/types/components/Annotations/AnnotationsHMTL.d.ts +1 -0
  24. package/dist/types/components/Annotations/AnnotationsLayer.d.ts +46 -0
  25. package/dist/types/components/Annotations/AutoUpdate.d.ts +3 -0
  26. package/dist/types/components/Annotations/DefaultLabelComponent.d.ts +11 -0
  27. package/dist/types/components/Annotations/TestAnnotations.d.ts +12 -0
  28. package/dist/types/components/Annotations/annotations-renderer.d.ts +26 -0
  29. package/dist/types/components/Annotations/annotations-state.d.ts +88 -0
  30. package/dist/types/components/Annotations/helpers.d.ts +11 -0
  31. package/dist/types/components/Annotations/index.d.ts +8 -0
  32. package/dist/types/components/Annotations/types.d.ts +80 -0
  33. package/dist/types/components/Annotations/update-annotations.d.ts +12 -0
  34. package/dist/types/components/CameraTargetMarker/CameraTargetMarker.d.ts +29 -0
  35. package/dist/types/components/Distance/Distance.d.ts +35 -0
  36. package/dist/types/components/Distance/DistanceContext.d.ts +12 -0
  37. package/dist/types/components/Distance/index.d.ts +2 -0
  38. package/dist/types/components/EventEmitter/EventEmitter.d.ts +20 -0
  39. package/dist/types/components/EventEmitter/EventEmitterContext.d.ts +90 -0
  40. package/dist/types/components/EventEmitter/index.d.ts +3 -0
  41. package/dist/types/components/EventEmitter/picking-helper.d.ts +32 -0
  42. package/dist/types/components/EventEmitter/picking-material.d.ts +11 -0
  43. package/dist/types/components/Grids/BoxGrid/BoxGrid.d.ts +52 -0
  44. package/dist/types/components/Grids/Grid/Grid.d.ts +62 -0
  45. package/dist/types/components/Grids/Grid/GridAxesLabels.d.ts +24 -0
  46. package/dist/types/components/Grids/Grid/UtmGrid.d.ts +30 -0
  47. package/dist/types/components/Grids/Grid/grid-helpers.d.ts +2 -0
  48. package/dist/types/components/Grids/index.d.ts +5 -0
  49. package/dist/types/components/Highlighter/Highlighter.d.ts +23 -0
  50. package/dist/types/components/Highlighter/highlight-state.d.ts +43 -0
  51. package/dist/types/components/Highlighter/index.d.ts +2 -0
  52. package/dist/types/components/Html/DepthSelector.d.ts +1 -0
  53. package/dist/types/components/Html/OutputPanel/OutputPanel.d.ts +10 -0
  54. package/dist/types/components/Html/OutputPanel/index.d.ts +2 -0
  55. package/dist/types/components/Html/OutputPanel/output-panel-state.d.ts +38 -0
  56. package/dist/types/components/Html/Panel/Panel.d.ts +20 -0
  57. package/dist/types/components/Html/WellMap/ActiveTrack.d.ts +9 -0
  58. package/dist/types/components/Html/WellMap/DepthCursor.d.ts +8 -0
  59. package/dist/types/components/Html/WellMap/DepthReadout.d.ts +6 -0
  60. package/dist/types/components/Html/WellMap/Schematic.d.ts +15 -0
  61. package/dist/types/components/Html/WellMap/Track.d.ts +13 -0
  62. package/dist/types/components/Html/WellMap/WellMap.d.ts +47 -0
  63. package/dist/types/components/Html/WellMap/addons/WellMapCasingShoes.d.ts +14 -0
  64. package/dist/types/components/Html/WellMap/addons/WellMapCompletionIntervals.d.ts +15 -0
  65. package/dist/types/components/Html/WellMap/addons/WellMapFormations.d.ts +14 -0
  66. package/dist/types/components/Html/WellMap/addons/WellMapTvd.d.ts +14 -0
  67. package/dist/types/components/Html/WellMap/addons/index.d.ts +4 -0
  68. package/dist/types/components/Html/WellMap/index.d.ts +4 -0
  69. package/dist/types/components/Html/WellMap/themes.d.ts +13 -0
  70. package/dist/types/components/Html/WellMap/well-map-context.d.ts +34 -0
  71. package/dist/types/components/Html/WellMap/well-map-state.d.ts +38 -0
  72. package/dist/types/components/Html/index.d.ts +5 -0
  73. package/dist/types/components/ObservableGroup/ObservableGroup.d.ts +38 -0
  74. package/dist/types/components/SDFTest/SDFTest.d.ts +12 -0
  75. package/dist/types/components/Surfaces/Surface.d.ts +46 -0
  76. package/dist/types/components/Surfaces/SurfaceMaterial.d.ts +53 -0
  77. package/dist/types/components/Surfaces/index.d.ts +4 -0
  78. package/dist/types/components/Surfaces/surface-defs.d.ts +7 -0
  79. package/dist/types/components/Symbol/Symbol.d.ts +45 -0
  80. package/dist/types/components/Symbol/index.d.ts +1 -0
  81. package/dist/types/components/UtmArea/UtmArea.d.ts +37 -0
  82. package/dist/types/components/UtmArea/UtmAreaContext.d.ts +32 -0
  83. package/dist/types/components/UtmArea/UtmPosition.d.ts +26 -0
  84. package/dist/types/components/UtmArea/Wgs84Position.d.ts +26 -0
  85. package/dist/types/components/UtmArea/index.d.ts +4 -0
  86. package/dist/types/components/Wellbores/BasicTrajectory/BasicTrajectory.d.ts +27 -0
  87. package/dist/types/components/Wellbores/BasicTrajectory/basic-trajectory-defs.d.ts +3 -0
  88. package/dist/types/components/Wellbores/BasicTrajectory/index.d.ts +2 -0
  89. package/dist/types/components/Wellbores/Casings/CasingAnnotations/CasingAnnotations.d.ts +9 -0
  90. package/dist/types/components/Wellbores/Casings/CasingAnnotations/CasingLabel.d.ts +9 -0
  91. package/dist/types/components/Wellbores/Casings/CasingAnnotations/casing-annotations-defs.d.ts +1 -0
  92. package/dist/types/components/Wellbores/Casings/Casings.d.ts +42 -0
  93. package/dist/types/components/Wellbores/Casings/casings-defs.d.ts +6 -0
  94. package/dist/types/components/Wellbores/Casings/index.d.ts +5 -0
  95. package/dist/types/components/Wellbores/CompletionTools/CompletionAnnotations/CompletionAnnotations.d.ts +9 -0
  96. package/dist/types/components/Wellbores/CompletionTools/CompletionAnnotations/completion-annotations-defs.d.ts +1 -0
  97. package/dist/types/components/Wellbores/CompletionTools/CompletionTools.d.ts +31 -0
  98. package/dist/types/components/Wellbores/CompletionTools/Screen/screen-material.d.ts +8 -0
  99. package/dist/types/components/Wellbores/CompletionTools/completion-tools-defs.d.ts +4 -0
  100. package/dist/types/components/Wellbores/CompletionTools/index.d.ts +5 -0
  101. package/dist/types/components/Wellbores/DepthMarkers/DepthMarkerLabel.d.ts +11 -0
  102. package/dist/types/components/Wellbores/DepthMarkers/DepthMarkers.d.ts +27 -0
  103. package/dist/types/components/Wellbores/DepthMarkers/depth-markers-defs.d.ts +1 -0
  104. package/dist/types/components/Wellbores/DepthMarkers/index.d.ts +3 -0
  105. package/dist/types/components/Wellbores/FormationMarkers/FormationMarkerLabel.d.ts +10 -0
  106. package/dist/types/components/Wellbores/FormationMarkers/FormationMarkers.d.ts +33 -0
  107. package/dist/types/components/Wellbores/FormationMarkers/formation-markers-defs.d.ts +3 -0
  108. package/dist/types/components/Wellbores/FormationMarkers/index.d.ts +3 -0
  109. package/dist/types/components/Wellbores/Perforations/Perforations.d.ts +32 -0
  110. package/dist/types/components/Wellbores/Perforations/index.d.ts +2 -0
  111. package/dist/types/components/Wellbores/Perforations/perforations-defs.d.ts +3 -0
  112. package/dist/types/components/Wellbores/Perimeter/Perimeter.d.ts +29 -0
  113. package/dist/types/components/Wellbores/Perimeter/index.d.ts +2 -0
  114. package/dist/types/components/Wellbores/Perimeter/perimeter-defs.d.ts +3 -0
  115. package/dist/types/components/Wellbores/PositionMarkers/PositionMarkers.d.ts +12 -0
  116. package/dist/types/components/Wellbores/PositionMarkers/position-markers-defs.d.ts +3 -0
  117. package/dist/types/components/Wellbores/Shoes/Shoes.d.ts +34 -0
  118. package/dist/types/components/Wellbores/Shoes/index.d.ts +2 -0
  119. package/dist/types/components/Wellbores/Shoes/shoes-defs.d.ts +3 -0
  120. package/dist/types/components/Wellbores/TubeTrajectory/TubeTrajectory.d.ts +25 -0
  121. package/dist/types/components/Wellbores/TubeTrajectory/index.d.ts +2 -0
  122. package/dist/types/components/Wellbores/TubeTrajectory/tube-geometry-defs.d.ts +3 -0
  123. package/dist/types/components/Wellbores/Wellbore/Wellbore.d.ts +45 -0
  124. package/dist/types/components/Wellbores/Wellbore/WellboreContext.d.ts +19 -0
  125. package/dist/types/components/Wellbores/Wellbore/index.d.ts +2 -0
  126. package/dist/types/components/Wellbores/WellboreBounds/WellboreBounds.d.ts +47 -0
  127. package/dist/types/components/Wellbores/WellboreBounds/index.d.ts +2 -0
  128. package/dist/types/components/Wellbores/WellboreBounds/wellbore-bounds-defs.d.ts +1 -0
  129. package/dist/types/components/Wellbores/WellboreFormationColumn/WellboreFormationColumn.d.ts +30 -0
  130. package/dist/types/components/Wellbores/WellboreFormationColumn/index.d.ts +2 -0
  131. package/dist/types/components/Wellbores/WellboreFormationColumn/wellbore-formation-column-defs.d.ts +3 -0
  132. package/dist/types/components/Wellbores/WellboreLabel/WellboreAnnotationLabel.d.ts +10 -0
  133. package/dist/types/components/Wellbores/WellboreLabel/WellboreLabel.d.ts +25 -0
  134. package/dist/types/components/Wellbores/WellboreLabel/index.d.ts +3 -0
  135. package/dist/types/components/Wellbores/WellboreLabel/wellbore-label-defs.d.ts +1 -0
  136. package/dist/types/components/Wellbores/WellboreRibbon/WellboreRibbon.d.ts +22 -0
  137. package/dist/types/components/Wellbores/WellboreRibbon/WellboreRibbonContext.d.ts +16 -0
  138. package/dist/types/components/Wellbores/WellboreRibbon/index.d.ts +4 -0
  139. package/dist/types/components/Wellbores/WellboreRibbon/stripes/FormationsStripe.d.ts +30 -0
  140. package/dist/types/components/Wellbores/WellboreRibbon/stripes/MeasuredDepthStripe.d.ts +28 -0
  141. package/dist/types/components/Wellbores/WellboreSeismicSection/WellboreSeismicSection.d.ts +34 -0
  142. package/dist/types/components/Wellbores/WellboreSeismicSection/index.d.ts +2 -0
  143. package/dist/types/components/Wellbores/WellboreSeismicSection/wellbore-seismic-section-defs.d.ts +12 -0
  144. package/dist/types/components/Wellbores/Wells/Wells.d.ts +43 -0
  145. package/dist/types/components/Wellbores/Wells/index.d.ts +1 -0
  146. package/dist/types/contexts/DataContext.d.ts +15 -0
  147. package/dist/types/contexts/DataContextProvider.d.ts +33 -0
  148. package/dist/types/contexts/GeneratorsContext.d.ts +13 -0
  149. package/dist/types/contexts/GeneratorsContextProvider.d.ts +34 -0
  150. package/dist/types/contexts/GlyphsContext.d.ts +19 -0
  151. package/dist/types/contexts/GlyphsContextProvider.d.ts +29 -0
  152. package/dist/types/events/camera-events.d.ts +34 -0
  153. package/dist/types/events/depth-events.d.ts +22 -0
  154. package/dist/types/events/interaction-events.d.ts +7 -0
  155. package/dist/types/events/wellbore-events.d.ts +46 -0
  156. package/dist/types/generators/basic-trajectory-generator.d.ts +2 -0
  157. package/dist/types/generators/casing-annotations-generator.d.ts +8 -0
  158. package/dist/types/generators/casings-generator.d.ts +4 -0
  159. package/dist/types/generators/completion-annotations-generator.d.ts +7 -0
  160. package/dist/types/generators/completion-tools-generator.d.ts +2 -0
  161. package/dist/types/generators/depth-markers-generator.d.ts +3 -0
  162. package/dist/types/generators/formation-markers-generator.d.ts +2 -0
  163. package/dist/types/generators/index.d.ts +20 -0
  164. package/dist/types/generators/perforations-generator.d.ts +2 -0
  165. package/dist/types/generators/perimieter-generator.d.ts +2 -0
  166. package/dist/types/generators/position-markers-generator.d.ts +2 -0
  167. package/dist/types/generators/shoes-generator.d.ts +2 -0
  168. package/dist/types/generators/surface-generator.d.ts +4 -0
  169. package/dist/types/generators/tube-trajectory-generator.d.ts +2 -0
  170. package/dist/types/generators/wellbore-bounds-generator.d.ts +2 -0
  171. package/dist/types/generators/wellbore-formation-column-generator.d.ts +2 -0
  172. package/dist/types/generators/wellbore-label-generator.d.ts +7 -0
  173. package/dist/types/generators/wellbore-seismic-section-generator.d.ts +3 -0
  174. package/dist/types/hooks/useData.d.ts +25 -0
  175. package/dist/types/hooks/useGenerator.d.ts +43 -0
  176. package/dist/types/hooks/useWellboreContext.d.ts +13 -0
  177. package/dist/types/layers/layers.d.ts +6 -0
  178. package/dist/types/main.d.ts +48 -0
  179. package/dist/types/rendering/fullscreen-renderer.d.ts +9 -0
  180. package/dist/types/rendering/index.d.ts +2 -0
  181. package/dist/types/rendering/render-passes.d.ts +16 -0
  182. package/dist/types/sdk/data/DataLoader.d.ts +54 -0
  183. package/dist/types/sdk/data/GeneratorRegistry.d.ts +15 -0
  184. package/dist/types/sdk/data/Store.d.ts +29 -0
  185. package/dist/types/sdk/data/helpers/formations-helpers.d.ts +24 -0
  186. package/dist/types/sdk/data/helpers/well-helpers.d.ts +9 -0
  187. package/dist/types/sdk/data/types/Casing.d.ts +8 -0
  188. package/dist/types/sdk/data/types/CompletionTool.d.ts +11 -0
  189. package/dist/types/sdk/data/types/DepthReferencePoint.d.ts +1 -0
  190. package/dist/types/sdk/data/types/Formation.d.ts +32 -0
  191. package/dist/types/sdk/data/types/PerforationInterval.d.ts +9 -0
  192. package/dist/types/sdk/data/types/Pick.d.ts +8 -0
  193. package/dist/types/sdk/data/types/PositionLog.d.ts +17 -0
  194. package/dist/types/sdk/data/types/StratColumn.d.ts +18 -0
  195. package/dist/types/sdk/data/types/SurfaceMeta.d.ts +23 -0
  196. package/dist/types/sdk/data/types/SurfaceValues.d.ts +1 -0
  197. package/dist/types/sdk/data/types/Symbol.d.ts +6 -0
  198. package/dist/types/sdk/data/types/VerticalSlice.d.ts +9 -0
  199. package/dist/types/sdk/data/types/WellboreHeader.d.ts +15 -0
  200. package/dist/types/sdk/data/types/index.d.ts +11 -0
  201. package/dist/types/sdk/geometries/curve/curve-3d.d.ts +46 -0
  202. package/dist/types/sdk/geometries/curve/tube-geometry.d.ts +34 -0
  203. package/dist/types/sdk/geometries/delatin.d.ts +44 -0
  204. package/dist/types/sdk/geometries/fence.d.ts +3 -0
  205. package/dist/types/sdk/geometries/packing.d.ts +46 -0
  206. package/dist/types/sdk/geometries/triangulate-grid-delaunay.d.ts +8 -0
  207. package/dist/types/sdk/geometries/triangulate-grid.d.ts +28 -0
  208. package/dist/types/sdk/index.d.ts +39 -0
  209. package/dist/types/sdk/managers/CameraManager.d.ts +11 -0
  210. package/dist/types/sdk/managers/WellboreManager.d.ts +18 -0
  211. package/dist/types/sdk/materials/depth-material.d.ts +4 -0
  212. package/dist/types/sdk/materials/ribbon-material.d.ts +24 -0
  213. package/dist/types/sdk/materials/tube-material.d.ts +7 -0
  214. package/dist/types/sdk/materials/uv-material.d.ts +2 -0
  215. package/dist/types/sdk/projection/crs.d.ts +37 -0
  216. package/dist/types/sdk/types/common.d.ts +4 -0
  217. package/dist/types/sdk/utils/array.d.ts +0 -0
  218. package/dist/types/sdk/utils/colors.d.ts +2 -0
  219. package/dist/types/sdk/utils/conversions.d.ts +5 -0
  220. package/dist/types/sdk/utils/depth-reader.d.ts +5 -0
  221. package/dist/types/sdk/utils/elevation-map.d.ts +15 -0
  222. package/dist/types/sdk/utils/glyphs.d.ts +50 -0
  223. package/dist/types/sdk/utils/irapbin-parser.d.ts +17 -0
  224. package/dist/types/sdk/utils/num-array.d.ts +2 -0
  225. package/dist/types/sdk/utils/numbers.d.ts +5 -0
  226. package/dist/types/sdk/utils/packing.d.ts +1 -0
  227. package/dist/types/sdk/utils/scene.d.ts +2 -0
  228. package/dist/types/sdk/utils/segments.d.ts +4 -0
  229. package/dist/types/sdk/utils/strings.d.ts +2 -0
  230. package/dist/types/sdk/utils/trajectory.d.ts +59 -0
  231. package/dist/types/sdk/utils/trigonometry.d.ts +12 -0
  232. package/dist/types/sdk/utils/typed-2d-array.d.ts +52 -0
  233. package/dist/types/sdk/utils/typed-array.d.ts +2 -0
  234. package/dist/types/sdk/utils/vector-operations.d.ts +29 -0
  235. package/package.json +127 -0
@@ -0,0 +1,42 @@
1
+ import { ReactElement } from 'react';
2
+ import { Group, Object3D } from 'three';
3
+ import { CommonComponentProps, CustomMaterialProps } from '../../../common/types';
4
+ /**
5
+ * Casing props
6
+ * @expand
7
+ */
8
+ export type CasingProps = CommonComponentProps & CustomMaterialProps & {
9
+ fallback?: () => ReactElement<Object3D>;
10
+ radialSegments?: number;
11
+ sizeMultiplier?: number;
12
+ shoeFactor?: number;
13
+ overrideSegmentsPerMeter?: number;
14
+ overrideSimplificationThreshold?: number;
15
+ opacity?: number;
16
+ priority?: number;
17
+ };
18
+ /**
19
+ * Generic render of casings based on depths, diameters and type. Must be a child of the `Wellbore` component.
20
+ *
21
+ * @example
22
+ * <Wellbore id={wellbore.id}>
23
+ * <Casings sizeMultiplier={5} />
24
+ * </Wellbore>
25
+ *
26
+ * @remarks
27
+ * The `fallback` prop may be used to render a different component if there is no completion tool data available for the wellbore.
28
+ *
29
+ * @see {@link Wellbore}
30
+ *
31
+ * @group Components
32
+ */
33
+ export declare const Casings: import('react').ForwardRefExoticComponent<CommonComponentProps & CustomMaterialProps & {
34
+ fallback?: () => ReactElement<Object3D>;
35
+ radialSegments?: number;
36
+ sizeMultiplier?: number;
37
+ shoeFactor?: number;
38
+ overrideSegmentsPerMeter?: number;
39
+ overrideSimplificationThreshold?: number;
40
+ opacity?: number;
41
+ priority?: number;
42
+ } & import('react').RefAttributes<Group<import('three').Object3DEventMap>>>;
@@ -0,0 +1,6 @@
1
+ import { PackedBufferGeometry } from '../../../sdk';
2
+ export declare const casings = "casings";
3
+ export type CasingsGeneratorResponse = {
4
+ geometry: PackedBufferGeometry;
5
+ };
6
+ export declare const casingsMaterialIndices: Record<string, number>;
@@ -0,0 +1,5 @@
1
+ export * from './Casings';
2
+ export * from './casings-defs';
3
+ export * from './CasingAnnotations/CasingAnnotations';
4
+ export * from './CasingAnnotations/CasingLabel';
5
+ export * from './CasingAnnotations/casing-annotations-defs';
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Adds annotations for completion data. This component needs to be a child of the `Wellbore` component.
3
+ *
4
+ * @see {@link Wellbore}
5
+ * @see {@link Annotations}
6
+ *
7
+ * @group Components
8
+ */
9
+ export declare const CompletionAnnotations: () => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1 @@
1
+ export declare const completionToolAnnotations = "completionToolAnnotations";
@@ -0,0 +1,31 @@
1
+ import { ReactElement } from 'react';
2
+ import { Object3D } from 'three';
3
+ import { CommonComponentProps, CustomMaterialProps } from '../../../common/types';
4
+ /**
5
+ * CompletionTools props
6
+ * @expand
7
+ */
8
+ export type CompletionToolsProps = CommonComponentProps & CustomMaterialProps & {
9
+ radialSegments?: number;
10
+ sizeMultiplier?: number;
11
+ overrideSegmentsPerMeter?: number;
12
+ overrideSimplificationThreshold?: number;
13
+ fallback?: () => ReactElement<Object3D>;
14
+ priority?: number;
15
+ };
16
+ /**
17
+ * Generic render of completion tools based on depths, diameters and type. Must be a child of the `Wellbore` component.
18
+ *
19
+ * @example
20
+ * <Wellbore id={wellbore.id}>
21
+ * <CompletionTools sizeMultiplier={5} />
22
+ * </Wellbore>
23
+ *
24
+ * @remarks
25
+ * The `fallback` prop may be used to render a different component if there is no completion tool data available for the wellbore.
26
+ *
27
+ * @see {@link Wellbore}
28
+ *
29
+ * @group Components
30
+ */
31
+ export declare const CompletionTools: ({ name, userData, renderOrder, layers, position, visible, castShadow, receiveShadow, customMaterial, customDepthMaterial, customDistanceMaterial, radialSegments, sizeMultiplier, overrideSegmentsPerMeter, overrideSimplificationThreshold, priority, fallback, }: CompletionToolsProps) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,8 @@
1
+ import { ShaderMaterial } from 'three';
2
+ export declare class ScreenMaterial extends ShaderMaterial {
3
+ constructor(params?: any);
4
+ get color1(): any;
5
+ set color1(value: any);
6
+ get color2(): any;
7
+ set color2(value: any);
8
+ }
@@ -0,0 +1,4 @@
1
+ import { PackedBufferGeometry } from '../../../sdk';
2
+ export declare const completionTools = "completionTools";
3
+ export type CompletionToolsGeneratorResponse = PackedBufferGeometry;
4
+ export declare const completionToolsMaterialIndices: Record<string, number>;
@@ -0,0 +1,5 @@
1
+ export * from './CompletionTools';
2
+ export * from './completion-tools-defs';
3
+ export * from './Screen/screen-material';
4
+ export * from './CompletionAnnotations/CompletionAnnotations';
5
+ export * from './CompletionAnnotations/completion-annotations-defs';
@@ -0,0 +1,11 @@
1
+ import { AnnotationComponentProps } from '../../Annotations/types';
2
+ /**
3
+ * Annotation label component used for `DepthMarkers`
4
+ *
5
+ *
6
+ * @see {@link DepthMarkers}
7
+ * @see {@link Annotations}
8
+ *
9
+ * @group Components
10
+ */
11
+ export declare const DepthMarkerLabel: ({ id, name }: AnnotationComponentProps) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,27 @@
1
+ import { Object3D } from 'three';
2
+ import { DepthReferencePoint } from '../../../sdk/data/types/DepthReferencePoint';
3
+ /**
4
+ * DepthMarkers props
5
+ * @expand
6
+ */
7
+ export type DepthMarkersProps = {
8
+ depthReferencePoint?: DepthReferencePoint;
9
+ interval?: number;
10
+ priority?: number;
11
+ };
12
+ /**
13
+ * Adds depth markers as annotations for a wellbore
14
+ *
15
+ * @example
16
+ * <Wellbore id={wellbore.id}>
17
+ * <DepthMarkers interval={250} />
18
+ * </Wellbore>
19
+ *
20
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-depthmarkers--docs)
21
+ * @see {@link DepthMarkerLabel}
22
+ * @see {@link Wellbore}
23
+ * @see {@link Annotations}
24
+ *
25
+ * @group Components
26
+ */
27
+ export declare const DepthMarkers: import('react').ForwardRefExoticComponent<DepthMarkersProps & import('react').RefAttributes<Object3D<import('three').Object3DEventMap>>>;
@@ -0,0 +1 @@
1
+ export declare const depthMarkers = "depth-markers";
@@ -0,0 +1,3 @@
1
+ export * from './DepthMarkers';
2
+ export * from './depth-markers-defs';
3
+ export * from './DepthMarkerLabel';
@@ -0,0 +1,10 @@
1
+ import { AnnotationComponentProps } from '../../Annotations/types';
2
+ /**
3
+ * Annotation label component used for `FormationMarkers`
4
+ *
5
+ * @see {@link FormationMarkers}
6
+ * @see {@link Annotations}
7
+ *
8
+ * @group Components
9
+ */
10
+ export declare const FormationMarkerLabel: ({ id, name, data, }: AnnotationComponentProps) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,33 @@
1
+ import { Group } from 'three';
2
+ import { CommonComponentProps } from '../../../common/types';
3
+ /**
4
+ * FormationMarker props
5
+ * @expand
6
+ */
7
+ export type FormationMarkerProps = CommonComponentProps & {
8
+ radialSegments?: number;
9
+ baseRadius?: number;
10
+ priority?: number;
11
+ stratColumnId: string;
12
+ showAnnotations?: boolean;
13
+ };
14
+ /**
15
+ * Render formation markers along a wellbore trajectory. This uses the `Symbols` component internally.
16
+ *
17
+ * @example
18
+ * <Wellbore id={wellboreId}>
19
+ * <FormationMarkers showAnnotations stratColumnId="abcd" />
20
+ * </Wellbore>
21
+ *
22
+ * @see {@link Wellbore}
23
+ * @see {@link Symbols}
24
+ *
25
+ * @group Components
26
+ */
27
+ export declare const FormationMarkers: import('react').ForwardRefExoticComponent<CommonComponentProps & {
28
+ radialSegments?: number;
29
+ baseRadius?: number;
30
+ priority?: number;
31
+ stratColumnId: string;
32
+ showAnnotations?: boolean;
33
+ } & import('react').RefAttributes<Group<import('three').Object3DEventMap>>>;
@@ -0,0 +1,3 @@
1
+ import { SymbolsType } from '../../../sdk';
2
+ export declare const formationMarkerSymbols = "formationMarkerSymbols";
3
+ export type FormationMarkersGeneratorResponse = SymbolsType;
@@ -0,0 +1,3 @@
1
+ export * from './formation-markers-defs';
2
+ export * from './FormationMarkerLabel';
3
+ export * from './FormationMarkers';
@@ -0,0 +1,32 @@
1
+ import { Group } from 'three';
2
+ import { CommonComponentProps, CustomMaterialProps } from '../../../common/types';
3
+ /**
4
+ * Perforations props
5
+ * @expand
6
+ */
7
+ export type PerforationsProps = CommonComponentProps & CustomMaterialProps & {
8
+ radialSegments?: number;
9
+ baseRadius?: number;
10
+ length?: number;
11
+ sizeMultiplier?: number;
12
+ priority?: number;
13
+ };
14
+ /**
15
+ * Generic render of perforation intervals based on depths, phase and density. Must be a child of the `Wellbore` component.
16
+ *
17
+ * @example
18
+ * <Wellbore id={wellbore.id}>
19
+ * <Perforations sizeMultiplier={5} />
20
+ * </Wellbore>
21
+ *
22
+ * @see {@link Wellbore}
23
+ *
24
+ * @group Components
25
+ */
26
+ export declare const Perforations: import('react').ForwardRefExoticComponent<CommonComponentProps & CustomMaterialProps & {
27
+ radialSegments?: number;
28
+ baseRadius?: number;
29
+ length?: number;
30
+ sizeMultiplier?: number;
31
+ priority?: number;
32
+ } & import('react').RefAttributes<Group<import('three').Object3DEventMap>>>;
@@ -0,0 +1,2 @@
1
+ export * from './Perforations';
2
+ export * from './perforations-defs';
@@ -0,0 +1,3 @@
1
+ import { SymbolsType } from '../../../sdk';
2
+ export declare const perforationSymbols = "perforationSymbols";
3
+ export type PerformationsGeneratorResponse = SymbolsType;
@@ -0,0 +1,29 @@
1
+ import { Color } from 'three';
2
+ import { CommonComponentProps, CustomMaterialProps } from '../../../common/types';
3
+ /**
4
+ * Perimeter props
5
+ * @expand
6
+ */
7
+ export type PerimeterProps = CommonComponentProps & CustomMaterialProps & {
8
+ color?: string | Color | number;
9
+ radius: number;
10
+ from: number;
11
+ to: number;
12
+ opacity?: number;
13
+ priority?: number;
14
+ };
15
+ /**
16
+ * A simple cylindrical perimeter that can be rendered on top of a wellbore trajectory, with a given
17
+ * start and end depth as well as a radius.
18
+ *
19
+ * @example
20
+ * <Wellbore id={wellbore.id}>
21
+ * <Perimeter from={1000} to={5000} radius={10} />
22
+ * </Wellbore>
23
+ *
24
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-perimeter--docs)
25
+ * @see {@link Wellbore}
26
+ *
27
+ * @group Components
28
+ */
29
+ export declare const Perimeter: ({ color, radius, from, to, opacity, name, userData, visible, layers, position, renderOrder, castShadow, receiveShadow, customDepthMaterial, customDistanceMaterial, customMaterial, onMaterialPropertiesChange, priority, }: PerimeterProps) => import("react/jsx-runtime").JSX.Element | null;
@@ -0,0 +1,2 @@
1
+ export * from './Perimeter';
2
+ export * from './perimeter-defs';
@@ -0,0 +1,3 @@
1
+ import { PackedBufferGeometry } from '../../../sdk';
2
+ export declare const perimeterGeometry = "perimeterGeometry";
3
+ export type PerimeterGeneratorResponse = PackedBufferGeometry;
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Test
3
+ */
4
+ type Props = {
5
+ radius?: number;
6
+ opacity?: number;
7
+ interval?: number;
8
+ priority?: number;
9
+ renderOrder?: number;
10
+ };
11
+ export declare const PositionMarkers: ({ radius, opacity, interval, priority, renderOrder, }: Props) => import("react/jsx-runtime").JSX.Element;
12
+ export {};
@@ -0,0 +1,3 @@
1
+ import { SymbolsType } from '../../../sdk';
2
+ export declare const positionMarkers = "positionMarkers";
3
+ export type PositionMarkersGeneratorResponse = SymbolsType;
@@ -0,0 +1,34 @@
1
+ import { Color, Group } from 'three';
2
+ import { CommonComponentProps } from '../../../common/types';
3
+ /**
4
+ * Shoes props
5
+ * @expand
6
+ */
7
+ export type ShoesProps = CommonComponentProps & {
8
+ radialSegments?: number;
9
+ sizeMultiplier?: number;
10
+ color?: string | number | Color;
11
+ priority?: number;
12
+ };
13
+ /**
14
+ * Render shoe markers along a wellbore trajectory. This uses the `Symbols` component internally.
15
+ *
16
+ * @example
17
+ * <Wellbore id={wellboreId}>
18
+ * <Shoes />
19
+ * </Wellbore>
20
+ *
21
+ * @remarks
22
+ * A filtered set of the casing data is used by default to render shoes.
23
+ *
24
+ * @see {@link Wellbore}
25
+ * @see {@link Symbols}
26
+ *
27
+ * @group Components
28
+ */
29
+ export declare const Shoes: import('react').ForwardRefExoticComponent<CommonComponentProps & {
30
+ radialSegments?: number;
31
+ sizeMultiplier?: number;
32
+ color?: string | number | Color;
33
+ priority?: number;
34
+ } & import('react').RefAttributes<Group<import('three').Object3DEventMap>>>;
@@ -0,0 +1,2 @@
1
+ export * from './Shoes';
2
+ export * from './shoes-defs';
@@ -0,0 +1,3 @@
1
+ import { SymbolsType } from '../../../sdk';
2
+ export declare const shoeSymbols = "shoeSymbols";
3
+ export type ShoesGeneratorResponse = SymbolsType;
@@ -0,0 +1,25 @@
1
+ import { CommonComponentProps, CustomMaterialProps } from '../../../common/types';
2
+ /**
3
+ * TubeTrajectory props
4
+ * @expand
5
+ */
6
+ export type TubeTrajectoryProps = CommonComponentProps & CustomMaterialProps & {
7
+ radius?: number;
8
+ color?: string;
9
+ radialSegments?: number;
10
+ priority?: number;
11
+ };
12
+ /**
13
+ * Renders a trajectory as a tube geometry.
14
+ *
15
+ * @example
16
+ * <Wellbore id={wellboreId}>
17
+ * <TubeTrajectory radius={2} color="cyan" radialSegments={36} />
18
+ * </Wellbore>
19
+ *
20
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-tubetrajectory--docs)
21
+ * @see {@link Wellbore}
22
+ *
23
+ * @group Components
24
+ */
25
+ export declare const TubeTrajectory: ({ name, userData, position, castShadow, receiveShadow, layers, renderOrder, visible, customDepthMaterial, customDistanceMaterial, customMaterial, onMaterialPropertiesChange, color, radius, radialSegments, priority, }: TubeTrajectoryProps) => import("react/jsx-runtime").JSX.Element | null;
@@ -0,0 +1,2 @@
1
+ export * from './TubeTrajectory';
2
+ export * from './tube-geometry-defs';
@@ -0,0 +1,3 @@
1
+ import { PackedBufferGeometry } from '../../../sdk';
2
+ export declare const tubeTrajectory = "tubeTrajectory";
3
+ export type tubeTrajectoryGeneratorResponse = PackedBufferGeometry;
@@ -0,0 +1,45 @@
1
+ import { ReactNode } from 'react';
2
+ import { PointerEvents } from '../../../events/interaction-events';
3
+ import { Vec3 } from '../../../sdk/types/common';
4
+ /**
5
+ * Wellbore props
6
+ * @expand
7
+ */
8
+ export type WellboreProps = {
9
+ id: string;
10
+ fromMsl?: number;
11
+ segmentsPerMeter?: number;
12
+ simplificationThreshold?: number;
13
+ position?: Vec3;
14
+ visible?: boolean;
15
+ emitterThreshold?: number;
16
+ children?: ReactNode;
17
+ } & PointerEvents;
18
+ /**
19
+ * The `Wellbore` component serves as a provider/container component only. It does not visualize anything alone!
20
+ * Visualization components, such as the `BasicTrajectory`, `TubeTrajectory`, `Casings`, `CompletionTools` etc. must be
21
+ * added as child components, which will get the data needed from the `WellboreContext` provided this component.
22
+ *
23
+ * @example
24
+ * <Wellbore id={wellboreId}>
25
+ * <BasicTrajectory color="red" />
26
+ * </Wellbore>
27
+ *
28
+ * @see {@link WellboreContext}
29
+ * @see {@link BasicTrajectory}
30
+ * @see {@link TubeTrajectory}
31
+ * @see {@link Casings}
32
+ * @see {@link CasingAnnotations}
33
+ * @see {@link CompletionTools}
34
+ * @see {@link CompletionAnnotations}
35
+ * @see {@link DepthMarkers}
36
+ * @see {@link Perforations}
37
+ * @see {@link Perimeter}
38
+ * @see {@link FormationMarkers}
39
+ * @see {@link Shoes}
40
+ * @see {@link WellboreBounds}
41
+ * @see {@link WellboreLabel}
42
+ *
43
+ * @group Components
44
+ */
45
+ export declare const Wellbore: ({ id, fromMsl, segmentsPerMeter, simplificationThreshold, position, visible, onPointerClick, onPointerEnter, onPointerLeave, onPointerMove, emitterThreshold, children, }: WellboreProps) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,19 @@
1
+ /**
2
+ * WellboreContext props
3
+ * @expand
4
+ */
5
+ export type WellboreContextProps = {
6
+ id: string;
7
+ fromMsl?: number;
8
+ segmentsPerMeter: number;
9
+ simplificationThreshold: number;
10
+ };
11
+ /**
12
+ * Wellbore context
13
+ *
14
+ * @see {@link Wellbore}
15
+ * @see {@link useWellboreContext}
16
+ *
17
+ * @group Contexts
18
+ */
19
+ export declare const WellboreContext: import('react').Context<WellboreContextProps>;
@@ -0,0 +1,2 @@
1
+ export * from './Wellbore';
2
+ export * from './WellboreContext';
@@ -0,0 +1,47 @@
1
+ import { ReactNode } from 'react';
2
+ import { Vec3 } from '../../../sdk/types/common';
3
+ /**
4
+ * WellboreBounds props
5
+ * @expand
6
+ */
7
+ export type WellboreBoundsProps = {
8
+ id: string;
9
+ fromMsl?: number;
10
+ boundsSampleSize?: number;
11
+ visible?: boolean;
12
+ priority?: number;
13
+ children?: ReactNode;
14
+ };
15
+ export type WellboreBoundingSphere = {
16
+ center: Vec3;
17
+ radius: number;
18
+ };
19
+ export type WellboreBoundsType = {
20
+ main: WellboreBoundingSphere;
21
+ sampled: WellboreBoundingSphere[];
22
+ };
23
+ /**
24
+ * This component is used to provide a `DistanceContext` for a `Wellbore`, which allow the use
25
+ * of the `Distance` component to conditionally show/hide other components depending on the distance from the
26
+ * wellbore to the camera.
27
+ *
28
+ * @example
29
+ * <Wellbore id={wellboreId}>
30
+ * <WellboreBounds id={wellboreId}>
31
+ * <BasicTrajectory />
32
+ * <Distance min={0} max={2000}>
33
+ * <TubeTrajectory />
34
+ * </Distance>
35
+ * </WellboreBounds>
36
+ * </Wellbore>
37
+ *
38
+ * @remarks
39
+ * This component does not use the `WellboreContext` to retrieve the wellbore id, and must be provided as a prop.
40
+ *
41
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-wellborebounds--docs)
42
+ * @see {@link Distance}
43
+ * @see {@link DistanceContext}
44
+ *
45
+ * @group Components
46
+ */
47
+ export declare const WellboreBounds: ({ id, fromMsl, boundsSampleSize, visible, priority, children, }: WellboreBoundsProps) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,2 @@
1
+ export * from './WellboreBounds';
2
+ export * from './wellbore-bounds-defs';
@@ -0,0 +1 @@
1
+ export declare const wellboreBounds = "wellboreBounds";
@@ -0,0 +1,30 @@
1
+ import { CommonComponentProps } from '../../../main';
2
+ /**
3
+ * WellboreFormationColumn props
4
+ * @expand
5
+ */
6
+ export type WellboreFormationColumnProps = CommonComponentProps & {
7
+ stratColumnId: string;
8
+ units?: string[];
9
+ unitTypes?: string[];
10
+ inverted?: boolean;
11
+ opacity?: number;
12
+ radialSegments?: number;
13
+ startRadius?: number;
14
+ formationWidth?: number;
15
+ priority?: number;
16
+ };
17
+ /**
18
+ * Renders colored tube geometeries for visualizing formations for a specific strat column.
19
+ *
20
+ * @example
21
+ * <Wellbore id={wellboreId}>
22
+ * <WellboreFormationColumn stratColumnId="abcde" />
23
+ * </Wellbore>
24
+ *
25
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-wellboreformationcolumn--docs)
26
+ * @see {@link Wellbore}
27
+ *
28
+ * @group Components
29
+ */
30
+ export declare const WellboreFormationColumn: ({ name, userData, position, opacity, castShadow, receiveShadow, renderOrder, layers, visible, stratColumnId, units, unitTypes, inverted, radialSegments, startRadius, formationWidth, priority, }: WellboreFormationColumnProps) => import("react/jsx-runtime").JSX.Element | null;
@@ -0,0 +1,2 @@
1
+ export * from './wellbore-formation-column-defs';
2
+ export * from './WellboreFormationColumn';
@@ -0,0 +1,3 @@
1
+ import { PackedBufferGeometry } from '../../../sdk';
2
+ export declare const wellboreFormationColumn = "wellboreFormationColumn";
3
+ export type WellboreFormationColumnResponse = PackedBufferGeometry;
@@ -0,0 +1,10 @@
1
+ import { AnnotationComponentProps } from '../../Annotations/types';
2
+ /**
3
+ * Annotation label component used for `WellboreLabel`
4
+ *
5
+ * @see {@link WellboreLabel}
6
+ * @see {@link Annotations}
7
+ *
8
+ * @group Components
9
+ */
10
+ export declare const WellboreAnnotationLabel: ({ id, name, data, }: AnnotationComponentProps) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,25 @@
1
+ import { Color } from 'three';
2
+ /**
3
+ * WellboreLabel props
4
+ * @expand
5
+ */
6
+ export type WellboreLabelProps = {
7
+ color?: number | string | Color;
8
+ size?: number;
9
+ position?: 'top' | 'center' | 'bottom';
10
+ priority?: number;
11
+ };
12
+ /**
13
+ * Displays a wellbore label as an annotation at the bottom, top or middle of a wellbore trajectory.
14
+ *
15
+ * @example
16
+ * <Wellbore id={wellbore.id}>
17
+ * <WellboreLabel position="bottom" />
18
+ * </Wellbore>
19
+ *
20
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-wellborelabel--docs)
21
+ * @see {@link Wellbore}
22
+ * @see {@link Annotations}
23
+ * @group Components
24
+ */
25
+ export declare const WellboreLabel: ({ size, color, position, priority, }: WellboreLabelProps) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,3 @@
1
+ export * from './WellboreAnnotationLabel';
2
+ export * from './WellboreLabel';
3
+ export * from './wellbore-label-defs';
@@ -0,0 +1 @@
1
+ export declare const wellboreLabel = "wellboreLabel";
@@ -0,0 +1,22 @@
1
+ import { PropsWithChildren } from 'react';
2
+ /**
3
+ * The WellboreRibbon component serves as a controller for ribbon stripe components. It provides a context for
4
+ * child components, including geometry needed to create stripe components.
5
+ *
6
+ * @example
7
+ * <WellboreRibbon>
8
+ * <MeasuredDepthStripe ... />
9
+ * <FormationsStripe ... />
10
+ * </WellboreRibbon>
11
+ *
12
+ * @remarks
13
+ * This is an experimental component and may be changed/removed
14
+ *
15
+ * @see [Storybook](/videx-3d/?path=/docs/components-wellbores-wellboreformationcolumn--docs)
16
+ * @see {@link WellboreRibbonContext}
17
+ * @see {@link FormationsStripe}
18
+ * @see {@link MeasuredDepthStripe}
19
+ *
20
+ * @group Components
21
+ */
22
+ export declare const WellboreRibbon: ({ children }: PropsWithChildren) => import("react/jsx-runtime").JSX.Element | null;