easy-three-utils 0.0.1

package/src/tileRenderer/base/Tileset.d.ts

@@ -0,0 +1,66 @@
+import { TileBase } from './TileBase';
+
+/**
+ * A 3d-tiles tileset.
+ *
+ * Schema, see: https://github.com/CesiumGS/3d-tiles/blob/main/specification/schema/tileset.schema.json
+ */
+export interface Tileset {
+
+	/**
+	 * Metadata about the entire tileset.
+	 */
+	asset: {
+
+		/**
+		 * 3d-tiles version
+		 */
+		version: string,
+
+		/**
+		 * Application specific version
+		 */
+		tilesetVersion?: string,
+
+		/**
+		 * Dictionary object with extension-specific objects.
+		 */
+		extensions? : Record<string, any>,
+
+	};
+
+	/**
+	 * The error, in meters, introduced if this tileset is not rendered. At runtime, the geometric error is used to compute screen space error (SSE), i.e., the error measured in pixels.
+	 */
+	geometricError: Number;
+
+	/**
+	 * The root tile.
+	 */
+	root: TileBase;
+
+	// optional properties
+
+	/**
+	 * Names of 3D Tiles extensions used somewhere in this tileset.
+	 */
+	extensionsUsed?: string[];
+
+	/**
+	 * Names of 3D Tiles extensions required to properly load this tileset.
+	 */
+	extensionsRequired?: string[];
+
+	/**
+	 * A dictionary object of metadata about per-feature properties.
+	 */
+	properties?: Record<string, any>;
+
+	/**
+	 * Dictionary object with extension-specific objects.
+	 */
+	extensions? : Record<string, any>;
+
+	extras? : Record<string, any>;
+
+}

package/src/tileRenderer/base/constants.d.ts

@@ -0,0 +1,6 @@
+export const WGS84_RADIUS;
+export const WGS84_FLATTENING;
+export const WGS84_HEIGHT;
+
+export const LUNAR_RADIUS;
+export const LUNAR_HEIGHT;

package/src/tileRenderer/base/constants.js

@@ -0,0 +1,16 @@
+// FAILED is negative so lru cache priority sorting will unload it first
+export const FAILED = - 1;
+export const UNLOADED = 0;
+export const LOADING = 1;
+export const PARSING = 2;
+export const LOADED = 3;
+
+// https://en.wikipedia.org/wiki/World_Geodetic_System
+// https://en.wikipedia.org/wiki/Flattening
+export const WGS84_RADIUS = 6378137;
+export const WGS84_FLATTENING = 1 / 298.257223563;
+export const WGS84_HEIGHT = - ( WGS84_FLATTENING * WGS84_RADIUS - WGS84_RADIUS );
+
+// https://nssdc.gsfc.nasa.gov/planetary/factsheet/moonfact.html
+export const LUNAR_HEIGHT = 1736.0 * 1e3;
+export const LUNAR_RADIUS = 1738.1 * 1e3;

package/src/tileRenderer/base/loaders/B3DMLoaderBase.d.ts

@@ -0,0 +1,18 @@
+import { BatchTable } from '../../utilities/BatchTable';
+import { FeatureTable } from '../../utilities/FeatureTable';
+
+export interface B3DMBaseResult {
+
+	version : String;
+	featureTable: FeatureTable;
+	batchTable : BatchTable;
+	glbBytes : Uint8Array;
+
+}
+
+export class B3DMLoaderBase {
+
+	load( url : string ) : Promise< B3DMBaseResult >;
+	parse( buffer : ArrayBuffer ) : B3DMBaseResult;
+
+}

package/src/tileRenderer/base/loaders/B3DMLoaderBase.js

