# quantized-mesh-viewer

**Repository Path**: wq/quantized-mesh-viewer

## Basic Information

- **Project Name**: quantized-mesh-viewer
- **Description**: Render custom quantized mesh tiles in Cesium.js and debug individual tiles using THREE.js renderer.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-12-22
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Quantized Mesh Viewer
===========================

Render custom [quantized mesh](https://github.com/AnalyticalGraphicsInc/quantized-mesh) tiles in Cesium and debug individual tiles using THREE.js renderer.

For generation quantized-mesh tiles from raster you can use the [heremaps/tin-terrain](https://github.com/heremaps/tin-terrain) tool.

Note: This is experimental code, expect changes. 

### Run

```
npm i
npm start
```
At *http://localhost:8080* you'll see a Cesium map with example terrain tiles.

![Cesium map with rendered terrain tiles](./map-preview.png)



To debug individual tile go to *http://localhost:8080/tile.html*.

![Individual terrain tile rendered using THREE.js](./tile-preview.png)

On the right panel change the path to the tile and adjust debug parameters.

You can also start the app in a Docker container.

```bash
docker build -t qm-viewer .
docker run -t -i --name qm-viewer -p 8080:8080 -v $(pwd):/usr/src/app qm-viewer
```



### Custom Tiles

By default application renders example tiles from `./example-tiles` folder. To serve files from different location customize `SurfaceProvider` parameters in the `./src/map/index.js`.

Application serves statics from its whole root directory so you can put folder with custom tiles next to the `./example-tiles` folder.



### Configuring `SurfaceProvider`

```
new SurfaceProvider(options)
```

Options:
* getUrl: (x: Number, y: Number, level: Number) → String  
  Required  
  Constructs URL to fetch a tile using provided grid coordinates.
* tilingScheme: Cesium.TilingScheme  
  Optional  
  Default — Cesium.WebMercatorTilingScheme
* credit: [Cesium.Credit]  
  Optional  
  Credits for a tiles data



### Notes

- Cesium cannot render tiles for a specific zoom level unless you provide tiles for all parent level. The `SurfaceProvider` mocks missing tiles with a plane geometry.



### Links

* [Quantized Mesh Decoder](https://github.com/heremaps/quantized-mesh-decoder)
* [Quantized Mesh Format Specification](https://github.com/AnalyticalGraphicsInc/quantized-mesh)



### Contribute

See [CONTRIBUTING](./CONTRIBUTING.md).



### License

Copyright © 2018 HERE Europe B.V.

See the [LICENSE](LICENSE) file in the root of this project for license details.