qg3dviewer 1.0.3 → 1.0.4
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.
- package/README.md +0 -93
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,94 +1 @@
|
|
|
1
|
-
<p align=center>
|
|
2
|
-
<img style="width:128px;height:128px" src="https://gotoeasy.github.io/reall3d/logo.png"/>
|
|
3
|
-
</p>
|
|
4
1
|
|
|
5
|
-
# Reall3dViewer
|
|
6
|
-
|
|
7
|
-
`Reall3dViewer` is a 3D Gaussian Splatting viewer built on Three.js. Crafting an exceptional 3DGS viewer is no small feat, which is why we've chosen to open-source our project. We hope to harness the collective wisdom and efforts of the community to drive the advancement of 3DGS applications together!
|
|
8
|
-
|
|
9
|
-
<br>
|
|
10
|
-
|
|
11
|
-
<p align="center">
|
|
12
|
-
<a href="https://github.com/reall3d-com/Reall3dViewer/blob/master/README_ZH.md"><img src="https://img.shields.io/badge/readme-Chinese-brightgreen.svg"></a>
|
|
13
|
-
<a href="https://github.com/microsoft/TypeScript"><img src="https://img.shields.io/badge/lang-TypeScript-brightgreen.svg"></a>
|
|
14
|
-
<a href="https://github.com/mrdoob/three.js"><img src="https://img.shields.io/badge/base-Threejs-brightgreen.svg"></a>
|
|
15
|
-
<a href="https://github.com/reall3d-com/Reall3dViewer/releases/latest"><img src="https://img.shields.io/github/release/reall3d-com/Reall3dViewer.svg"></a>
|
|
16
|
-
<a href="https://github.com/reall3d-com/Reall3dViewer/blob/master/LICENSE"><img src="https://img.shields.io/github/license/reall3d-com/Reall3dViewer"></a>
|
|
17
|
-
<p>
|
|
18
|
-
|
|
19
|
-
<br>
|
|
20
|
-
|
|
21
|
-
## Features
|
|
22
|
-
- [x] Support formats: `.ply`, `.splat`, `.spx`, `.spz(v2,v3)`
|
|
23
|
-
- [x] Support mark and measurement
|
|
24
|
-
- [x] Support text watermark
|
|
25
|
-
- [x] Support 1st to 3rd degree spherical harmonics
|
|
26
|
-
- [x] Support rendering models within maps
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
## Live demo
|
|
30
|
-
- https://reall3d.com/reall3dviewer/index.html
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
## `.spx`
|
|
34
|
-
|
|
35
|
-
- Format Specification: https://github.com/reall3d-com/Reall3dViewer/blob/main/SPX_EN.md
|
|
36
|
-
- Conversion Tool: https://github.com/gotoeasy/gsbox
|
|
37
|
-
|
|
38
|
-
## Basic Usage
|
|
39
|
-
|
|
40
|
-
use source code
|
|
41
|
-
```shell
|
|
42
|
-
# develop
|
|
43
|
-
npm run dev
|
|
44
|
-
|
|
45
|
-
# build
|
|
46
|
-
npm run build
|
|
47
|
-
|
|
48
|
-
# open a web browser to render your 3dgs model
|
|
49
|
-
# http://hostname:port/index.html?url=your-model-link-address
|
|
50
|
-
|
|
51
|
-
# .spx file can be obtained through conversion using the gsbox
|
|
52
|
-
gsbox p2x -i /path/to/input.ply -o /path/to/output.spx -sh 0
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
use npm package [sample project here](https://github.com/reall3d-com/reall3dviewer-samples-use-npm-package)
|
|
56
|
-
```shell
|
|
57
|
-
# install
|
|
58
|
-
npm install @reall3d/reall3dviewer
|
|
59
|
-
|
|
60
|
-
# use built-in viewer
|
|
61
|
-
const viewer = new Reall3dViewer({ root: '#gsviewer' });
|
|
62
|
-
viewer.addModel(`https://reall3d.com/demo-models/yz.spx`);
|
|
63
|
-
|
|
64
|
-
# use splat mesh
|
|
65
|
-
const splatMesh = new SplatMesh({ renderer, scene, controls});
|
|
66
|
-
splatMesh.addModel({ url: 'https://reall3d.com/demo-models/yz.spx' });
|
|
67
|
-
scene.add(splatMesh);
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
## Docs(By Zread)
|
|
71
|
-
- https://zread.ai/reall3d-com/Reall3dViewer
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
## TODO
|
|
75
|
-
- Continuously optimize and enhance rendering performance
|
|
76
|
-
- Large scene
|
|
77
|
-
|
|
78
|
-
## Release History
|
|
79
|
-
https://github.com/reall3d-com/Reall3dViewer/releases
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
## Acknowledgments
|
|
83
|
-
We would like to express our gratitude to the following projects for their valuable reference implementations
|
|
84
|
-
- https://github.com/antimatter15/splat
|
|
85
|
-
- https://github.com/mkkellogg/GaussianSplats3D
|
|
86
|
-
- https://github.com/huggingface/gsplat.js
|
|
87
|
-
- https://github.com/playcanvas/supersplat
|
|
88
|
-
- https://github.com/sxguojf/three-tile
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
## Contact
|
|
92
|
-
Feel free to submit an issue on the project page. Our commercial version offers a 3DGS model format optimization tool and supports embedding watermarks to protect model ownership. Please don't hesitate to contact us.
|
|
93
|
-
- Site: https://reall3d.com
|
|
94
|
-
- Email: ai@geohold.com
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "qg3dviewer",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.umd.js",
|
|
6
6
|
"module": "./dist/index.es.js",
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"@types/node": "^22.13.5",
|
|
34
|
-
"@types/three": "^0.
|
|
34
|
+
"@types/three": "^0.180.0",
|
|
35
35
|
"@vituum/vite-plugin-postcss": "^1.1.0",
|
|
36
36
|
"less": "^4.2.2",
|
|
37
37
|
"typescript": "^5.6.3",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"peerDependencies": {
|
|
44
44
|
"@gotoeasy/three-tile": "^0.8.7",
|
|
45
45
|
"@tweenjs/tween.js": "^25.0.0",
|
|
46
|
-
"three": "^0.
|
|
46
|
+
"three": "^0.180.0"
|
|
47
47
|
},
|
|
48
48
|
"license": "MIT",
|
|
49
49
|
"keywords": [],
|