npm - @yschindel/ara3d-webgl - Versions diffs - 1.3.9 → 1.3.11 - Mend

@yschindel/ara3d-webgl 1.3.9 → 1.3.11

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 (18) hide show

package/LICENSE +23 -23
package/README.md +111 -108
package/dist/ara3d-webgl.mjs +8331 -8333
package/dist/ara3d-webgl.mjs.map +1 -1
package/dist/ara3d-webgl.umd.js +151 -151
package/dist/ara3d-webgl.umd.js.map +1 -1
package/dist/types/loader/bimData.d.ts +25 -0
package/dist/types/loader/bimEntities.d.ts +9 -0
package/dist/types/loader/bimOpenSchemaLoader.d.ts +3 -4
package/dist/types/loader/bimQuery.d.ts +11 -0
package/dist/types/loader/bimResolver.d.ts +27 -0
package/dist/types/loader/buildGeometryGroup.d.ts +13 -11
package/dist/types/loader/buildInstances.d.ts +13 -0
package/dist/types/viewer/environment.d.ts +1 -3
package/dist/types/viewer/rendering/renderer.d.ts +2 -3
package/dist/types/viewer/viewer.d.ts +1 -0
package/dist/types/viewer/viewerSettings.d.ts +1 -49
package/package.json +74 -74

package/LICENSE CHANGED Viewed

@@ -1,23 +1,23 @@
-MIT License
-Copyright (c) 2025 Ara 3D Inc.
-Copyright (c) 2021 VIMaec LLC.
-Copyright (c) 2018 Ara 3D Inc.
-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:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-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.
+MIT License
+Copyright (c) 2025 Ara 3D Inc.
+Copyright (c) 2021 VIMaec LLC.
+Copyright (c) 2018 Ara 3D Inc.
+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:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+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 CHANGED Viewed

