Merge pull request #77 from pattern-x/feature/readme

Update readme
This commit is contained in:
pattern-x
2023-04-05 17:44:12 +08:00
committed by GitHub

View File

@ -16,11 +16,11 @@ http://localhost:3000/
# gemini-viewer
gemini-viewer is a WebGL based JS SDK, it is built on top of three.js. It provides following viewers:
#### 1. BimViewer
Used to view 3d BIM models. It supports formats including gltf, obj, fbx, ifc, dae, etc. Its features including measurement, section, display outline, orthographic camera, selection, etc.
#### 1. DxfViewer
Used to view 2d drawings. Dxf format is supported, so we need to convert dwg files to dxf first (there is a dwg2dxf.exe worker). It supports most common entity types, it supports OLE and region via dwg2dxf; It supports common line types; It supports common hatch styles; It support line width;
#### 2. DxfViewer
Used to view 2d drawings. Only dxf format is supported, so user needs to convert dwg files to dxf. It supports most common entity types, it supports OLE and region via dwg2dxf; It supports common line types; It supports common hatch styles; It doesn't support line width;
#### 2. BimViewer
Used to view 3d BIM models. It supports formats including gltf, obj, fbx, ifc, dae, etc. Its features including measurement, section, display outline, orthographic camera, selection, etc.
#### 3. VRViewer
Used to view panoramas. It supports viewing a panorama with 1 image, 6 images, or 24 images; It supports viewing a serials of panoramas; It supports hotpoints;
@ -47,6 +47,7 @@ const modelCfg: ModelConfig = {
src: "http://www.abc.com/sample.dxf",
}
const fontFiles = ["http://www.abc.com/hztxt.shx", "http://www.abc.com/simplex.shx"];
const viewer = new DxfViewer(viewerCfg);
await viewer.setFont(fontFiles);
await viewer.loadModelAsync(modelCfg, (event) => {
@ -57,20 +58,6 @@ console.log("Loaded");
viewer.goToHomeView();
```
## Features for BimViewer
- Load and view BIM model
![load_and_view.gif](public/demo/images/snapshots/bim_view_model.png)
- Orthographic view
![bim_ortho_camera.png](public/demo/images/snapshots/bim_ortho_camera.png)
- Selection
![bim_selection.gif](public/demo/images/snapshots/bim_selection.gif)
- X-Ray
![bim_xray.gif](public/demo/images/snapshots/bim_xray.gif)
- Distance measurement
![bim_dist_measure.gif](public/demo/images/snapshots/bim_dist_measure.gif)
- Section
![bim_section_plane.png](public/demo/images/snapshots/bim_section_plane.png)
## Features for DxfViewer
- Load and view dxf file
![load_and_view.gif](public/demo/images/snapshots/load_and_view.gif)
@ -91,3 +78,17 @@ viewer.goToHomeView();
![physical_structure.png](public/demo/images/physical_structure.png)
- Logical structure diagram:
![logical_structure.png](public/demo/images/logical_structure.png)
## Features for BimViewer
- Load and view BIM model
![load_and_view.gif](public/demo/images/snapshots/bim_view_model.png)
- Orthographic view
![bim_ortho_camera.png](public/demo/images/snapshots/bim_ortho_camera.png)
- Selection
![bim_selection.gif](public/demo/images/snapshots/bim_selection.gif)
- X-Ray
![bim_xray.gif](public/demo/images/snapshots/bim_xray.gif)
- Distance measurement
![bim_dist_measure.gif](public/demo/images/snapshots/bim_dist_measure.gif)
- Section
![bim_section_plane.png](public/demo/images/snapshots/bim_section_plane.png)