@giro3d/piero 25.10.0-beta.10

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 (245) hide show
  1. package/LICENSE +9 -0
  2. package/README.md +134 -0
  3. package/dist/Components.cjs.js +2605 -0
  4. package/dist/Components.es.js +43490 -0
  5. package/dist/assets/ParserWorker-Bd30oD5I.js +5 -0
  6. package/dist/assets/style.css +9 -0
  7. package/dist/basedecoder.cjs.js +1 -0
  8. package/dist/basedecoder.es.js +88 -0
  9. package/dist/decoder.cjs.js +1 -0
  10. package/dist/decoder.es.js +9 -0
  11. package/dist/deflate.cjs.js +1 -0
  12. package/dist/deflate.es.js +10 -0
  13. package/dist/index.cjs.js +93 -0
  14. package/dist/index.d.ts +2 -0
  15. package/dist/index.es.js +65240 -0
  16. package/dist/jpeg.cjs.js +1 -0
  17. package/dist/jpeg.es.js +514 -0
  18. package/dist/lerc.cjs.js +1 -0
  19. package/dist/lerc.es.js +1027 -0
  20. package/dist/lzw.cjs.js +1 -0
  21. package/dist/lzw.es.js +84 -0
  22. package/dist/modules.cjs.js +2973 -0
  23. package/dist/modules.d.ts +2 -0
  24. package/dist/modules.es.js +87571 -0
  25. package/dist/packbits.cjs.js +1 -0
  26. package/dist/packbits.es.js +24 -0
  27. package/dist/pako.esm.cjs.js +1 -0
  28. package/dist/pako.esm.es.js +1053 -0
  29. package/dist/piero_logo.png +0 -0
  30. package/dist/piero_logo_compact.png +0 -0
  31. package/dist/raw.cjs.js +1 -0
  32. package/dist/raw.es.js +9 -0
  33. package/dist/sponsors/bpi_france.png +0 -0
  34. package/dist/sponsors/france_2030.png +0 -0
  35. package/dist/sponsors/france_relance.png +0 -0
  36. package/dist/sponsors/oslandia.png +0 -0
  37. package/dist/sponsors/ue_next_generation.png +0 -0
  38. package/dist/src/App.vue.d.ts +6 -0
  39. package/dist/src/api/BookmarkApi.d.ts +6 -0
  40. package/dist/src/api/DatasetApi.d.ts +61 -0
  41. package/dist/src/api/ViewApi.d.ts +4 -0
  42. package/dist/src/api/index.d.ts +4 -0
  43. package/dist/src/components/AlertToast.vue.d.ts +4 -0
  44. package/dist/src/components/AttributeGroup.vue.d.ts +7 -0
  45. package/dist/src/components/AttributeItem.vue.d.ts +6 -0
  46. package/dist/src/components/AttributePanel.vue.d.ts +14 -0
  47. package/dist/src/components/ColorFragment.vue.d.ts +6 -0
  48. package/dist/src/components/Configuration.d.ts +14 -0
  49. package/dist/src/components/CoordinateFragment.vue.d.ts +10 -0
  50. package/dist/src/components/DropdownView.vue.d.ts +13 -0
  51. package/dist/src/components/LinkFragment.vue.d.ts +10 -0
  52. package/dist/src/components/LoadingScreen.vue.d.ts +2 -0
  53. package/dist/src/components/MainView.vue.d.ts +5 -0
  54. package/dist/src/components/MinimapView.vue.d.ts +4 -0
  55. package/dist/src/components/ModalOverlay.vue.d.ts +17 -0
  56. package/dist/src/components/NavigationButtons.vue.d.ts +2 -0
  57. package/dist/src/components/OpacitySlider.vue.d.ts +10 -0
  58. package/dist/src/components/PanelContainer.vue.d.ts +10 -0
  59. package/dist/src/components/ProgressBar.vue.d.ts +14 -0
  60. package/dist/src/components/SearchOverlay.vue.d.ts +8 -0
  61. package/dist/src/components/SpinnerControl.vue.d.ts +2 -0
  62. package/dist/src/components/StatusBar.vue.d.ts +10 -0
  63. package/dist/src/components/SwitchToggle.vue.d.ts +17 -0
  64. package/dist/src/components/VisibilityControl.vue.d.ts +9 -0
  65. package/dist/src/components/atoms/ButtonArea.vue.d.ts +9 -0
  66. package/dist/src/components/atoms/ButtonWithIcon.vue.d.ts +11 -0
  67. package/dist/src/components/atoms/CompactList.vue.d.ts +9 -0
  68. package/dist/src/components/atoms/Icon.vue.d.ts +6 -0
  69. package/dist/src/components/atoms/IconList.vue.d.ts +9 -0
  70. package/dist/src/components/atoms/IconListButton.vue.d.ts +10 -0
  71. package/dist/src/components/atoms/ImportButton.vue.d.ts +13 -0
  72. package/dist/src/components/atoms/ListLabel.vue.d.ts +5 -0
  73. package/dist/src/components/atoms/ListLabelButton.vue.d.ts +11 -0
  74. package/dist/src/components/atoms/SectionCollapsible.vue.d.ts +20 -0
  75. package/dist/src/components/charts/BarChart.vue.d.ts +4 -0
  76. package/dist/src/components/charts/DoughnutChart.vue.d.ts +4 -0
  77. package/dist/src/components/panels/AboutPanel.vue.d.ts +2 -0
  78. package/dist/src/components/panels/AnalysisPanel.vue.d.ts +2 -0
  79. package/dist/src/components/panels/AnnotationItem.vue.d.ts +21 -0
  80. package/dist/src/components/panels/AnnotationPanel.vue.d.ts +2 -0
  81. package/dist/src/components/panels/BasemapItem.vue.d.ts +17 -0
  82. package/dist/src/components/panels/BookmarkItem.vue.d.ts +16 -0
  83. package/dist/src/components/panels/BookmarkPanel.vue.d.ts +2 -0
  84. package/dist/src/components/panels/DatagroupItem.vue.d.ts +18 -0
  85. package/dist/src/components/panels/DatasetItem.vue.d.ts +18 -0
  86. package/dist/src/components/panels/DatasetOrGroupItem.vue.d.ts +18 -0
  87. package/dist/src/components/panels/DatasetPanel.vue.d.ts +2 -0
  88. package/dist/src/components/panels/EmptyIndicator.vue.d.ts +6 -0
  89. package/dist/src/components/panels/LoadingIndicator.vue.d.ts +6 -0
  90. package/dist/src/components/panels/MeasurementItem.vue.d.ts +17 -0
  91. package/dist/src/components/panels/MeasurementPanel.vue.d.ts +2 -0
  92. package/dist/src/components/panels/OverlayItem.vue.d.ts +19 -0
  93. package/dist/src/components/panels/ShareBookmarkModal.vue.d.ts +5 -0
  94. package/dist/src/components/panels/analysis/ClippingBox.vue.d.ts +2 -0
  95. package/dist/src/components/panels/analysis/CrossSection.vue.d.ts +2 -0
  96. package/dist/src/components/panels/analysis/FloodingPlane.vue.d.ts +2 -0
  97. package/dist/src/components/panels/analysis/Statistics.vue.d.ts +2 -0
  98. package/dist/src/components/panels/analysis/ToolWrapper.vue.d.ts +20 -0
  99. package/dist/src/components/toolbar/ToolBar.vue.d.ts +9 -0
  100. package/dist/src/components/toolbar/ToolbarButton.vue.d.ts +12 -0
  101. package/dist/src/config-loader.d.ts +7 -0
  102. package/dist/src/constants.d.ts +7 -0
  103. package/dist/src/context.d.ts +35 -0
  104. package/dist/src/createPieroApp.d.ts +31 -0
  105. package/dist/src/events.d.ts +30 -0
  106. package/dist/src/giro3d/CameraControlsInspector.d.ts +17 -0
  107. package/dist/src/giro3d/EntityBuilder.d.ts +21 -0
  108. package/dist/src/giro3d/Graticule.d.ts +20 -0
  109. package/dist/src/giro3d/Grid.d.ts +11 -0
  110. package/dist/src/giro3d/LayerBuilder.d.ts +46 -0
  111. package/dist/src/giro3d/Measure3D.d.ts +19 -0
  112. package/dist/src/giro3d/Plane.d.ts +11 -0
  113. package/dist/src/giro3d/Skybox.d.ts +6 -0
  114. package/dist/src/giro3d/entities/FeatureCollectionEntity.d.ts +41 -0
  115. package/dist/src/giro3d/entities/PointCloudEntity.d.ts +45 -0
  116. package/dist/src/giro3d/entities/TiledPointCloudEntity.d.ts +13 -0
  117. package/dist/src/giro3d/entities/Tiles3dEntity.d.ts +11 -0
  118. package/dist/src/giro3d/entities/VectorLabelsEntity.d.ts +48 -0
  119. package/dist/src/giro3d/entities/VectorMeshEntity.d.ts +97 -0
  120. package/dist/src/giro3d/entities/VectorShapeEntity.d.ts +8 -0
  121. package/dist/src/giro3d/entities/flatPointCloud.d.ts +2 -0
  122. package/dist/src/giro3d/entities/tiledIfc.d.ts +2 -0
  123. package/dist/src/giro3d/entities/vector.d.ts +2 -0
  124. package/dist/src/giro3d/sources/GeopackageSource.d.ts +20 -0
  125. package/dist/src/giro3d/sources/ShapefileSource.d.ts +20 -0
  126. package/dist/src/giro3d/sources/mixins.d.ts +60 -0
  127. package/dist/src/index.d.ts +17 -0
  128. package/dist/src/loaders/csv.d.ts +3 -0
  129. package/dist/src/loaders/las.d.ts +3 -0
  130. package/dist/src/loaders/loader.d.ts +29 -0
  131. package/dist/src/loaders/loader.test.d.ts +1 -0
  132. package/dist/src/loaders/userData.d.ts +8 -0
  133. package/dist/src/loaders/vector.d.ts +4 -0
  134. package/dist/src/module.d.ts +11 -0
  135. package/dist/src/modules/CityJSONLoader.d.ts +10 -0
  136. package/dist/src/modules/IFCLoader.d.ts +9 -0
  137. package/dist/src/modules/PLYLoader.d.ts +9 -0
  138. package/dist/src/modules/PotreeLoader.d.ts +9 -0
  139. package/dist/src/modules/Tour.d.ts +17 -0
  140. package/dist/src/modules/cityjson/CityJSONEntity.d.ts +79 -0
  141. package/dist/src/modules/cityjson/CityJSONEntityInspector.d.ts +8 -0
  142. package/dist/src/modules/ifc/IfcEntity.d.ts +87 -0
  143. package/dist/src/modules/ifc/IfcEntityInspector.d.ts +7 -0
  144. package/dist/src/modules/ifc/IfcPropertyView.vue.d.ts +6 -0
  145. package/dist/src/modules/ifc/IfcSubtree.vue.d.ts +7 -0
  146. package/dist/src/modules/index.d.ts +6 -0
  147. package/dist/src/modules/ply/PlyEntity.d.ts +33 -0
  148. package/dist/src/providers/Alticoding.d.ts +32 -0
  149. package/dist/src/providers/BanProvider.d.ts +11 -0
  150. package/dist/src/providers/Geocoding.d.ts +7 -0
  151. package/dist/src/providers/IgnProvider.d.ts +11 -0
  152. package/dist/src/services/AnalysisManager.d.ts +10 -0
  153. package/dist/src/services/AnnotationManager.d.ts +48 -0
  154. package/dist/src/services/CameraController.d.ts +99 -0
  155. package/dist/src/services/DatasetManager.d.ts +27 -0
  156. package/dist/src/services/Giro3DManager.d.ts +42 -0
  157. package/dist/src/services/Highlighter.d.ts +11 -0
  158. package/dist/src/services/LayerManager.d.ts +37 -0
  159. package/dist/src/services/MeasureTool.d.ts +13 -0
  160. package/dist/src/services/MeasurementManager.d.ts +31 -0
  161. package/dist/src/services/MinimapController.d.ts +19 -0
  162. package/dist/src/services/Picker.d.ts +53 -0
  163. package/dist/src/services/analysis/ClippingBoxManager.d.ts +41 -0
  164. package/dist/src/services/analysis/CrossSectionManager.d.ts +9 -0
  165. package/dist/src/services/analysis/FloodingPlaneManager.d.ts +11 -0
  166. package/dist/src/stores/analysis.d.ts +1571 -0
  167. package/dist/src/stores/annotations.d.ts +60 -0
  168. package/dist/src/stores/bookmarks.d.ts +21 -0
  169. package/dist/src/stores/camera.d.ts +287 -0
  170. package/dist/src/stores/datasets.d.ts +49 -0
  171. package/dist/src/stores/giro3d.d.ts +45 -0
  172. package/dist/src/stores/layers.d.ts +40 -0
  173. package/dist/src/stores/measurement.d.ts +45 -0
  174. package/dist/src/stores/modules.d.ts +11 -0
  175. package/dist/src/stores/notifications.d.ts +8 -0
  176. package/dist/src/stores/statistics.d.ts +8 -0
  177. package/dist/src/types/Annotation.d.ts +35 -0
  178. package/dist/src/types/AnnotationMode.d.ts +7 -0
  179. package/dist/src/types/BaseLayer.d.ts +30 -0
  180. package/dist/src/types/Bookmark.d.ts +19 -0
  181. package/dist/src/types/CameraPosition.d.ts +7 -0
  182. package/dist/src/types/Configuration.d.ts +94 -0
  183. package/dist/src/types/Dataset.d.ts +78 -0
  184. package/dist/src/types/Feature.d.ts +13 -0
  185. package/dist/src/types/FloodingPlane.d.ts +14 -0
  186. package/dist/src/types/IFCTypes.d.ts +5 -0
  187. package/dist/src/types/LayerObject.d.ts +20 -0
  188. package/dist/src/types/Measure.d.ts +20 -0
  189. package/dist/src/types/MeasurementMode.d.ts +7 -0
  190. package/dist/src/types/Named.d.ts +5 -0
  191. package/dist/src/types/NavigationMode.d.ts +2 -0
  192. package/dist/src/types/Notification.d.ts +8 -0
  193. package/dist/src/types/OLGeometry.d.ts +1 -0
  194. package/dist/src/types/Overlay.d.ts +24 -0
  195. package/dist/src/types/VectorStyle.d.ts +31 -0
  196. package/dist/src/types/Viewbox.d.ts +7 -0
  197. package/dist/src/types/configuration/analysis.d.ts +26 -0
  198. package/dist/src/types/configuration/bookmark.d.ts +16 -0
  199. package/dist/src/types/configuration/camera.d.ts +19 -0
  200. package/dist/src/types/configuration/color.d.ts +18 -0
  201. package/dist/src/types/configuration/datasets/cityjson.d.ts +9 -0
  202. package/dist/src/types/configuration/datasets/core.d.ts +49 -0
  203. package/dist/src/types/configuration/datasets/featureCollection.d.ts +6 -0
  204. package/dist/src/types/configuration/datasets/ifc.d.ts +10 -0
  205. package/dist/src/types/configuration/datasets/index.d.ts +27 -0
  206. package/dist/src/types/configuration/datasets/layer.d.ts +43 -0
  207. package/dist/src/types/configuration/datasets/ply.d.ts +10 -0
  208. package/dist/src/types/configuration/datasets/pointCloud.d.ts +12 -0
  209. package/dist/src/types/configuration/datasets/potreePointCloud.d.ts +10 -0
  210. package/dist/src/types/configuration/datasets/tiledIfc.d.ts +9 -0
  211. package/dist/src/types/configuration/datasets/tiledPointCloud.d.ts +9 -0
  212. package/dist/src/types/configuration/datasets/vector.d.ts +34 -0
  213. package/dist/src/types/configuration/features.d.ts +2 -0
  214. package/dist/src/types/configuration/geographic.d.ts +51 -0
  215. package/dist/src/types/configuration/layers/core.d.ts +50 -0
  216. package/dist/src/types/configuration/layers/index.d.ts +49 -0
  217. package/dist/src/types/configuration/sources/bingMaps.d.ts +5 -0
  218. package/dist/src/types/configuration/sources/core/baseConfig.d.ts +70 -0
  219. package/dist/src/types/configuration/sources/core/tiled.d.ts +19 -0
  220. package/dist/src/types/configuration/sources/core/vector.d.ts +13 -0
  221. package/dist/src/types/configuration/sources/core/vectorTile.d.ts +8 -0
  222. package/dist/src/types/configuration/sources/customVector.d.ts +7 -0
  223. package/dist/src/types/configuration/sources/customVectorTile.d.ts +8 -0
  224. package/dist/src/types/configuration/sources/geojson.d.ts +5 -0
  225. package/dist/src/types/configuration/sources/geotiff.d.ts +8 -0
  226. package/dist/src/types/configuration/sources/gpx.d.ts +5 -0
  227. package/dist/src/types/configuration/sources/kml.d.ts +5 -0
  228. package/dist/src/types/configuration/sources/mvt.d.ts +10 -0
  229. package/dist/src/types/configuration/sources/osm.d.ts +5 -0
  230. package/dist/src/types/configuration/sources/stadiaMaps.d.ts +5 -0
  231. package/dist/src/types/configuration/sources/wms.d.ts +15 -0
  232. package/dist/src/types/configuration/sources/wmts.d.ts +15 -0
  233. package/dist/src/types/configuration/sources/xyz.d.ts +9 -0
  234. package/dist/src/types/utilities.d.ts +5 -0
  235. package/dist/src/utils/Components.d.ts +8 -0
  236. package/dist/src/utils/Configuration.d.ts +15 -0
  237. package/dist/src/utils/Download.d.ts +11 -0
  238. package/dist/src/utils/Fetcher.d.ts +77 -0
  239. package/dist/src/utils/Measure.d.ts +7 -0
  240. package/dist/src/utils/OLFeatures.d.ts +57 -0
  241. package/dist/src/utils/Projections.d.ts +10 -0
  242. package/dist/src/utils/Types.d.ts +11 -0
  243. package/dist/webimage.cjs.js +1 -0
  244. package/dist/webimage.es.js +19 -0
  245. package/package.json +100 -0
