@x-humanoid-cloud/bic-map 0.0.2 → 0.0.3
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.en.md +173 -173
- package/README.md +7 -7
- package/dist/cdn/bicMap.ext.min.js +22 -0
- package/package.json +1 -1
package/README.en.md
CHANGED
|
@@ -1,173 +1,173 @@
|
|
|
1
|
-
<p align="right">
|
|
2
|
-
English | <a href="./README.md">中文</a>
|
|
3
|
-
</p>
|
|
4
|
-
|
|
5
|
-
<p align="right">
|
|
6
|
-
<a href="https://www.npmjs.com/package/@x-humanoid-cloud/bic-map">
|
|
7
|
-
<img src="https://img.shields.io/badge/version-0.0.1-1d81f5.svg?style=flat-square" alt="version" />
|
|
8
|
-
</a>
|
|
9
|
-
<a href="./LICENSE">
|
|
10
|
-
<img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="license" />
|
|
11
|
-
</a>
|
|
12
|
-
<a href="https://vuejs.org">
|
|
13
|
-
<img src="https://img.shields.io/badge/Vue-3.x-42b883.svg?style=flat-square" alt="vue" />
|
|
14
|
-
</a>
|
|
15
|
-
<a href="https://maplibre.org">
|
|
16
|
-
<img src="https://img.shields.io/badge/MapLibre%20GL-3.6-2d4ea0.svg?style=flat-square" alt="maplibre" />
|
|
17
|
-
</a>
|
|
18
|
-
</p>
|
|
19
|
-
|
|
20
|
-
<h1 align="center">BicMap | <a href="https://bicmap.x-humanoid-cloud.com/">Documentation</a></h1>
|
|
21
|
-
|
|
22
|
-
<h5 align="center">Seamless indoor/outdoor GPU map rendering & interaction SDK · Built for robotics</h5>
|
|
23
|
-
|
|
24
|
-
[](
|
|
25
|
-
|
|
26
|
-
BicMap (`@x-humanoid-cloud/bic-map`) is a WebGL-based map rendering library built on top of [MapLibre GL](https://maplibre.org), [Three.js](https://threejs.org), and [Turf](https://turfjs.org), extended with robotics-oriented features including **indoor SLAM maps, outdoor tile/HD maps, point clouds, 3D models, POI markers, drawing tools, path planning, and robot orchestration** — all ready to use out of the box.
|
|
27
|
-
|
|
28
|
-
BicMap maps **data** (GeoJSON / point clouds / robot poses) to a set of composable **layers and overlays**. Developers can build seamless indoor/outdoor visualization scenes through a single `bicMap` instance without worrying about engine initialization, coordinate transformations, or asset hosting.
|
|
29
|
-
|
|
30
|
-
Key Features:
|
|
31
|
-
|
|
32
|
-
* **Unified indoor/outdoor rendering** — SLAM grid maps, tile base maps, HD maps, 2D/3D point clouds, and 3D models in the same scene
|
|
33
|
-
* **Rich overlay types** — direction markers, batch POIs, robot markers, rectangles, polygons, circles, polylines, and wide line segments
|
|
34
|
-
* **Interactive drawing** — rectangles, polygons, polylines, circles, and traversable-area drawing & editing
|
|
35
|
-
* **Robotics capabilities** — pose tracking, relocalization, real-time positioning, path planning & playback, task orchestration
|
|
36
|
-
* **Zero-config engine** — `maplibre-gl` / `three` / `@turf/turf` / `urdf-loader` bundled via npm, CSS and fonts injected at runtime automatically
|
|
37
|
-
|
|
38
|
-
## Installation
|
|
39
|
-
|
|
40
|
-
### NPM Module
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
pnpm add @x-humanoid-cloud/bic-map
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
```js
|
|
47
|
-
import bicMap from '@x-humanoid-cloud/bic-map'
|
|
48
|
-
|
|
49
|
-
await bicMap.init()
|
|
50
|
-
|
|
51
|
-
const map = bicMap.createMap({
|
|
52
|
-
container: 'map',
|
|
53
|
-
center: [116.397, 39.908],
|
|
54
|
-
zoom: 16
|
|
55
|
-
})
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
Use as a Vue plugin (accessible via `this.$bicMap`):
|
|
59
|
-
|
|
60
|
-
```js
|
|
61
|
-
import { createApp } from 'vue'
|
|
62
|
-
import bicMap from '@x-humanoid-cloud/bic-map'
|
|
63
|
-
import App from './App.vue'
|
|
64
|
-
|
|
65
|
-
createApp(App).use(bicMap).mount('#app')
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
### Script Tag / CDN
|
|
69
|
-
|
|
70
|
-
For environments without a build step (uniapp renderJS, plain `<script>` tags, etc.), access via `window.bicMap` after loading:
|
|
71
|
-
|
|
72
|
-
```html
|
|
73
|
-
<script src="https://your-cdn/bicMap.ext.min.js"></script>
|
|
74
|
-
<script>
|
|
75
|
-
bicMap.init().then(() => {
|
|
76
|
-
const map = bicMap.createMap({ container: 'map' })
|
|
77
|
-
})
|
|
78
|
-
</script>
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Feature Gallery
|
|
82
|
-
|
|
83
|
-
| | | |
|
|
84
|
-
| :---: | :---: | :---: |
|
|
85
|
-
| <br/>Robot Mapping | <br/>3D Model Control | <br/>Real-time Location |
|
|
86
|
-
| <br/>POI Markers | <br/>Graphic Drawing | <br/>Cleaning Robot Scene |
|
|
87
|
-
| <br/>Transit Hub Map Guide | <br/>Museum Tour Guide | <br/>Community 24h Inspection |
|
|
88
|
-
| <br/>Outdoor Buildings | <br/>Outdoor Point Cloud | <br/>HD Map Loading |
|
|
89
|
-
|
|
90
|
-
<p align="right"><a href="https://bicmap.x-humanoid-cloud.com/">View more examples →</a></p>
|
|
91
|
-
|
|
92
|
-
## Local Development & Examples
|
|
93
|
-
|
|
94
|
-
The repository includes a built-in example portal covering 30+ examples across indoor / outdoor / basic / extended / scene categories:
|
|
95
|
-
|
|
96
|
-
```bash
|
|
97
|
-
pnpm install
|
|
98
|
-
pnpm dev # Start the example portal at
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
Build commands:
|
|
102
|
-
|
|
103
|
-
```bash
|
|
104
|
-
pnpm build # Build npm package (ESM + UMD), third-party deps external
|
|
105
|
-
pnpm build:cdn # Build CDN version (IIFE self-contained single file)
|
|
106
|
-
pnpm build:web # Build example portal static site
|
|
107
|
-
pnpm build:all # Build both npm package and CDN version
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
## Resources
|
|
111
|
-
|
|
112
|
-
* [Online API Docs](
|
|
113
|
-
* [Example Portal](
|
|
114
|
-
|
|
115
|
-
## Tech Stack
|
|
116
|
-
|
|
117
|
-
BicMap is built on top of the following open-source projects:
|
|
118
|
-
|
|
119
|
-
* [MapLibre GL JS](https://maplibre.org) — Core map rendering engine
|
|
120
|
-
* [Three.js](https://threejs.org) — 3D model and custom layer rendering
|
|
121
|
-
* [Turf.js](https://turfjs.org) — Geospatial computation
|
|
122
|
-
* [Vue 3](https://vuejs.org) + [Vite](https://vite.dev) — Example portal and build toolchain
|
|
123
|
-
* [urdf-loader](https://github.com/gkjohnson/urdf-loaders) — URDF robot model loading
|
|
124
|
-
|
|
125
|
-
## Contributors
|
|
126
|
-
|
|
127
|
-
Thanks to the following developers for their contributions to BicMap:
|
|
128
|
-
|
|
129
|
-
<table>
|
|
130
|
-
<tr>
|
|
131
|
-
<td align="center">
|
|
132
|
-
<a href="https://github.com/
|
|
133
|
-
<img src="https://github.com/
|
|
134
|
-
<br/>
|
|
135
|
-
<sub><b>
|
|
136
|
-
</a>
|
|
137
|
-
</td>
|
|
138
|
-
<td align="center">
|
|
139
|
-
<a href="https://github.com/lxycreate">
|
|
140
|
-
<img src="https://github.com/lxycreate.png" width="80" height="80" style="border-radius:50%" alt="lxycreate"/>
|
|
141
|
-
<br/>
|
|
142
|
-
<sub><b>lxycreate</b></sub>
|
|
143
|
-
</a>
|
|
144
|
-
</td>
|
|
145
|
-
<td align="center">
|
|
146
|
-
<a href="https://github.com/yinwensong">
|
|
147
|
-
<img src="https://github.com/yinwensong.png" width="80" height="80" style="border-radius:50%" alt="yinwensong"/>
|
|
148
|
-
<br/>
|
|
149
|
-
<sub><b>yinwensong</b></sub>
|
|
150
|
-
</a>
|
|
151
|
-
</td>
|
|
152
|
-
<td align="center">
|
|
153
|
-
<a href="https://github.com/tianxiangLee">
|
|
154
|
-
<img src="https://github.com/tianxiangLee.png" width="80" height="80" style="border-radius:50%" alt="tianxiangLee"/>
|
|
155
|
-
<br/>
|
|
156
|
-
<sub><b>tianxiangLee</b></sub>
|
|
157
|
-
</a>
|
|
158
|
-
</td>
|
|
159
|
-
<td align="center">
|
|
160
|
-
<a href="https://github.com/Zy9907yy">
|
|
161
|
-
<img src="https://github.com/Zy9907yy.png" width="80" height="80" style="border-radius:50%" alt="Zy9907yy"/>
|
|
162
|
-
<br/>
|
|
163
|
-
<sub><b>Zy9907yy</b></sub>
|
|
164
|
-
</a>
|
|
165
|
-
</td>
|
|
166
|
-
</tr>
|
|
167
|
-
</table>
|
|
168
|
-
|
|
169
|
-
## License
|
|
170
|
-
|
|
171
|
-
[MIT](./LICENSE) © 2024-2026 Beijing Innovation Center of Humanoid Robotics
|
|
172
|
-
|
|
173
|
-
This project bundles and redistributes several third-party open-source libraries. Their copyright and license notices are listed in [THIRD-PARTY-LICENSES.md](./THIRD-PARTY-LICENSES.md).
|
|
1
|
+
<p align="right">
|
|
2
|
+
English | <a href="./README.md">中文</a>
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<p align="right">
|
|
6
|
+
<a href="https://www.npmjs.com/package/@x-humanoid-cloud/bic-map">
|
|
7
|
+
<img src="https://img.shields.io/badge/version-0.0.1-1d81f5.svg?style=flat-square" alt="version" />
|
|
8
|
+
</a>
|
|
9
|
+
<a href="./LICENSE">
|
|
10
|
+
<img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="license" />
|
|
11
|
+
</a>
|
|
12
|
+
<a href="https://vuejs.org">
|
|
13
|
+
<img src="https://img.shields.io/badge/Vue-3.x-42b883.svg?style=flat-square" alt="vue" />
|
|
14
|
+
</a>
|
|
15
|
+
<a href="https://maplibre.org">
|
|
16
|
+
<img src="https://img.shields.io/badge/MapLibre%20GL-3.6-2d4ea0.svg?style=flat-square" alt="maplibre" />
|
|
17
|
+
</a>
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
<h1 align="center">BicMap | <a href="https://bicmap.x-humanoid-cloud.com/">Documentation</a></h1>
|
|
21
|
+
|
|
22
|
+
<h5 align="center">Seamless indoor/outdoor GPU map rendering & interaction SDK · Built for robotics</h5>
|
|
23
|
+
|
|
24
|
+
[](https://bicmap.x-humanoid-cloud.com/)
|
|
25
|
+
|
|
26
|
+
BicMap (`@x-humanoid-cloud/bic-map`) is a WebGL-based map rendering library built on top of [MapLibre GL](https://maplibre.org), [Three.js](https://threejs.org), and [Turf](https://turfjs.org), extended with robotics-oriented features including **indoor SLAM maps, outdoor tile/HD maps, point clouds, 3D models, POI markers, drawing tools, path planning, and robot orchestration** — all ready to use out of the box.
|
|
27
|
+
|
|
28
|
+
BicMap maps **data** (GeoJSON / point clouds / robot poses) to a set of composable **layers and overlays**. Developers can build seamless indoor/outdoor visualization scenes through a single `bicMap` instance without worrying about engine initialization, coordinate transformations, or asset hosting.
|
|
29
|
+
|
|
30
|
+
Key Features:
|
|
31
|
+
|
|
32
|
+
* **Unified indoor/outdoor rendering** — SLAM grid maps, tile base maps, HD maps, 2D/3D point clouds, and 3D models in the same scene
|
|
33
|
+
* **Rich overlay types** — direction markers, batch POIs, robot markers, rectangles, polygons, circles, polylines, and wide line segments
|
|
34
|
+
* **Interactive drawing** — rectangles, polygons, polylines, circles, and traversable-area drawing & editing
|
|
35
|
+
* **Robotics capabilities** — pose tracking, relocalization, real-time positioning, path planning & playback, task orchestration
|
|
36
|
+
* **Zero-config engine** — `maplibre-gl` / `three` / `@turf/turf` / `urdf-loader` bundled via npm, CSS and fonts injected at runtime automatically
|
|
37
|
+
|
|
38
|
+
## Installation
|
|
39
|
+
|
|
40
|
+
### NPM Module
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pnpm add @x-humanoid-cloud/bic-map
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
```js
|
|
47
|
+
import bicMap from '@x-humanoid-cloud/bic-map'
|
|
48
|
+
|
|
49
|
+
await bicMap.init()
|
|
50
|
+
|
|
51
|
+
const map = bicMap.createMap({
|
|
52
|
+
container: 'map',
|
|
53
|
+
center: [116.397, 39.908],
|
|
54
|
+
zoom: 16
|
|
55
|
+
})
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Use as a Vue plugin (accessible via `this.$bicMap`):
|
|
59
|
+
|
|
60
|
+
```js
|
|
61
|
+
import { createApp } from 'vue'
|
|
62
|
+
import bicMap from '@x-humanoid-cloud/bic-map'
|
|
63
|
+
import App from './App.vue'
|
|
64
|
+
|
|
65
|
+
createApp(App).use(bicMap).mount('#app')
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Script Tag / CDN
|
|
69
|
+
|
|
70
|
+
For environments without a build step (uniapp renderJS, plain `<script>` tags, etc.), access via `window.bicMap` after loading:
|
|
71
|
+
|
|
72
|
+
```html
|
|
73
|
+
<script src="https://your-cdn/bicMap.ext.min.js"></script>
|
|
74
|
+
<script>
|
|
75
|
+
bicMap.init().then(() => {
|
|
76
|
+
const map = bicMap.createMap({ container: 'map' })
|
|
77
|
+
})
|
|
78
|
+
</script>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Feature Gallery
|
|
82
|
+
|
|
83
|
+
| | | |
|
|
84
|
+
| :---: | :---: | :---: |
|
|
85
|
+
| <br/>Robot Mapping | <br/>3D Model Control | <br/>Real-time Location |
|
|
86
|
+
| <br/>POI Markers | <br/>Graphic Drawing | <br/>Cleaning Robot Scene |
|
|
87
|
+
| <br/>Transit Hub Map Guide | <br/>Museum Tour Guide | <br/>Community 24h Inspection |
|
|
88
|
+
| <br/>Outdoor Buildings | <br/>Outdoor Point Cloud | <br/>HD Map Loading |
|
|
89
|
+
|
|
90
|
+
<p align="right"><a href="https://bicmap.x-humanoid-cloud.com/">View more examples →</a></p>
|
|
91
|
+
|
|
92
|
+
## Local Development & Examples
|
|
93
|
+
|
|
94
|
+
The repository includes a built-in example portal covering 30+ examples across indoor / outdoor / basic / extended / scene categories:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
pnpm install
|
|
98
|
+
pnpm dev # Start the example portal at https://bicmap.x-humanoid-cloud.com/
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Build commands:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
pnpm build # Build npm package (ESM + UMD), third-party deps external
|
|
105
|
+
pnpm build:cdn # Build CDN version (IIFE self-contained single file)
|
|
106
|
+
pnpm build:web # Build example portal static site
|
|
107
|
+
pnpm build:all # Build both npm package and CDN version
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Resources
|
|
111
|
+
|
|
112
|
+
* [Online API Docs](https://bicmap.x-humanoid-cloud.com/) — Example portal and latest API reference
|
|
113
|
+
* [Example Portal](https://bicmap.x-humanoid-cloud.com/) — Interactive preview of all examples; click any card to open the corresponding demo
|
|
114
|
+
|
|
115
|
+
## Tech Stack
|
|
116
|
+
|
|
117
|
+
BicMap is built on top of the following open-source projects:
|
|
118
|
+
|
|
119
|
+
* [MapLibre GL JS](https://maplibre.org) — Core map rendering engine
|
|
120
|
+
* [Three.js](https://threejs.org) — 3D model and custom layer rendering
|
|
121
|
+
* [Turf.js](https://turfjs.org) — Geospatial computation
|
|
122
|
+
* [Vue 3](https://vuejs.org) + [Vite](https://vite.dev) — Example portal and build toolchain
|
|
123
|
+
* [urdf-loader](https://github.com/gkjohnson/urdf-loaders) — URDF robot model loading
|
|
124
|
+
|
|
125
|
+
## Contributors
|
|
126
|
+
|
|
127
|
+
Thanks to the following developers for their contributions to BicMap:
|
|
128
|
+
|
|
129
|
+
<table>
|
|
130
|
+
<tr>
|
|
131
|
+
<td align="center">
|
|
132
|
+
<a href="https://github.com/HouserHao">
|
|
133
|
+
<img src="https://github.com/HouserHao.png" width="80" height="80" style="border-radius:50%" alt="HouserHao"/>
|
|
134
|
+
<br/>
|
|
135
|
+
<sub><b>HouserHao</b></sub>
|
|
136
|
+
</a>
|
|
137
|
+
</td>
|
|
138
|
+
<td align="center">
|
|
139
|
+
<a href="https://github.com/lxycreate">
|
|
140
|
+
<img src="https://github.com/lxycreate.png" width="80" height="80" style="border-radius:50%" alt="lxycreate"/>
|
|
141
|
+
<br/>
|
|
142
|
+
<sub><b>lxycreate</b></sub>
|
|
143
|
+
</a>
|
|
144
|
+
</td>
|
|
145
|
+
<td align="center">
|
|
146
|
+
<a href="https://github.com/yinwensong">
|
|
147
|
+
<img src="https://github.com/yinwensong.png" width="80" height="80" style="border-radius:50%" alt="yinwensong"/>
|
|
148
|
+
<br/>
|
|
149
|
+
<sub><b>yinwensong</b></sub>
|
|
150
|
+
</a>
|
|
151
|
+
</td>
|
|
152
|
+
<td align="center">
|
|
153
|
+
<a href="https://github.com/tianxiangLee">
|
|
154
|
+
<img src="https://github.com/tianxiangLee.png" width="80" height="80" style="border-radius:50%" alt="tianxiangLee"/>
|
|
155
|
+
<br/>
|
|
156
|
+
<sub><b>tianxiangLee</b></sub>
|
|
157
|
+
</a>
|
|
158
|
+
</td>
|
|
159
|
+
<td align="center">
|
|
160
|
+
<a href="https://github.com/Zy9907yy">
|
|
161
|
+
<img src="https://github.com/Zy9907yy.png" width="80" height="80" style="border-radius:50%" alt="Zy9907yy"/>
|
|
162
|
+
<br/>
|
|
163
|
+
<sub><b>Zy9907yy</b></sub>
|
|
164
|
+
</a>
|
|
165
|
+
</td>
|
|
166
|
+
</tr>
|
|
167
|
+
</table>
|
|
168
|
+
|
|
169
|
+
## License
|
|
170
|
+
|
|
171
|
+
[MIT](./LICENSE) © 2024-2026 Beijing Innovation Center of Humanoid Robotics
|
|
172
|
+
|
|
173
|
+
This project bundles and redistributes several third-party open-source libraries. Their copyright and license notices are listed in [THIRD-PARTY-LICENSES.md](./THIRD-PARTY-LICENSES.md).
|
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
<h5 align="center">室内外一体化的 GPU 地图渲染与交互解决方案 · 面向机器人场景</h5>
|
|
23
23
|
|
|
24
|
-
[](
|
|
24
|
+
[](https://bicmap.x-humanoid-cloud.com/)
|
|
25
25
|
|
|
26
26
|
BicMap（`@x-humanoid-cloud/bic-map`）是一套基于 WebGL 的地图渲染库，在 [MapLibre GL](https://maplibre.org) + [Three.js](https://threejs.org) + [Turf](https://turfjs.org) 之上做了面向机器人业务的二次封装，提供 **室内 SLAM 地图、室外瓦片/高精地图、点云、3D 模型、POI 标注、绘制工具、路径规划与机器人编排** 等开箱即用的能力。
|
|
27
27
|
|
|
@@ -95,7 +95,7 @@ createApp(App).use(bicMap).mount('#app')
|
|
|
95
95
|
|
|
96
96
|
```bash
|
|
97
97
|
pnpm install
|
|
98
|
-
pnpm dev # 启动示例门户，默认
|
|
98
|
+
pnpm dev # 启动示例门户，默认 https://bicmap.x-humanoid-cloud.com/
|
|
99
99
|
```
|
|
100
100
|
|
|
101
101
|
构建命令：
|
|
@@ -109,8 +109,8 @@ pnpm build:all # 同时构建 npm 包与 CDN 版本
|
|
|
109
109
|
|
|
110
110
|
## 学习资源
|
|
111
111
|
|
|
112
|
-
* [在线 API 文档](
|
|
113
|
-
* [示例门户](
|
|
112
|
+
* [在线 API 文档](https://bicmap.x-humanoid-cloud.com/)：示例门户与最新接口说明
|
|
113
|
+
* [示例门户](https://bicmap.x-humanoid-cloud.com/)：所有示例的可交互预览，点击卡片即可打开对应示例
|
|
114
114
|
|
|
115
115
|
## 技术栈
|
|
116
116
|
|
|
@@ -129,10 +129,10 @@ BicMap 构建于以下开源项目之上：
|
|
|
129
129
|
<table>
|
|
130
130
|
<tr>
|
|
131
131
|
<td align="center">
|
|
132
|
-
<a href="https://github.com/
|
|
133
|
-
<img src="https://github.com/
|
|
132
|
+
<a href="https://github.com/HouserHao">
|
|
133
|
+
<img src="https://github.com/HouserHao.png" width="80" height="80" style="border-radius:50%" alt="HouserHao"/>
|
|
134
134
|
<br/>
|
|
135
|
-
<sub><b>
|
|
135
|
+
<sub><b>HouserHao</b></sub>
|
|
136
136
|
</a>
|
|
137
137
|
</td>
|
|
138
138
|
<td align="center">
|