mapgl-gltf

Plugin for the rendering glTF models with MapGL

The basic usage via npm package

Install @2gis/mapgl and @2gis/mapgl-gltf packages:

npm install @2gis/mapgl
npm install @2gis/mapgl-gltf

Import mapgl and plugin into your project:

import { load } from '@2gis/mapgl';
import { GltfPlugin } from '@2gis/mapgl-gltf';

const mapglAPI = await load();

const map = new mapglAPI.Map('container', {
    center: [82.886554, 54.980988],
    zoom: 18,
});

const plugin = new GltfPlugin(map);
plugin.addModels([{
    modelId: '03a234cb',
    coordinates: [82.886554, 54.980988],
    modelUrl: 'models/cube_draco.glb',
    rotateX: 90,
    scale: 1000,
    linkedIds: ['141373143530065', '70030076379181421'],
}]);

Release

1. Update the package version by running npm version patch|minor|major. This command returns a new package version. Let assume it's 1.2.3
2. Push changes to github and merge them to the «master» branch
3. Go to https://github.com/2gis/mapgl-gltf/releases/new
4. Click the «Choose tag» button and create a new tag according to the version in package.json, for example v1.2.3
5. Make sure the release target is the «master» branch
6. Paste the release tag into the «Release title» field, for example v1.2.3
7. Add a release description
8. Click the «Publish release» button
9. Go to https://github.com/2gis/mapgl-gltf/actions and wait for completing the release workflow

Testing

If you write screenshot tests, you will need run npm run docker:test after coding. This command runs your tests on the docker image that is used in pipeline build. This guarantees the authenticity of the screenshots used.

Documentation

You can find the more information in the official documentation.