3d-tiles-renderer/src/core/renderer/tiles/TilesRendererBase.d.ts

https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/specification

import { LRUCache } from '../utilities/LRUCache.js';
import { PriorityQueue } from '../utilities/PriorityQueue.js';
import { Tile } from './Tile.js';
import { Tileset } from './Tileset.js';

// Events dispatched by TilesRendererBase, available across all renderer implementations.
export interface TilesRendererBaseEventMap<TScene = unknown> {
	'needs-update': {};
	'load-tileset': { tileset : Tileset, url : string };
	'load-root-tileset': { tileset : Tileset, url : string };
	'tiles-load-start': {};
	'tiles-load-end': {};
	'tile-download-start': { tile : Tile, url : string };
	'load-model': { scene : TScene, tile : Tile, url : string };
	'dispose-model': { scene : TScene, tile : Tile };
	'tile-visibility-change': { scene : TScene, tile : Tile, visible : boolean };
	'update-before': {};
	'update-after': {};
	'load-error': { tile : Tile | null, error : Error, url : string | URL };
}

export class TilesRendererBase<TEventMap extends TilesRendererBaseEventMap = TilesRendererBaseEventMap> {

	readonly rootTileset : Tileset | null;
	readonly root : Tile | null;
	readonly visibleTiles : Set<Tile>;
	readonly activeTiles : Set<Tile>;

	errorTarget : number;
	displayActiveTiles : boolean;
	maxDepth : number;
	loadSiblings : boolean;
	loadAncestors : boolean;
	maxTilesProcessed : number;

	readonly loadProgress : number;

	fetchOptions : RequestInit;

	lruCache : LRUCache;
	parseQueue : PriorityQueue;
	downloadQueue : PriorityQueue;
	processNodeQueue: PriorityQueue;

	constructor( url?: string );
	update() : void;
	registerPlugin( plugin: object ) : void;
	unregisterPlugin( plugin: object | string ) : boolean;
	getPluginByName( plugin: object | string ) : object;
	traverse(
		beforeCb : ( ( tile : object, parent : object, depth : number ) => boolean ) | null,
		afterCb : ( ( tile : object, parent : object, depth : number ) => boolean ) | null
	) : void;
	getAttributions( target? : Array<{ type: string, value: any }> ) : Array<{ type: string, value: any }>;

	addEventListener<T extends keyof TEventMap>(
		name : T,
		callback : ( event : TEventMap[ T ] & { type : T } ) => void
	) : void;
	addEventListener( name : string, callback : ( event : any ) => void ) : void;

	removeEventListener<T extends keyof TEventMap>(
		name : T,
		callback : ( event : TEventMap[ T ] & { type : T } ) => void
	) : void;
	removeEventListener( name : string, callback : ( event : any ) => void ) : void;

	hasEventListener<T extends keyof TEventMap>(
		name : T,
		callback : ( event : TEventMap[ T ] & { type : T } ) => void
	) : boolean;
	hasEventListener( name : string, callback : ( event : any ) => void ) : boolean;

	dispatchEvent<T extends keyof TEventMap>( event : TEventMap[ T ] & { type : T } ) : void;
	dispatchEvent( event : { type : string } ) : void;

	dispose() : void;
	resetFailedTiles() : void;

}