@@ -0,0 +1,85 @@
+// B3DM File Format
+// https://github.com/CesiumGS/3d-tiles/blob/master/specification/TileFormats/Batched3DModel/README.md
+
+import { BatchTable } from '../../utilities/BatchTable.js';
+import { FeatureTable } from '../../utilities/FeatureTable.js';
+import { LoaderBase } from './LoaderBase.js';
+import { readMagicBytes } from '../../utilities/readMagicBytes.js';
+
+export class B3DMLoaderBase extends LoaderBase {
+
+	parse( buffer ) {
+
+		// TODO: this should be able to take a uint8array with an offset and length
+		const dataView = new DataView( buffer );
+
+		// 28-byte header
+
+		// 4 bytes
+		const magic = readMagicBytes( dataView );
+
+		console.assert( magic === 'b3dm' );
+
+		// 4 bytes
+		const version = dataView.getUint32( 4, true );
+
+		console.assert( version === 1 );
+
+		// 4 bytes
+		const byteLength = dataView.getUint32( 8, true );
+
+		console.assert( byteLength === buffer.byteLength );
+
+		// 4 bytes
+		const featureTableJSONByteLength = dataView.getUint32( 12, true );
+
+		// 4 bytes
+		const featureTableBinaryByteLength = dataView.getUint32( 16, true );
+
+		// 4 bytes
+		const batchTableJSONByteLength = dataView.getUint32( 20, true );
+
+		// 4 bytes
+		const batchTableBinaryByteLength = dataView.getUint32( 24, true );
+
+		// Feature Table
+		const featureTableStart = 28;
+		const featureTableBuffer = buffer.slice(
+			featureTableStart,
+			featureTableStart + featureTableJSONByteLength + featureTableBinaryByteLength,
+		);
+		const featureTable = new FeatureTable(
+			featureTableBuffer,
+			0,
+			featureTableJSONByteLength,
+			featureTableBinaryByteLength,
+		);
+
+		// Batch Table
+		const batchTableStart = featureTableStart + featureTableJSONByteLength + featureTableBinaryByteLength;
+		const batchTableBuffer = buffer.slice(
+			batchTableStart,
+			batchTableStart + batchTableJSONByteLength + batchTableBinaryByteLength,
+		);
+		const batchTable = new BatchTable(
+			batchTableBuffer,
+			featureTable.getData( 'BATCH_LENGTH' ),
+			0,
+			batchTableJSONByteLength,
+			batchTableBinaryByteLength,
+		);
+
+		const glbStart = batchTableStart + batchTableJSONByteLength + batchTableBinaryByteLength;
+		const glbBytes = new Uint8Array( buffer, glbStart, byteLength - glbStart );
+
+		return {
+			version,
+			featureTable,
+			batchTable,
+			glbBytes,
+		};
+
+	}
+
+}
+

package/src/tileRenderer/base/loaders/CMPTLoaderBase.d.ts

@@ -0,0 +1,22 @@
+interface TileInfo {
+
+	type : String;
+	buffer : Uint8Array;
+	version : String;
+
+}
+
+export interface CMPTBaseResult {
+
+	version : String;
+	tiles : Array< TileInfo >;
+
+}
+
+export class CMPTLoaderBase {
+
+	workingPath : string;
+	load( url : String ) : Promise< CMPTBaseResult >;
+	parse( buffer : ArrayBuffer ) : CMPTBaseResult;
+
+}

package/src/tileRenderer/base/loaders/CMPTLoaderBase.js

