chore(docs): Add I3S Picking Tutorial #2896
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,113 @@ | ||||||
| # I3S Picking | ||||||
|
|
||||||
| import Demo from 'examples/website/i3s-picking/src/app'; | ||||||
|
|
||||||
| <div style={{height: '50vh'}}> | ||||||
|
There was a problem hiding this comment. Shall we rename to *.mdx as it has React? There was a problem hiding this comment. Renamed |
||||||
| <Demo /> | ||||||
| </div> | ||||||
|
|
||||||
| <p></p> | ||||||
| At the example above you can click any interesting object to get it highlighted and show selected object attributes data. | ||||||
| Objects picking can be implemented for `3DObject` layer type only, it's not applicable for `IntegratedMesh` layer type. | ||||||
| Please find source code of the example <a href="https://github.com/visgl/loaders.gl/tree/master/examples/website/i3s-picking">here</a> | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Done |
||||||
|
|
||||||
| ## Selected object highlighting | ||||||
|
|
||||||
| To get selected object highlighted it needs to set prop `pickable` of the `Tile3DLayer` to `true` and prop `highlightedObjectIndex` to value of index of the selected object. Please take a look at the short codesnippet below: | ||||||
|
|
||||||
| ```ts | ||||||
| import DeckGL from '@deck.gl/react'; | ||||||
| import {Tile3DLayer} from '@deck.gl/geo-layers'; | ||||||
| import Map from 'react-map-gl'; | ||||||
| import maplibregl from 'maplibre-gl'; | ||||||
|
|
||||||
| const [highlightedObjectIndex, setHighlightedObjectIndex] = useState(-1); | ||||||
|
|
||||||
| function renderLayers() { | ||||||
| const loadOptions = {i3s: {coordinateSystem: COORDINATE_SYSTEM.LNGLAT_OFFSETS}}; | ||||||
| const layers = new Tile3DLayer({ | ||||||
| data: tilesetURL, | ||||||
| loader: I3SLoader, | ||||||
| onTilesetLoad: onTilesetLoadHandler, | ||||||
| loadOptions, | ||||||
| pickable: true, | ||||||
| highlightedObjectIndex | ||||||
| }); | ||||||
| return layers; | ||||||
| } | ||||||
|
|
||||||
| <DeckGL | ||||||
| initialViewState={viewState} | ||||||
| layers={renderLayers()} | ||||||
| controller={true} | ||||||
| onClick={(info) => setHighlightedObjectIndex(info.index)} | ||||||
| > | ||||||
| <Map reuseMaps mapLib={maplibregl} mapStyle={mapStyle} /> | ||||||
| </DeckGL>; | ||||||
| ``` | ||||||
|
|
||||||
| ## Selected object attributes loading | ||||||
|
|
||||||
| To get attributes data for the selected object it needs to invoke `loadFeatureAttributes` with the selected object and object's index as a params. | ||||||
|
|
||||||
| ```ts | ||||||
| import DeckGL from '@deck.gl/react'; | ||||||
| import {Tile3DLayer} from '@deck.gl/geo-layers'; | ||||||
| import Map from 'react-map-gl'; | ||||||
| import maplibregl from 'maplibre-gl'; | ||||||
| import {loadFeatureAttributes} from '@loaders.gl/i3s'; | ||||||
|
|
||||||
| const [highlightedObjectIndex, setHighlightedObjectIndex] = useState(-1); | ||||||
|
|
||||||
| function onClickHandler(info) { | ||||||
| setHighlightedObjectIndex(info.index); | ||||||
| loadFeatureAttributes(info.object, info.index).then((result) => { | ||||||
| setAttributesObject(result); | ||||||
| }); | ||||||
| } | ||||||
|
|
||||||
| function renderLayers() { | ||||||
| const loadOptions = {i3s: {coordinateSystem: COORDINATE_SYSTEM.LNGLAT_OFFSETS}}; | ||||||
| const layers = new Tile3DLayer({ | ||||||
| data: tilesetURL, | ||||||
| loader: I3SLoader, | ||||||
| onTilesetLoad: onTilesetLoadHandler, | ||||||
| loadOptions, | ||||||
| pickable: true, | ||||||
| highlightedObjectIndex | ||||||
| }); | ||||||
| return layers; | ||||||
| } | ||||||
|
|
||||||
| <DeckGL | ||||||
| initialViewState={viewState} | ||||||
| layers={renderLayers()} | ||||||
| controller={true} | ||||||
| onClick={onClickHandler} | ||||||
| > | ||||||
| <Map reuseMaps mapLib={maplibregl} mapStyle={mapStyle} /> | ||||||
| </DeckGL>; | ||||||
| ``` | ||||||
|
|
||||||
| Here is an example of the result returned by `loadFeatureAttributes`: | ||||||
|
|
||||||
| ```javascript | ||||||
| { | ||||||
| "OBJECTID": "709688", | ||||||
| "BIN": "1088469", | ||||||
| "DOITT_ID": "1114961", | ||||||
| "SOURCE_ID": "21510003972", | ||||||
| "FID": "709688", | ||||||
| "NAME": "Tower 1 World Trade Ctr", | ||||||
| "BBL": "1000580001", | ||||||
| "CNSTRCT_YR": "2009", | ||||||
| "LSTMODDATE": "1/1/2015", | ||||||
| "LSTSTATYPE": "Constructed", | ||||||
| "HEIGHTROOF": "1408.377901", | ||||||
| "FTRCODE": "5100", | ||||||
| "SUBFTRCODE": "510000", | ||||||
| "GROUNDELEV": "5", | ||||||
| "NUM_FLOORS": "104", | ||||||
| "BUILT_CODE": "" | ||||||
| } | ||||||
| ``` | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we understand why the layout of this file suddenly changed? Modifications further down somehow triggered prettier?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it's changed by prettier after saving other changes.
Do you want to revert it back?