Display the inspector with a custom panel.
The inspector is an extensible tool used to debug and diagnose issues in the 3D scene.
import * as GUI from 'lil-gui';
import StadiaMaps from 'ol/source/StadiaMaps.js';
import { MapControls } from 'three/examples/jsm/controls/MapControls.js';
import Inspector from '@giro3d/giro3d/gui/Inspector.js';
import Extent from '@giro3d/giro3d/core/geographic/Extent.js';
import Instance from '@giro3d/giro3d/core/Instance.js';
import ColorLayer from '@giro3d/giro3d/core/layer/ColorLayer.js';
import Map from '@giro3d/giro3d/entities/Map.js';
import Panel from '@giro3d/giro3d/gui/Panel.js';
import TiledImageSource from '@giro3d/giro3d/sources/TiledImageSource.js';
class MyCustomPanel extends Panel {
/**
* @param {GUI} parentGui The parent GUI.
* @param {Map} map The observed map.
* @param {Instance} instance The Giro3D instance.
*/
constructor(parentGui, map, instance) {
super(parentGui, instance, 'Custom panel');
this.map = map;
this.myCheckBox = true;
this.addController(this, 'sayHello').name('Press this button!');
this.addController(this, 'myCheckBox')
.name('Check this box !')
.onChange(value => {
this.map.object3d.visible = value;
this.instance.notifyChange(this.map);
});
}
// eslint-disable-next-line class-methods-use-this
sayHello() {
window.alert('Hello from my custom panel!');
}
}
// Defines geographic extent: CRS, min/max X, min/max Y
const extent = new Extent(
'EPSG:3857',
-20037508.342789244,
20037508.342789244,
-20037508.342789244,
20037508.342789244,
);
// `viewerDiv` will contain Giro3D' rendering area (the canvas element)
const viewerDiv = document.getElementById('viewerDiv');
// Creates a Giro3D instance
const instance = new Instance(viewerDiv, { crs: extent.crs() });
const map = new Map('planar', { extent });
instance.add(map);
// Adds an TMS imagery layer
map.addLayer(
new ColorLayer({
name: 'color',
source: new TiledImageSource({
source: new StadiaMaps({ layer: 'stamen_watercolor', wrapX: false }),
}),
}),
);
// Create camera and controls
instance.camera.camera3D.position.set(0, 0, 25000000);
const controls = new MapControls(instance.camera.camera3D, instance.domElement);
instance.useTHREEControls(controls);
// Attach the inspector to the DOM
const inspectorDiv = document.getElementById('panelDiv');
inspectorDiv.classList.remove('d-none');
const inspector = Inspector.attach(inspectorDiv, instance, { title: 'Custom title' });
// Hide the fullscreen button that is at the same place as the Inspector
const btnFullscreen = document.getElementById('btnFullscreen');
btnFullscreen.classList.add('d-none');
const myCustomPanel = new MyCustomPanel(inspector.gui, map, instance);
// Add our custom panel to the inspector.
inspector.addPanel(myCustomPanel);
// Trigger the first render
instance.notifyChange(map);
<!doctype html>
<html lang="en">
<head>
<title>Inspector</title>
<meta charset="UTF-8" />
<meta name="name" content="inspector" />
<meta name="description" content="Display the inspector with a custom panel." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="https://giro3d.org/images/favicon.svg" />
<link href="https://giro3d.org/assets/bootstrap-custom.css" rel="stylesheet" />
<script src="https://giro3d.org/assets/bootstrap.bundle.min.js"></script>
<link
rel="stylesheet"
type="text/css"
href="https://giro3d.org/next/css/example.css"
/>
</head>
<body>
<div id="viewerDiv" class="m-0 p-0 w-100 h-100"></div>
<div id="panelDiv" class="position-absolute top-0 start-0 mh-100 overflow-auto"></div>
<script type="module" src="index.js"></script>
<script>
/* activate popovers */
const popoverTriggerList = [].slice.call(
document.querySelectorAll('[data-bs-toggle="popover"]'),
);
popoverTriggerList.map(
// bootstrap is used as script in the template, disable warning about undef
// eslint-disable-next-line no-undef
popoverTriggerEl =>
new bootstrap.Popover(popoverTriggerEl, {
trigger: 'hover',
placement: 'left',
content: document.getElementById(
popoverTriggerEl.getAttribute('data-bs-content'),
).innerHTML,
html: true,
}),
);
</script>
</body>
</html>
{
"name": "inspector",
"dependencies": {
"@giro3d/giro3d": "git+https://gitlab.com/giro3d/giro3d.git"
},
"devDependencies": {
"vite": "^3.2.3"
},
"scripts": {
"start": "vite",
"build": "vite build"
}
}