@@ -0,0 +1,61 @@
+// CMPT File Format
+// https://github.com/CesiumGS/3d-tiles/blob/master/specification/TileFormats/Composite/README.md
+import { LoaderBase } from './LoaderBase.js';
+import { readMagicBytes } from '../../utilities/readMagicBytes.js';
+
+export class CMPTLoaderBase extends LoaderBase {
+
+	parse( buffer ) {
+
+		const dataView = new DataView( buffer );
+
+		// 16-byte header
+
+		// 4 bytes
+		const magic = readMagicBytes( dataView );
+
+		console.assert( magic === 'cmpt', 'CMPTLoader: The magic bytes equal "cmpt".' );
+
+		// 4 bytes
+		const version = dataView.getUint32( 4, true );
+
+		console.assert( version === 1, 'CMPTLoader: The version listed in the header is "1".' );
+
+		// 4 bytes
+		const byteLength = dataView.getUint32( 8, true );
+
+		console.assert( byteLength === buffer.byteLength, 'CMPTLoader: The contents buffer length listed in the header matches the file.' );
+
+		// 4 bytes
+		const tilesLength = dataView.getUint32( 12, true );
+
+		const tiles = [];
+		let offset = 16;
+		for ( let i = 0; i < tilesLength; i ++ ) {
+
+			const tileView = new DataView( buffer, offset, 12 );
+			const tileMagic = readMagicBytes( tileView );
+			const tileVersion = tileView.getUint32( 4, true );
+			const byteLength = tileView.getUint32( 8, true );
+
+			const tileBuffer = new Uint8Array( buffer, offset, byteLength );
+			tiles.push( {
+
+				type: tileMagic,
+				buffer: tileBuffer,
+				version: tileVersion,
+
+			} );
+			offset += byteLength;
+
+		}
+
+		return {
+			version,
+			tiles,
+		};
+
+	}
+
+}
+

package/src/tileRenderer/base/loaders/I3DMLoaderBase.d.ts

@@ -0,0 +1,21 @@
+import { BatchTable } from '../../utilities/BatchTable';
+import { FeatureTable } from '../../utilities/FeatureTable';
+
+export interface I3DMBaseResult {
+
+	version : String;
+	featureTable: FeatureTable;
+	batchTable : BatchTable;
+	glbBytes : Uint8Array;
+
+}
+
+export class I3DMLoaderBase {
+
+	workingPath : string;
+
+	resolveExternalURL( url : string ) : string;
+	load( url : string ) : Promise< I3DMBaseResult >;
+	parse( buffer : ArrayBuffer ) : Promise< I3DMBaseResult >;
+
+}

package/src/tileRenderer/base/loaders/I3DMLoaderBase.js

