https://github.com/vimaec/vim-webgl-component
Vim React component based on vim-webgl-viewer
https://github.com/vimaec/vim-webgl-component
Last synced: about 1 year ago
JSON representation
Vim React component based on vim-webgl-viewer
- Host: GitHub
- URL: https://github.com/vimaec/vim-webgl-component
- Owner: vimaec
- License: mit
- Archived: true
- Created: 2022-06-07T18:21:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T19:32:56.000Z (over 1 year ago)
- Last Synced: 2025-03-17T05:38:44.014Z (about 1 year ago)
- Language: TypeScript
- Size: 33.7 MB
- Stars: 2
- Watchers: 2
- Forks: 4
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
# Vim Webgl Component
# Documentation
[API Documentation](https://vimaec.github.io/vim-webgl-component/api/)
# Live Demo
## Web
- [Small Model Demo - Residence](https://vimaec.github.io/vim-webgl-app/release?vim=https://vim02.azureedge.net/samples/residence.v1.2.75.vim)
- [Medium Model Demo - Medical Tower](https://vimaec.github.io/vim-webgl-app/release?vim=https://vim02.azureedge.net/samples/skanska.vim)
- [Large Model Demo - Stadium](https://vimaec.github.io/vim-webgl-app/release?vim=https://vim02.azureedge.net/samples/stadium.vim) (_Warning_: slow download times)
## JSFiddle
- [JsFiddle - Hello World](https://jsfiddle.net/simon_vimaec/2khmqy9v/)
- [JsFiddle - Simple](https://jsfiddle.net/simon_vimaec/kmc7Lftw/)
- [JsFiddle - Isolation](https://jsfiddle.net/simon_vimaec/72xbfa4p/)
- [JsFiddle - Message](https://jsfiddle.net/simon_vimaec/bh17u03t/)
- [JsFiddle - Custom Inputs](https://jsfiddle.net/simon_vimaec/k0w4erjn/)
- [JsFiddle - Custom Context Menu](https://jsfiddle.net/simon_vimaec/7marsfwj/)
- [JsFiddle - Custom Camera](https://jsfiddle.net/simon_vimaec/2x0noetj/)
- [JsFiddle - Custom Loading](https://jsfiddle.net/simon_vimaec/3g2epmf1/)
- [JsFiddle - Embedding](https://jsfiddle.net/simon_vimaec/8y321skn/)
- [JsFiddle - Custom Bim Info](https://jsfiddle.net/simon_vimaec/abzg9jcL/)
# Overview
The VIM Webgl Component is a React ui implementation for the [Vim WebGL Viewer]([https://jsfiddle.net/simon_vimaec/2khmqy9v/](https://github.com/vimaec/vim-webgl-viewer)).
## Intents
- Provide a smooth online user experience while browsing complex bim data.
- Test and demonstrate the capabilities of the underlying vim-webgl-viewer.
- Be easy to use, extend and customize for other developpers.
## VIM
The VIM file format is a high-performance 3D scene format that supports rich BIM data, and can be easily extended to support other relational or non-relation data sets.
Unlike IFC the VIM format is already tessellated, and ready to render. This results in very fast load times. Unlike glTF the VIM format is faster to load, scales better, and has a consistent structure for relational BIM data.
More information on the vim format can be found here: https://github.com/vimaec/vim
### Built With
- [VIM Webgl Viewer](https://github.com/vimaec/vim-webgl-viewer)
- [react.js](https://reactjs.org/)
## Getting Started
1. Clone the project.
2. Open the project in VS Code.
3. Install packages by running npm install.
4. Run the dev command to start a live test server.
Make sure you have a recent version of NodeJS installed as Vite requires it.
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
- Simon Roberge - simon.roberge@vimaec.com
- Martin Ashton - martin.ashton@vimaec.com
## Acknowledgments
Thanks to these great packages and more:
- [react-complex-tree](https://github.com/lukasbach/react-complex-tree)
- [re-resizable](https://github.com/bokuweb/re-resizable)
- [react-tooltip](https://github.com/ReactTooltip/react-tooltip)
- [strongly typed events](https://github.com/KeesCBakker/Strongly-Typed-Events-for-TypeScript#readme)