package/LICENSE ADDED
@@ -0,0 +1,9 @@
1
+ MIT License
2
+
3
+ Copyright 2023-2024 Giro3D contributors.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
+
7
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
+
9
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,134 @@
1
+ <div align="center">
2
+ <a href="https://piero.giro3d.org">
3
+ <img src="https://piero.giro3d.org/piero_logo.svg" height="120" alt="Piero">
4
+ </a>
5
+ </div>
6
+
7
+ <div align="center">
8
+ A versatile web library to visualize 3D geospatial data in the browser.
9
+ </div>
10
+
11
+ <br>
12
+
13
+ <div align="center">
14
+ <a href="https://gitlab.com/giro3d/piero/badges/main/pipeline.svg"><img src="https://gitlab.com/giro3d/piero/badges/main/pipeline.svg" alt="Pipeline status"></a>
15
+ <a href="https://www.npmjs.com/package/@giro3d/piero"><img alt="NPMJS latest package badge" src="https://img.shields.io/npm/v/@giro3d/piero?color=blue"></a>
16
+ <a href="https://matrix.to/#/#giro3d:matrix.org"><img src="https://img.shields.io/matrix/giro3d:matrix.org" alt="Matrix chat"></a>
17
+ </div>
18
+
19
+ ## The Piero library
20
+
21
+ This is the library version of the [Piero web application](https://giro3d.org/piero.html). The library version allows you to customize and use your own modules and plugins.
22
+
23
+ ## Getting started
24
+
25
+ This library is built with Vue.js, but you don't need Vue to use the library (unless you want to write your own components).
26
+
27
+ ```shell
28
+ npm install @giro3d/piero
29
+ ```
30
+
31
+ Then create an `index.html` file
32
+
33
+ ```html
34
+ <!doctype html>
35
+ <html lang="en">
36
+ <head>
37
+ <meta charset="UTF-8" />
38
+ <title>My custom Piero app</title>
39
+ </head>
40
+ <body>
41
+ <div id="app"></div>
42
+ <script type="module" src="./index.ts"></script>
43
+ </body>
44
+ </html>
45
+ ```
46
+
47
+ And an `index.ts` file:
48
+
49
+ ```ts
50
+ // index.ts
51
+ import { createPieroApp } from '@giro3d/piero';
52
+ import '@giro3d/piero/piero.css';
53
+
54
+ import configuration from './config';
55
+
56
+ createPieroApp({
57
+ container: '#app',
58
+ baseUrl: 'http://localhost:8080/',
59
+ configuration,
60
+ });
61
+ ```
62
+
63
+ Note that you have to import the CSS file from Piero.
64
+
65
+ Create the `config.ts` file in the same folder as `index.ts`, and fill it with your configuration (you can use the [sample configuration](https://gitlab.com/giro3d/piero/-/blob/main/config.ts.sample) as a starting point).
66
+
67
+ Bundle your application and run it. For example with Vite:
68
+
69
+ ```shell
70
+ vite --port 8080
71
+ ```
72
+
73
+ Then open your browser at <http://localhost:8080>.
74
+
75
+ This is the minimal configuration to use the Piero library.
76
+
77
+ ### Using a remote configuration
78
+
79
+ Alternatively, you can pass a URL to a remote JSON configuration
80
+
81
+ ```ts
82
+ // index.ts
83
+ import { createPieroApp } from '@giro3d/piero';
84
+ import '@giro3d/piero/piero.css';
85
+
86
+ createPieroApp({
87
+ container: '#app',
88
+ baseUrl: 'http://localhost:8080/',
89
+ configuration: 'https://example.com/config.json',
90
+ });
91
+ ```
92
+
93
+ ### Deploying
94
+
95
+ To deploy your app, update the `baseUrl` to be the URL from which the app is served. For example, if you want your app to be accessible from `https://example.com/piero`, the base URL would be (don't forget the slash):
96
+
97
+ ```ts
98
+ // index.ts
99
+ import { createPieroApp } from '@giro3d/piero';
100
+ import '@giro3d/piero/piero.css';
101
+
102
+ createPieroApp({
103
+ container: '#app',
104
+ baseUrl: 'https://example.com/piero/',
105
+ configuration: 'https://example.com/config.json',
106
+ });
107
+ ```
108
+
109
+ ## Register custom modules
110
+
111
+ You can register your own modules (classes that implement the `Module` interface) at startup:
112
+
113
+ ```ts
114
+ // index.ts
115
+ import { createPieroApp, Module, PieroContext } from '@giro3d/piero';
116
+ import '@giro3d/piero/piero.css';
117
+
118
+ class MyCustomModule implements Module {
119
+ name = 'A custom module';
120
+
121
+ initialize(context: PieroContext) {
122
+ console.log('hello, world!');
123
+ }
124
+ }
125
+
126
+ createPieroApp({
127
+ container: '#app',
128
+ baseUrl: 'https://example.com/piero/',
129
+ configuration: 'https://example.com/config.json',
130
+ modules: [new MyCustomModule()],
131
+ });
132
+ ```
133
+
134
+ Refer to [CONFIGURATION.md](https://gitlab.com/giro3d/piero/-/blob/main/CONFIGURATION.md) for more information.