@@ -0,0 +1,130 @@
+// I3DM File Format
+// https://github.com/CesiumGS/3d-tiles/blob/master/specification/TileFormats/Instanced3DModel/README.md
+
+import { BatchTable } from '../../utilities/BatchTable.js';
+import { FeatureTable } from '../../utilities/FeatureTable.js';
+import { arrayToString } from '../../utilities/arrayToString.js';
+import { LoaderBase } from './LoaderBase.js';
+import { readMagicBytes } from '../../utilities/readMagicBytes.js';
+
+export class I3DMLoaderBase extends LoaderBase {
+
+	parse( buffer ) {
+
+		const dataView = new DataView( buffer );
+
+		// 32-byte header
+
+		// 4 bytes
+		const magic = readMagicBytes( dataView );
+
+		console.assert( magic === 'i3dm' );
+
+		// 4 bytes
+		const version = dataView.getUint32( 4, true );
+
+		console.assert( version === 1 );
+
+		// 4 bytes
+		const byteLength = dataView.getUint32( 8, true );
+
+		console.assert( byteLength === buffer.byteLength );
+
+		// 4 bytes
+		const featureTableJSONByteLength = dataView.getUint32( 12, true );
+
+		// 4 bytes
+		const featureTableBinaryByteLength = dataView.getUint32( 16, true );
+
+		// 4 bytes
+		const batchTableJSONByteLength = dataView.getUint32( 20, true );
+
+		// 4 bytes
+		const batchTableBinaryByteLength = dataView.getUint32( 24, true );
+
+		// 4 bytes
+		const gltfFormat = dataView.getUint32( 28, true );
+
+		// Feature Table
+		const featureTableStart = 32;
+		const featureTableBuffer = buffer.slice(
+			featureTableStart,
+			featureTableStart + featureTableJSONByteLength + featureTableBinaryByteLength,
+		);
+		const featureTable = new FeatureTable(
+			featureTableBuffer,
+			0,
+			featureTableJSONByteLength,
+			featureTableBinaryByteLength,
+		);
+
+		// Batch Table
+		const batchTableStart = featureTableStart + featureTableJSONByteLength + featureTableBinaryByteLength;
+		const batchTableBuffer = buffer.slice(
+			batchTableStart,
+			batchTableStart + batchTableJSONByteLength + batchTableBinaryByteLength,
+		);
+		const batchTable = new BatchTable(
+			batchTableBuffer,
+			featureTable.getData( 'INSTANCES_LENGTH' ),
+			0,
+			batchTableJSONByteLength,
+			batchTableBinaryByteLength,
+		);
+
+		const glbStart = batchTableStart + batchTableJSONByteLength + batchTableBinaryByteLength;
+		const bodyBytes = new Uint8Array( buffer, glbStart, byteLength - glbStart );
+
+		let glbBytes = null;
+		let promise = null;
+		let gltfWorkingPath = null;
+		if ( gltfFormat ) {
+
+			glbBytes = bodyBytes;
+			promise = Promise.resolve();
+
+		} else {
+
+			const externalUri = this.resolveExternalURL( arrayToString( bodyBytes ) );
+
+			//Store the gltf working path
+			const uriSplits = externalUri.split( /[\\/]/g );
+			uriSplits.pop();
+			gltfWorkingPath = uriSplits.join( '/' );
+
+			promise = fetch( externalUri, this.fetchOptions )
+				.then( res => {
+
+					if ( ! res.ok ) {
+
+						throw new Error( `I3DMLoaderBase : Failed to load file "${ externalUri }" with status ${ res.status } : ${ res.statusText }` );
+
+					}
+
+					return res.arrayBuffer();
+
+				} )
+				.then( buffer => {
+
+					glbBytes = new Uint8Array( buffer );
+
+				} );
+
+		}
+
+		return promise.then( () => {
+
+			return {
+				version,
+				featureTable,
+				batchTable,
+				glbBytes,
+				gltfWorkingPath
+			};
+
+		} );
+
+	}
+
+}
+

package/src/tileRenderer/base/loaders/LoaderBase.d.ts

@@ -0,0 +1,10 @@
+export class LoaderBase {
+
+	fetchOptions: any;
+	workingPath: string;
+	load( url: string ): Promise< any >;
+	resolveExternalURL( url: string ): string;
+	workingPathForURL( url: string ): string
+	parse( buffer: ArrayBuffer ): Promise< any >;
+
+}

package/src/tileRenderer/base/loaders/LoaderBase.js

@@ -0,0 +1,73 @@
+export class LoaderBase {
+
+	constructor() {
+
+		this.fetchOptions = {};
+		this.workingPath = '';
+
+	}
+
+	load( url ) {
+
+		console.warn( 'Loader: "load" function has been deprecated in favor of "loadAsync".' );
+		return this.loadAsync( url );
+
+	}
+
+	loadAsync( url ) {
+
+		return fetch( url, this.fetchOptions )
+			.then( res => {
+
+				if ( ! res.ok ) {
+
+					throw new Error( `Failed to load file "${ url }" with status ${ res.status } : ${ res.statusText }` );
+
+				}
+				return res.arrayBuffer();
+
+			} )
+			.then( buffer => {
+
+				if ( this.workingPath === '' ) {
+
+					this.workingPath = this.workingPathForURL( url );
+
+				}
+
+				return this.parse( buffer );
+
+			} );
+
+	}
+
+	resolveExternalURL( url ) {
+
+		if ( /^[^\\/]/.test( url ) && ! /^http/.test( url ) ) {
+
+			return this.workingPath + '/' + url;
+
+		} else {
+
+			return url;
+
+		}
+
+	}
+
+	workingPathForURL( url ) {
+
+		const splits = url.split( /[\\/]/g );
+		splits.pop();
+		const workingPath = splits.join( '/' );
+		return workingPath + '/';
+
+	}
+
+	parse( buffer ) {
+
+		throw new Error( 'LoaderBase: Parse not implemented.' );
+
+	}
+
+}