@@ -1,108 +1,111 @@
-# Ara 3D WebGL - BIM Open Schema Viewer
-## [Live Demo](https://ara3d.github.io/ara3d-webgl/)
-<img
-  src="https://github.com/user-attachments/assets/99407018-c5d2-46b2-b602-7e4671c87860"
-  alt="BIM Open Schema Viewer"
-  width="200"
-  height="157"
-  align="right"
-/>
-A **WebGL viewer** for extremely large 3D models of buildings and infrastructure
-represented as [BIM Open Schema .BOS files](https://github.com/ara3d/bim-open-schema).
-BIM Open Schema is an ultra-compressed and portable BIM data format, which
-is easily extended, built on top [Parquet](https://parquet.apache.org/) format.
-A .BOS file is a ZIP archive that contains multiple Parquet files, which contain
-geometry, parameters, and other BIM data.
-## Building and Running
-The project uses [vite](https://vite.dev/) for bundling and development.
-Some of the common tasks, which can be found in the `package.json`.
-- `npm run dev` - Running the vite dev server with "hot reloading"
-- `npm run build:docs` - Building the examples and API documentation.
-- `npm run serve:docs` - Testing the built examples and API documentation locally
-- `npm run build:lib` - Building the library as a JavaScript module (`.mjs`) file
-## Camera Controls
-### Keyboard
-- `W`, `Up` - Move camera forward
-- `A`, `Left` - Move camera to the left
-- `S`, `Down` - Move camera backward
-- `D`, `Right` - Move camera to the right
-- `E` -  Move camera up
-- `Q` - Move camera down
-- `Shift` - faster camera movement while pressed
-- `+` - Increase camera speed
-- `-` - Decrease camera speed
-- `Space` - Toggle orbit mode
-- `Home` - Frame model
-- `Escape` - Clear selection
-- `F` Frame selection
-### Mouse
-- `Hold left click + Move mouse` - Rotate camera in current mode
-- `Hold right click + Move mouse` - Pan/tilt camera
-- `Hold middle click + Move mouse` - Truck/pedestal camera
-- `Mouse wheel` - Dolly Camera
-- `Left click` - Select object
-- `Ctrl + Mouse wheel` - Increase/decrease camera speed
-### Touch
-- `One Finger swipe` - Tilt/Pan camera
-- `Two Finger swipe` - Truck/Pedestal camera
-- `Two Finger pinch/spread` - Dolly Camera
-## History
-At Ara 3D we created a simple 3D web-viewer in March 2019 which had support for multiple file formats.
-The goal was to minimize the amount of code required to create and host a Three.JS viewer in a web-page.
-The VIM team took over the project in July 2021 and the team, mostly Simon Roberge,
-added many features and enhancements. They also customized the project to meet the needs of their Power BI offering.
-On December 17, 2024, the VIM team archived the project, and merged it with their React-based viewer project into a
-new repository https://github.com/vimaec/vim-web. Today the VIM viewer is very powerful, but has become very specialized
-to their use-cases.
-In early 2025 the Ara 3D WebGL project was forked from an earlier snapshot of the repo to revive the spirit of the original viewer,
-while leveraging many of the excellent contributions made by VIM.
-Today in December 2026, we are focusing on using this viewer as a showcase of the [BIM Open Schema](https://github.com/ara3d/bim-open-schema)
-data format.
-## Requesting Features, Improvements, or Changes
-Feel free to log issues or submit pull requests.
-We also offer very affordable custom software development services if you are using this project in a
-commercial context. For more information reach out to us at [info@ara3d.com](mailto:info@ara3d.com).
-# Appendix
-## Related Projects: WebGL Viewers
-* [Autodesk Viewer](https://viewer.autodesk.com/)
-* [Bentley iTwin](https://www.itwinjs.org/)
-* [Babylon.JS](https://www.babylonjs.com/)
-* [Bldrs.AI](https://bldrs.ai/)
-* [Cesium](https://sandcastle.cesium.com/?src=Cesium%20OSM%20Buildings.html)
-* [e-verse GLTF viewer](https://gltfviewer.e-verse.com/)
-* [glTF Sample Viewer](https://github.com/KhronosGroup/glTF-Sample-Viewer)
-* [That Open Engine - Web IFC](https://github.com/ThatOpen/engine_web-ifc)
-* [Revit 3JS](https://github.com/McCulloughRT/Rvt3js)
-* [Speckle](https://github.com/specklesystems/speckle-server)
-* [vA3C](https://va3c.github.io/)
-* [VIMAEC Web](https://github.com/vimaec/vim-web)
-* [XBim Web UI](https://github.com/xBimTeam/XbimWebUI)
-* [Xeokit](https://github.com/xeokit/xeokit-sdk)
+# Ara 3D WebGL - BIM Open Schema Viewer
+## [Live Demo](https://ara3d.github.io/ara3d-webgl/)
+<img
+  src="https://github.com/user-attachments/assets/99407018-c5d2-46b2-b602-7e4671c87860"
+  alt="BIM Open Schema Viewer"
+  width="200"
+  height="157"
+  align="right"
+/>
+A **WebGL viewer** for extremely large 3D models of buildings and infrastructure
+represented as [BIM Open Schema .BOS files](https://github.com/ara3d/bim-open-schema).
+BIM Open Schema is an ultra-compressed and portable BIM data format, which
+is easily extended, built on top [Parquet](https://parquet.apache.org/) format.
+A .BOS file is a ZIP archive that contains multiple Parquet files, which contain
+geometry, parameters, and other BIM data.
+## Show me the code!
+We've tried to keep the code as straightforward and legible as possible:
+- The Three.JS file loader: [`bimOpenSchemaLoader.ts`](https://github.com/ara3d/ara3d-webgl/blob/main/src/loader/bimOpenSchemaLoader.ts)
+- The BIM Geometry type definition: [`bimGeometry.ts`](https://github.com/ara3d/ara3d-webgl/blob/main/src/loader/bimGeometry.ts)
+- The conversion to Three.JS geometry: [`buildGeometryGroup.ts`](https://github.com/ara3d/ara3d-webgl/blob/main/src/loader/buildGeometryGroup.ts)
+## Building and Running
+The project uses [vite](https://vite.dev/) for bundling and development.
+Some of the common tasks, which can be found in the `package.json`.
+- `npm run dev` - Running the vite dev server with "hot reloading"
+- `npm run build:docs` - Building the examples and API documentation.
+- `npm run serve:docs` - Testing the built examples and API documentation locally
+- `npm run build:lib` - Building the library as a JavaScript module (`.mjs`) file
+## Camera Controls
+### Keyboard
+- `W`, `Up` - Move camera forward
+- `A`, `Left` - Move camera to the left
+- `S`, `Down` - Move camera backward
+- `D`, `Right` - Move camera to the right
+- `E` -  Move camera up
+- `Q` - Move camera down
+- `Shift` - faster camera movement while pressed
+- `+` - Increase camera speed
+- `-` - Decrease camera speed
+### Mouse
+- `Hold left click + Move mouse` - Rotate camera in current mode
+- `Hold right click + Move mouse` - Pan/tilt camera
+- `Hold middle click + Move mouse` - Truck/pedestal camera
+- `Mouse wheel` - Dolly Camera
+- `Left click` - Select object
+- `Ctrl + Mouse wheel` - Increase/decrease camera speed
+### Touch
+- `One Finger swipe` - Tilt/Pan camera
+- `Two Finger swipe` - Truck/Pedestal camera
+- `Two Finger pinch/spread` - Dolly Camera
+## History
+At Ara 3D we created a simple 3D web-viewer in March 2019 which had support for multiple file formats.
+The goal was to minimize the amount of code required to create and host a Three.JS viewer in a web-page.
+The VIM team took over the project in July 2021 and the team, mostly Simon Roberge,
+added many features and enhancements. They also customized the project to meet the needs of their Power BI offering.
+On December 17, 2024, the VIM team archived the project, and merged it with their React-based viewer project into a
+new repository https://github.com/vimaec/vim-web. Today the VIM viewer is very powerful, but has become very specialized
+to their use-cases.
+In early 2025 the Ara 3D WebGL project was forked from an earlier snapshot of the repo to revive the spirit of the original viewer,
+while leveraging many of the excellent contributions made by VIM.
+Today in December 2026, we are focusing on using this viewer as a showcase of the [BIM Open Schema](https://github.com/ara3d/bim-open-schema)
+data format.
+## Requesting Features, Improvements, or Changes
+Feel free to log issues or submit pull requests.
+We also offer very affordable custom software development services if you are using this project in a
+commercial context. For more information reach out to us at [info@ara3d.com](mailto:info@ara3d.com).
+# Appendix
+## Related Projects: WebGL Viewers
+* [Autodesk Viewer](https://viewer.autodesk.com/)
+* [Bentley iTwin](https://www.itwinjs.org/)
+* [Babylon.JS](https://www.babylonjs.com/)
+* [Bldrs.AI](https://bldrs.ai/)
+* [Cesium](https://sandcastle.cesium.com/?src=Cesium%20OSM%20Buildings.html)
+* [e-verse GLTF viewer](https://gltfviewer.e-verse.com/)
+* [glTF Sample Viewer](https://github.com/KhronosGroup/glTF-Sample-Viewer)
+* [That Open Engine - Web IFC](https://github.com/ThatOpen/engine_web-ifc)
+* [Revit 3JS](https://github.com/McCulloughRT/Rvt3js)
+* [Speckle](https://github.com/specklesystems/speckle-server)
+* [vA3C](https://va3c.github.io/)
+* [VIMAEC Web](https://github.com/vimaec/vim-web)
+* [XBim Web UI](https://github.com/xBimTeam/XbimWebUI)
+* [Xeokit](https://github.com/xeokit/xeokit-sdk)