Supported data sources
- 3D Tiles for optimized massive 3D datasets, including point clouds
- glTF for individual models
- Potree point clouds
To install with npm (recommended method):
npm install --save @giro3d/giro3d
This package contains both original sources (under
src/) and slightly processed sources (dead code elimination, inlining shader code...).
If you're using a module bundler (like wepback) or plan on targeting recent enough browser, you can directly import it as such:
import Instance from '@giro3d/giro3d/core/Instance.js';
You can also import the original, untranspiled sources, by adding
import Instance from '@giro3d/giro3d/src/core/Instance.js';
This will probably limit browser compatibility though, without application specific process or
loader. Also, non
.js files (such as
.glsl files) will need to be inlined at client application
From a release bundle
See our release page.
This is handy if you need to develop on giro3d alongside your project. You need to first prepare the package folder and link from there:
npm run prepare-package cd build/giro3d npm link # then in your project folder npm link @giro3d/giro3d
To ease development, files can be automatically transpiled on modification with the
watch script :
npm run watch
Each time a source file is modified, this script will transpile it in the build folder.
To run the test suite:
API documentation and examples
giro3d is the successor of iTowns, an original work from IGN and MATIS research laboratory. It has been funded through various research programs involving the French National Research Agency, Cap Digital, The Sorbonne University, Mines ParisTech, CNRS, IFSTTAR.
giro3d is currently maintained by Oslandia.