package/src/tileRenderer/base/loaders/PNTSLoaderBase.d.ts

@@ -0,0 +1,17 @@
+import { BatchTable } from '../../utilities/BatchTable';
+import { FeatureTable } from '../../utilities/FeatureTable';
+
+export interface PNTSBaseResult {
+
+	version : String;
+	featureTable: FeatureTable;
+	batchTable : BatchTable;
+
+}
+
+export class PNTSLoaderBase {
+
+	load( url : string ) : Promise< PNTSBaseResult >;
+	parse( buffer : ArrayBuffer ) : Promise< PNTSBaseResult >;
+
+}

package/src/tileRenderer/base/loaders/PNTSLoaderBase.js

@@ -0,0 +1,82 @@
+// PNTS File Format
+// https://github.com/CesiumGS/3d-tiles/blob/master/specification/TileFormats/PointCloud/README.md
+
+import { BatchTable } from '../../utilities/BatchTable.js';
+import { FeatureTable } from '../../utilities/FeatureTable.js';
+import { readMagicBytes } from '../../utilities/readMagicBytes.js';
+import { LoaderBase } from './LoaderBase.js';
+
+export class PNTSLoaderBase extends LoaderBase {
+
+	parse( buffer ) {
+
+		const dataView = new DataView( buffer );
+
+		// 28-byte header
+
+		// 4 bytes
+		const magic = readMagicBytes( dataView );
+
+		console.assert( magic === 'pnts' );
+
+		// 4 bytes
+		const version = dataView.getUint32( 4, true );
+
+		console.assert( version === 1 );
+
+		// 4 bytes
+		const byteLength = dataView.getUint32( 8, true );
+
+		console.assert( byteLength === buffer.byteLength );
+
+		// 4 bytes
+		const featureTableJSONByteLength = dataView.getUint32( 12, true );
+
+		// 4 bytes
+		const featureTableBinaryByteLength = dataView.getUint32( 16, true );
+
+		// 4 bytes
+		const batchTableJSONByteLength = dataView.getUint32( 20, true );
+
+		// 4 bytes
+		const batchTableBinaryByteLength = dataView.getUint32( 24, true );
+
+		// Feature Table
+		const featureTableStart = 28;
+		const featureTableBuffer = buffer.slice(
+			featureTableStart,
+			featureTableStart + featureTableJSONByteLength + featureTableBinaryByteLength,
+		);
+		const featureTable = new FeatureTable(
+			featureTableBuffer,
+			0,
+			featureTableJSONByteLength,
+			featureTableBinaryByteLength,
+		);
+
+		// Batch Table
+		const batchTableStart = featureTableStart + featureTableJSONByteLength + featureTableBinaryByteLength;
+		const batchTableBuffer = buffer.slice(
+			batchTableStart,
+			batchTableStart + batchTableJSONByteLength + batchTableBinaryByteLength,
+		);
+		const batchTable = new BatchTable(
+			batchTableBuffer,
+			featureTable.getData( 'BATCH_LENGTH' ) || featureTable.getData( 'POINTS_LENGTH' ),
+			0,
+			batchTableJSONByteLength,
+			batchTableBinaryByteLength,
+		);
+
+		return Promise.resolve( {
+
+			version,
+			featureTable,
+			batchTable,
+
+		} );
+
+	}
+
+}
+

package/src/tileRenderer/base/plugins/ImplicitTilingPlugin.js

@@ -0,0 +1,12 @@
+import { ImplicitTilingPlugin as ImplicitTilingPluginImpl } from '../../plugins/index.js';
+
+export class ImplicitTilingPlugin extends ImplicitTilingPluginImpl {
+
+	constructor() {
+
+		super();
+		console.warn( 'ImplicitTilingPlugin: Plugins should now be imported from "3d-tiles-renderer/plugins" path.' );
+
+	}
+
+}