Tiles: options enhancements #1475
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -66,8 +66,12 @@ export type Tileset3DProps = { | |
| attributions?: string[]; | ||
| headers?: any; | ||
| loadTiles?: boolean; | ||
| loadOptions?: {[key: string]: any}; | ||
| updateTransforms?: boolean; | ||
| maxRequests?: number; | ||
|
There was a problem hiding this comment. We could also supply a There was a problem hiding this comment. But the only relevant request scheduler option is |
||
| viewDistanceScale?: number; | ||
| basePath?: string; | ||
| contentLoader?: (tile: Tile3D) => Promise<void>; | ||
| }; | ||
|
|
||
| type Props = { | ||
|
|
@@ -85,8 +89,11 @@ type Props = { | |
| attributions: string[]; | ||
| headers: any; | ||
| loadTiles: boolean; | ||
| loadOptions: {[key: string]: any}; | ||
| updateTransforms: boolean; | ||
| viewDistanceScale: number; | ||
| basePath: string; | ||
| contentLoader?: (tile: Tile3D) => Promise<void>; | ||
| i3s: {[key: string]: any}; | ||
| }; | ||
|
|
||
|
|
@@ -108,15 +115,22 @@ const DEFAULT_PROPS: Props = { | |
| onTileUnload: (tile) => {}, | ||
| onTileError: (tile, message, url) => {}, | ||
|
|
||
| // Optional async tile content loader | ||
| contentLoader: undefined, | ||
|
|
||
| // View distance scale modifier | ||
| viewDistanceScale: 1.0, | ||
|
|
||
| // TODO CESIUM | ||
| // The maximum screen space error used to drive level of detail refinement. | ||
| maximumScreenSpaceError: 8, | ||
|
|
||
| loadTiles: true, | ||
| updateTransforms: true, | ||
| viewportTraversersMap: null, | ||
|
|
||
| headers: {}, | ||
| loadOptions: {}, | ||
|
|
||
| token: '', | ||
| attributions: [], | ||
|
|
@@ -140,7 +154,7 @@ const TILES_GPU_MEMORY = 'Tile Memory Use'; | |
| export default class Tileset3D { | ||
| // props: Tileset3DProps; | ||
| options: Props; | ||
| loadOptions: {[key: string]: any}; | ||
|
|
||
| type: string; | ||
| tileset: {[key: string]: any}; | ||
|
|
@@ -238,12 +252,18 @@ export default class Tileset3D { | |
| this.refine = json.root.refine; | ||
|
|
||
| // TODO add to loader context? | ||
| this.loadOptions = this.options.loadOptions || {}; | ||
| if (this.options.headers) { | ||
| this.loadOptions.fetch = { | ||
| ...this.loadOptions.fetch, | ||
| headers: this.options.headers | ||
|
There was a problem hiding this comment. Should we make a breaking change and drop the There was a problem hiding this comment. That is fine by me! There was a problem hiding this comment. OK I created an API cleanup section here: #1245 where we can track proposals for API changes. |
||
| }; | ||
| } | ||
| if (this.options.token) { | ||
| this.loadOptions.fetch = { | ||
| ...this.loadOptions.fetch, | ||
| token: this.options.token | ||
| }; | ||
| } | ||
|
|
||
| this.root = null; | ||
|
|
||
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
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.
We already have an
onTileLoadcallback. Do we need to add another callback? If we do, can we follow the convention and call itonTileContentLoador similar?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.
This is not the same as the
onTile* callbacks which are essentially events.The content loader promise must resolve before a tile can set
And only then those callbacks may be fired.
Without this solution there is no way to use
asyncloaders such as the three.jsGLTFLoaderwithout experiencing a race condition in which a tile is selected before it is actually on the render graph.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.
Understood, thanks for clearing up the use case.
Would it make sense if we could declare it as
onTileContentLoad(tile: Tile3D): Promise<void>and we wait for it?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.
I am a bit hesitant because usually
on*callbacks are not something you would expect would block execution. But I defer to you on this one.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 I can see your point. Thoughts:
contentLoaderrisk being confusing in a framework that is specifically built around a concept of "loaders". I would have expected an option with that name to accept a loaders.gl loader.on...functions to return promises though this might lead to unintended synchronization for current users, if they are using async functions as callbacks.When working with a big documented API the API audit tends to be a big part of the effort. This is why it is often best to make one PR for every addition, instead of one PR with 4 new props :)
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.
Perhaps
tileProcessingHookor something of sort?Understood about the heavy PRs. Will work to make those leaner in the future.