Skip to content

Allow user to override tile level calculation #1566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xawill wants to merge 1 commit into
base: master
Choose a base branch
from
+68 −24
Open

Allow user to override tile level calculation #1566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/three/plugins/images/ImageOverlayPlugin.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Color, Matrix4, WebGLRenderer } from 'three';
import { WMTSTileMatrix } from '../loaders/WMTSCapabilitiesLoader.js';
import { Tile } from '../../../core/renderer/tiles/Tile.js';

export class ImageOverlayPlugin {

Expand Down Expand Up @@ -37,6 +38,7 @@ export class TiledImageOverlay extends ImageOverlay {
readonly projection: any;
readonly aspectRatio: number;
fetchOptions: any;
mapZoomLevelToTile: ( ( level: number, tile: Tile ) => number | null ) | null;

}

Expand All @@ -54,6 +56,7 @@ export class XYZTilesOverlay extends TiledImageOverlay {
preprocessURL?: ( url: string ) => string | null;
alphaMask?: boolean,
alphaInvert?: boolean,
mapZoomLevelToTile?: ( level: number, tile: Tile ) => number | null;
} );

}
Expand Down Expand Up @@ -99,6 +102,7 @@ export class WMSTilesOverlay extends TiledImageOverlay {
preprocessURL?: ( url: string ) => string | null;
alphaMask?: boolean,
alphaInvert?: boolean,
mapZoomLevelToTile?: ( level: number, tile: Tile ) => number | null;
} );

}
Expand All @@ -124,6 +128,7 @@ export class WMTSTilesOverlay extends TiledImageOverlay {
preprocessURL?: ( url: string ) => string | null;
alphaMask?: boolean,
alphaInvert?: boolean,
mapZoomLevelToTile?: ( level: number, tile: Tile ) => number | null;
} );

}
Expand All @@ -139,6 +144,7 @@ export class TMSTilesOverlay extends TiledImageOverlay {
preprocessURL?: ( url: string ) => string | null;
alphaMask?: boolean,
alphaInvert?: boolean,
mapZoomLevelToTile?: ( level: number, tile: Tile ) => number | null;
} );

}
Expand All @@ -156,6 +162,7 @@ export class CesiumIonOverlay extends TiledImageOverlay {
preprocessURL?: ( url: string ) => string | null;
alphaMask?: boolean,
alphaInvert?: boolean,
mapZoomLevelToTile?: ( level: number, tile: Tile ) => number | null;
} );

}
Expand All @@ -174,6 +181,7 @@ export class GoogleMapsOverlay extends TiledImageOverlay {
preprocessURL?: ( url: string ) => string | null;
alphaMask?: boolean,
alphaInvert?: boolean,
mapZoomLevelToTile?: ( level: number, tile: Tile ) => number | null;
} );

}
84 changes: 60 additions & 24 deletions src/three/plugins/images/ImageOverlayPlugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ export class ImageOverlayPlugin {

if ( range !== null ) {

overlay.releaseTexture( range );
overlay.releaseTexture( range, tile );

}

Expand Down Expand Up @@ -511,7 +511,7 @@ export class ImageOverlayPlugin {
// if the tile has a render target associated with the overlay and the last level of detail
// is not being displayed, yet, then we need to split
const info = tileInfo.get( tile );
if ( info && info.target && overlay.shouldSplit( info.range ) ) {
if ( info && info.target && overlay.shouldSplit( info.range, tile ) ) {

// get the vector representing the projection direction
if ( overlay.frame ) {
Expand Down Expand Up @@ -857,7 +857,7 @@ export class ImageOverlayPlugin {
// release the ranges
if ( range !== null ) {

overlay.releaseTexture( range );
overlay.releaseTexture( range, tile );

}

Expand Down Expand Up @@ -1012,7 +1012,7 @@ export class ImageOverlayPlugin {
range = overlay.projection.toNormalizedRange( range );

info.range = range;
overlay.lockTexture( range );
overlay.lockTexture( range, tile );

}

Expand Down Expand Up @@ -1104,14 +1104,14 @@ export class ImageOverlayPlugin {
if ( info.range === null ) {

info.range = range;
overlay.lockTexture( range );
overlay.lockTexture( range, tile );

}

// if the image projection is outside the 0, 1 uvw range or there are no textures to draw in
// the tiled image set the don't allocate a texture for it.
let target = null;
if ( heightInRange && overlay.hasContent( range ) ) {
if ( heightInRange && overlay.hasContent( range, tile ) ) {

target = await processQueue
.add( { tile, overlay }, async () => {
Expand All @@ -1124,7 +1124,7 @@ export class ImageOverlayPlugin {
}

// Get the texture from the overlay
const regionTarget = await overlay.getTexture( range );
const regionTarget = await overlay.getTexture( range, tile );

// check if the overlay has been disposed since starting this function
if ( controller.signal.aborted || tileController.signal.aborted ) {
Expand Down Expand Up @@ -1349,33 +1349,33 @@ class ImageOverlay {

}

hasContent( range ) {
hasContent( range, tile ) {

return false;

}

async getTexture( range ) {
async getTexture( range, tile ) {

return null;

}

async lockTexture( range ) {
async lockTexture( range, tile ) {

return null;

}

releaseTexture( range ) {
releaseTexture( range, tile ) {

}

setResolution( resolution ) {

}

shouldSplit( range ) {
shouldSplit( range, tile ) {

return false;

Expand All @@ -1388,6 +1388,10 @@ class ImageOverlay {
* Manages a `TiledImageSource` and a `RegionImageSource` that handles compositing
* multiple source tiles into a single texture per 3D tile region.
* @extends ImageOverlay
* @param {Object} [options]
* @param {Function} [options.mapZoomLevelToTile=null] Optional callback allowing user to override the tile level
* selection. Passes the default computed tile level and the tile object. Should return the overriden tile level or
* `null` to prevent the tile from being rendered.
*/
class TiledImageOverlay extends ImageOverlay {

Expand Down Expand Up @@ -1423,10 +1427,11 @@ class TiledImageOverlay extends ImageOverlay {

constructor( options = {} ) {

const { imageSource = null, ...rest } = options;
const { imageSource = null, mapZoomLevelToTile = null, ...rest } = options;
super( rest );
this.imageSource = imageSource;
this.regionImageSource = null;
this.mapZoomLevelToTile = mapZoomLevelToTile;

}

Expand All @@ -1450,7 +1455,7 @@ class TiledImageOverlay extends ImageOverlay {
}

// Texture acquisition API implementations
calculateLevel( range ) {
calculateLevel( range, tile ) {

const [ minX, minY, maxX, maxY ] = range;
const w = maxX - minX;
Expand Down Expand Up @@ -1481,31 +1486,44 @@ class TiledImageOverlay extends ImageOverlay {

}

if ( this.mapZoomLevelToTile !== null ) {

level = this.mapZoomLevelToTile( level, tile );

}

return level;

}

hasContent( range ) {
hasContent( range, tile ) {

return this.regionImageSource.hasContent( ...range, this.calculateLevel( range ) );
const level = this.calculateLevel( range, tile );
if ( level === null || level < this.tiling.minLevel ) {

return false;

}

return this.regionImageSource.hasContent( ...range, level );

}

getTexture( range ) {
getTexture( range, tile ) {

return this.regionImageSource.get( ...range, this.calculateLevel( range ) );
return this.regionImageSource.get( ...range, this.calculateLevel( range, tile ) );

}

lockTexture( range ) {
lockTexture( range, tile ) {

return this.regionImageSource.lock( ...range, this.calculateLevel( range ) );
return this.regionImageSource.lock( ...range, this.calculateLevel( range, tile ) );

}

releaseTexture( range ) {
releaseTexture( range, tile ) {

this.regionImageSource.release( ...range, this.calculateLevel( range ) );
this.regionImageSource.release( ...range, this.calculateLevel( range, tile ) );

}

Expand All @@ -1515,10 +1533,10 @@ class TiledImageOverlay extends ImageOverlay {

}

shouldSplit( range ) {
shouldSplit( range, tile ) {

// if we haven't reached the max level yet then continue splitting
return this.tiling.maxLevel > this.calculateLevel( range );
return this.tiling.maxLevel > this.calculateLevel( range, tile );

}

Expand All @@ -1539,6 +1557,9 @@ class TiledImageOverlay extends ImageOverlay {
* @param {Function} [options.preprocessURL=null] URL rewriting callback.
* @param {boolean} [options.alphaMask=false] Use alpha channel as a surface mask.
* @param {boolean} [options.alphaInvert=false] Invert the alpha channel.
* @param {Function} [options.mapZoomLevelToTile=null] Optional callback allowing user to override the tile level
* selection. Passes the default computed tile level and the tile object. Should return the overriden tile level or
* `null` to prevent the tile from being rendered.
*/
export class XYZTilesOverlay extends TiledImageOverlay {

Expand Down Expand Up @@ -1727,6 +1748,9 @@ export class GeoJSONOverlay extends ImageOverlay {
* @param {Function} [options.preprocessURL=null] URL rewriting callback.
* @param {boolean} [options.alphaMask=false] Use alpha channel as a surface mask.
* @param {boolean} [options.alphaInvert=false] Invert the alpha channel.
* @param {Function} [options.mapZoomLevelToTile=null] Optional callback allowing user to override the tile level
* selection. Passes the default computed tile level and the tile object. Should return the overriden tile level or
* `null` to prevent the tile from being rendered.
*/
export class WMSTilesOverlay extends TiledImageOverlay {

Expand Down Expand Up @@ -1757,6 +1781,9 @@ export class WMSTilesOverlay extends TiledImageOverlay {
* @param {number} [options.levels=20] - Number of zoom levels. Ignored if `tileMatrices` is provided.
* @param {number} [options.tileDimension=256] - Default tile width and height in pixels.
* @param {number[]|null} [options.contentBoundingBox=null] - Content bounding box in radians, `[west, south, east, north]`. If null, uses full projection bounds.
* @param {Function} [options.mapZoomLevelToTile=null] Optional callback allowing user to override the tile level
* selection. Passes the default computed tile level and the tile object. Should return the overriden tile level or
* `null` to prevent the tile from being rendered.
*/
export class WMTSTilesOverlay extends TiledImageOverlay {

Expand All @@ -1781,6 +1808,9 @@ export class WMTSTilesOverlay extends TiledImageOverlay {
* @param {Function} [options.preprocessURL=null] URL rewriting callback.
* @param {boolean} [options.alphaMask=false] Use alpha channel as a surface mask.
* @param {boolean} [options.alphaInvert=false] Invert the alpha channel.
* @param {Function} [options.mapZoomLevelToTile=null] Optional callback allowing user to override the tile level
* selection. Passes the default computed tile level and the tile object. Should return the overriden tile level or
* `null` to prevent the tile from being rendered.
*/
export class TMSTilesOverlay extends TiledImageOverlay {

Expand Down Expand Up @@ -1808,6 +1838,9 @@ export class TMSTilesOverlay extends TiledImageOverlay {
* @param {Function} [options.preprocessURL=null] URL rewriting callback.
* @param {boolean} [options.alphaMask=false] Use alpha channel as a surface mask.
* @param {boolean} [options.alphaInvert=false] Invert the alpha channel.
* @param {Function} [options.mapZoomLevelToTile=null] Optional callback allowing user to override the tile level
* selection. Passes the default computed tile level and the tile object. Should return the overriden tile level or
* `null` to prevent the tile from being rendered.
*/
export class CesiumIonOverlay extends TiledImageOverlay {

Expand Down Expand Up @@ -1933,6 +1966,9 @@ export class CesiumIonOverlay extends TiledImageOverlay {
* @param {Function} [options.preprocessURL=null] URL rewriting callback.
* @param {boolean} [options.alphaMask=false] Use alpha channel as a surface mask.
* @param {boolean} [options.alphaInvert=false] Invert the alpha channel.
* @param {Function} [options.mapZoomLevelToTile=null] Optional callback allowing user to override the tile level
* selection. Passes the default computed tile level and the tile object. Should return the overriden tile level or
* `null` to prevent the tile from being rendered.
*/
export class GoogleMapsOverlay extends TiledImageOverlay {

Expand Down
Loading