heremaps / quantized-mesh-decoder

JavaScript decoder for the Quantized Mesh format

Quantized Mesh Decoder

JavaScript decoder for the Quantized Mesh format.

Note: This is experimental code, expect changes.

Installation

In Node.js

The module is installable via yarn (or npm):

yarn add @here/quantized-mesh-decoder

npm install @here/quantized-mesh-decoder

API Reference

import decode from '@here/quantized-mesh-decoder'

decode(buffer, options)

• buffer: ArrayBuffer
• options: DecoderOptions

DecoderOptions

• maxDecodingStep: Number
  Limits how deep decoder should go. Takes of the properties of the DECODING_STEPS map. See import { DECODING_STEPS } from '@here/quantized-mesh-decoder' .
  Default: DECODING_STEPS.extensions.

Links

• Quantized Mesh Specification
• Quantized Mesh Viewer
• TIN Terrain — tool that generates Quantized Mesh tiles out of GeoTIFF

Sample Tiles Attribution

• ./src/assets/tile-with-extensions.terrain: Cesium World Terrain from Cesium ion
• ./src/assets/tile-opentin.terrain: Open data from brazilian government IBGE, processed using TIN Terrain

License

Copyright (C) 2018-2019 HERE Europe B.V.

See the LICENSE file in the root of this project for license details.

quantized-mesh-decoder's Issues

Transpile to ES5?

Hello, currently this module and the published NPM module does not provide a transpiled version. Would you accept a PR to include a bundled version in the NPM package?

"Unknown extension with id 4"

Hi, thanks the decoder, but it couldn't decode metadata extension, https://github.com/CesiumGS/quantized-mesh#metadata

Publish quantized-mesh-decoder 1.1.3 to npmjs.com

This issue will be used to track open items to be resolved prior to publication

Issues found:

• Update copyrights to 2019
• Fix the various security vulnerabilities found by npm audit/yarn audit
• Switch to yarn to align with harp.gl?

Invalid NPM module

The published NPM module is currently broken because dist/quantized-mesh-decoder.js is missing.

Given my changes in #23, you need to run yarn build or npm run build before publishing.

Missing dist/ folder:

> git clone https://github.com/heremaps/quantized-mesh-decoder
> yarn
> yarn pack
> tar -ztf here-quantized-mesh-decoder-v1.2.0.tgz
package
package/.travis.yml
package/CONTRIBUTING.md
package/LICENSE
package/README.md
package/karma.conf.js
package/package.json
package/rollup.config.js
package/src
package/src/assets
package/src/index.js
package/src/index.test.js
package/src/test-utils.js
package/src/assets/tile-opentin.terrain
package/src/assets/tile-with-extensions.terrain
package/src/assets/tile-with-metadata-extension.terrain

Included dist/ folder:

> git clone https://github.com/heremaps/quantized-mesh-decoder
> yarn
# Transpile with rollup
> yarn build
> yarn pack
> tar -ztf here-quantized-mesh-decoder-v1.2.0.tgz
package
package/.travis.yml
package/CONTRIBUTING.md
package/LICENSE
package/README.md
package/dist
package/karma.conf.js
package/package.json
package/rollup.config.js
package/src
# included dist file
package/dist/quantized-mesh-decoder.js
package/src/assets
package/src/index.js
package/src/index.test.js
package/src/test-utils.js
package/src/assets/tile-opentin.terrain
package/src/assets/tile-with-extensions.terrain
package/src/assets/tile-with-metadata-extension.terrain