threebox

A Mapbox GL JS plugin that combines the power of the Three.js 3D library with Mapbox geospatial tools.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
threebox
517510.1.57 years ago7 years agoMinified + gzip package size for threebox in KB

Readme

threebox
A three.js plugin for Mapbox GL JS, with support for basic animation and advanced 3D rendering.

Installation

Add it to your project via npm:
npm install threebox
or download the bundle from dist/threebox.js and add include it in a <script> tag on your page.

Documentation

Threebox

Set up and handle the core translations between a Three.js scene graph and the Mapbox GL JS map.

SymbolLayer3D

The SymbolLayer3D object lets you load in a GeoJSON FeatureCollection of points and will automatically place 3D models at each point.

Features

Current

These features currently have a dedicated interface in threebox.
3D Symbol Layers

:pointright: SymbolLayer3D 📝

Planned

These features should be possible to implement using Three.js today but would benefit from a more geographic/map-specific interface in a future version of threebox.
3D Paths
Point Clouds
Complex 3D Buildings
GLSL Shaders
3D Terrain

Building

npm run build
or to continually rebuild as you develop:
npm run dev
Both commands will output a bundled in /dist/threebox.js.