rayzee 11.1.0 → 11.2.0

package/src/Processor/ArchiveReader.js

@@ -546,8 +546,8 @@ export function createTarIndexer( { filter = null, sink = null } = {} ) {
  * @param {object} [options] - `filter` and `retain` as in readTar
  * @param {{listing: Array}} [options.index] - a saved index (`result.index`): skips the walk
  * @param {boolean} [options.headersOnly] - index by seeking between headers; nothing is retained
- * @returns {Promise<{entries, listing, read: (path:string)=>Promise<Uint8Array|null>, truncated,
- *   index: ?{v:number, listing:Array}}>}
+ * @returns {Promise<{entries, listing, read: (path:string)=>Promise<Uint8Array|null>,
+ *   slice: (path:string)=>Promise<Blob|null>, truncated, index: ?{v:number, listing:Array}}>}
  */
 export async function openTar( source, options = {} ) {
 
@@ -594,7 +594,50 @@ export async function openTar( source, options = {} ) {
 
 	};
 
-	return { entries, listing, read, readHead, retainedBytes, truncated, indexed: byPath.size, index: full ? { v: 1, listing: full } : null };
+	const slice = async ( path ) => {
+
+		if ( entries[ path ] ) return new Blob( [ entries[ path ] ] );
+		const e = byPath.get( path );
+		return e ? source.slice( e.offset, e.offset + e.size ) : null;
+
+	};
+
+	return { entries, listing, read, readHead, slice, retainedBytes, truncated, indexed: byPath.size, index: full ? { v: 1, listing: full } : null };
+
+}
+
+/**
+ * A folder on disk with the shape of `openTar` and `openZip`: every file is listed, and read only when asked for.
+ * @param {{files: Array<{path: string, file: Blob}>}} folder - from `localFolder`
+ * @param {{filter?: (path:string, size:number) => boolean}} [options]
+ */
+export function openFolder( folder, { filter = null } = {} ) {
+
+	const byPath = new Map();
+	const listing = folder.files.map( ( { path, file } ) => {
+
+		if ( filter && ! filter( path, file.size ) ) return { path, size: file.size };
+		byPath.set( path, file );
+		return { path, size: file.size, offset: 0 };
+
+	} );
+
+	const slice = async ( path ) => byPath.get( path ) ?? null;
+	const read = async ( path ) => {
+
+		const file = byPath.get( path );
+		return file ? new Uint8Array( await file.arrayBuffer() ) : null;
+
+	};
+
+	const readHead = async ( path, bytes ) => {
+
+		const file = byPath.get( path );
+		return file ? new Uint8Array( await file.slice( 0, bytes ).arrayBuffer() ) : null;
+
+	};
+
+	return { entries: Object.create( null ), listing, read, readHead, slice, retainedBytes: 0, truncated: false, indexed: byPath.size };
 
 }
 

package/src/Processor/AssetLoader.js

@@ -441,7 +441,32 @@ export class AssetLoader extends EventDispatcher {
 
 		} catch ( error ) {
 
-			this.dispatchEvent( { type: 'error', message: error.message, filename } );
+			if ( error?.code !== 'ARCHIVE_NEEDS_ELEMENT' ) this.dispatchEvent( { type: 'error', message: error.message, filename } );
+			throw error;
+
+		}
+
+	}
+
+	/**
+	 * Loads a folder's files as one model — read by the archive importer, as the same folder zipped would be.
+	 * @param {{name: string, files: Array<{path: string, file: Blob}>}} folder - from `localFolder`
+	 * @param {object} [options] - as loadAssetFromFile
+	 */
+	async loadFolder( folder, options = {} ) {
+
+		const archives = await this._archiveImporter();
+		if ( ! archives ) throw new Error( `${folder.name}: folders are read by ${ARCHIVES.addOn} — install it with ${ARCHIVES.install}` );
+
+		updateLoading( { isLoading: true, status: `Loading ${folder.name}...`, progress: 2 } );
+		try {
+
+			return await archives.loadFolder( folder, options );
+
+		} catch ( error ) {
+
+			if ( error?.code === 'ARCHIVE_NEEDS_ELEMENT' ) error.file = folder;
+			else this.dispatchEvent( { type: 'error', message: error.message, filename: folder.name } );
 			throw error;
 
 		}

package/src/Processor/archiveFormats.js

@@ -5,3 +5,38 @@ export const ARCHIVE_FORMATS = Object.freeze( {
 	'tgz': { type: 'archive', name: 'Gzipped TAR Archive' },
 	'tar': { type: 'archive', name: 'TAR Archive' },
 } );
+
+const isBlob = value => typeof Blob !== 'undefined' && value instanceof Blob;
+
+/** Whether `loadFile` was handed a folder (`{ files }`) rather than a File or a URL. */
+export const isFolderInput = input => !! input && typeof input === 'object' && ! isBlob( input ) && input.files != null;
+
+const hidden = segment => segment.startsWith( '.' ) || segment === '__MACOSX';
+
+/**
+ * A folder's files as `{ name, files: [{ path, file }] }`: paths '/'-separated and sorted, hidden files and folders
+ * left out. Each of `files` is a File, whose path is its `webkitRelativePath` (a folder picker sets it) or else its
+ * name, or `{ path, file }`. `name` defaults to the folder all paths share, else the first file `isModel` accepts.
+ * @param {{name?: string, files: Iterable<File|{path: string, file: Blob}>}} input
+ * @param {{isModel?: function(string): boolean}} [options]
+ */
+export function localFolder( { name = null, files }, { isModel = () => false } = {} ) {
+
+	const byPath = new Map();
+	for ( const item of files ) {
+
+		const file = isBlob( item ) ? item : item.file;
+		const raw = isBlob( item ) ? ( item.webkitRelativePath || item.name ) : item.path;
+		const path = String( raw ?? '' ).replace( /\\/g, '/' ).split( '/' ).filter( s => s && s !== '.' ).join( '/' );
+		if ( ! path || ! file || path.split( '/' ).some( hidden ) ) continue;
+		byPath.set( path, { path, file } );
+
+	}
+
+	const list = [ ...byPath.values() ].sort( ( a, b ) => ( a.path < b.path ? - 1 : a.path > b.path ? 1 : 0 ) );
+	const top = list[ 0 ]?.path.split( '/' )[ 0 ];
+	const shared = list.length > 0 && list.every( e => e.path.startsWith( top + '/' ) ) ? top : null;
+	const named = name ?? shared ?? ( list.find( e => isModel( e.path ) ) ?? list[ 0 ] )?.path.split( '/' ).pop() ?? 'Folder';
+	return { name: named, files: list, flat: shared === null && list.every( e => ! e.path.includes( '/' ) ) };
+
+}

package/src/RayzeeRenderer.js

@@ -20,7 +20,8 @@ import { EngineEvents, LEGACY_EVENT_NAMES } from './EngineEvents.js';
 import { IssueLog, ISSUE_CODES, EngineIssueError } from './EngineIssues.js';
 import { getAssetConfig, isAssetConfigured } from './AssetConfig.js';
 import { nameFromUrl } from './Storage/DownloadCache.js';
-import { fileIdentity, identityKey } from './Storage/identity.js';
+import { fileIdentity, folderIdentity, identityKey } from './Storage/identity.js';
+import { isFolderInput, localFolder } from './Processor/archiveFormats.js';
 import { SETTING_SOURCE } from './RenderSettings.js';
 import { toneMapToRGBA8 } from './Processor/ToneMapCPU.js';
 import { PackedToneMapper } from './Processor/ToneMapGPU.js';
@@ -209,7 +210,7 @@ export class RayzeeRenderer extends EventDispatcher {
 		if ( options.profile !== undefined ) {
 
 			throw new Error( 'the `profile` option was removed: the engine has one set of defaults. For the old \'physical\' '
-				+ 'profile set `areaLightIntensityScale: 1` and `dofMode: \'physical\'` through `settings`.' );
+				+ 'profile set `dofMode: \'physical\'` through `settings`.' );
 
 		}
 
@@ -714,7 +715,7 @@ export class RayzeeRenderer extends EventDispatcher {
 		this._storageRelease?.();
 		this._storageRelease = null;
 		this.storage = null;
-		this._sceneSource = this._sceneSourceFile = null;
+		this._sceneSource = this._sceneSourceInput = null;
 
 		this._issues.detach(); // onIssue captures `this`; see IssueLog.detach()
 
@@ -841,7 +842,7 @@ export class RayzeeRenderer extends EventDispatcher {
 		this._releaseSceneState();
 
 		this.assetLoader?.releaseTargetModel();
-		this._sceneSource = this._sceneSourceFile = null;
+		this._sceneSource = this._sceneSourceInput = null;
 
 		// Clear lights in the WebGPU light scene
 		this.lightManager?.clearLights?.();
@@ -963,7 +964,7 @@ export class RayzeeRenderer extends EventDispatcher {
 
 	/**
 	 * Loads a user-supplied File (drag-drop, file picker) — model, archive, or environment
-	 * map, dispatched by extension.
+	 * map, dispatched by extension — or a folder of files, read as the same folder zipped would be.
 	 *
 	 * Prefer this over driving `assetLoader.loadAssetFromFile()` directly. That bypasses the
 	 * in-progress guard, and AssetLoader disposes the outgoing model before it knows whether
@@ -972,7 +973,9 @@ export class RayzeeRenderer extends EventDispatcher {
 	 * tracer rendering buffers whose geometry has been freed. Here a concurrent call throws
 	 * LOAD_IN_PROGRESS before anything is touched.
 	 *
-	 * @param {File|string} file - a File, or a URL to download (through the download cache)
+	 * @param {File|string|{name?: string, files: Iterable<File|{path: string, file: Blob}>}} file - a File, a URL to
+	 *   download (through the download cache), or a folder: `{ files }` — a folder picker's FileList, whose files carry
+	 *   their `webkitRelativePath`, or `{ path, file }` pairs; `name` defaults to the folder they share
 	 * @param {object} [options] - forwarded to the archive loader: `element` to load one
 	 *   subtree of a multi-part scene, `pbrtEntry` to choose among several .pbrt scenes. For a
 	 *   URL also `filename` and `cacheKey` (see AssetLoader.loadAssetFromUrl).
@@ -998,6 +1001,25 @@ export class RayzeeRenderer extends EventDispatcher {
 
 		}
 
+		if ( isFolderInput( file ) ) {
+
+			const folder = localFolder( file, { isModel: path => this.assetLoader?.getFileFormat( path )?.type === 'model' } );
+			if ( folder.files.length === 0 ) throw new Error( `${folder.name} holds no files to load` );
+			await this._loadWithSceneRebuild(
+				() => this.assetLoader.loadFolder( folder, options ),
+				{ type: EngineEvents.MODEL_LOADED, filename: folder.name },
+				async () => {
+
+					const id = await folderIdentity( folder );
+					return { kind: 'local-folder', folder: id, key: identityKey( id ), ...( folder.flat ? { flat: true } : {} ), ...partOf( options ) };
+
+				}
+			);
+			this._sceneSourceInput = folder;
+			return;
+
+		}
+
 		const format = this.assetLoader?.getFileFormat( file?.name || '' );
 		if ( ! format ) throw this.assetLoader.formatError( file?.name || '' );
 
@@ -1014,7 +1036,7 @@ export class RayzeeRenderer extends EventDispatcher {
 
 				}
 			);
-			this._sceneSourceFile = file;
+			this._sceneSourceInput = file;
 			return;
 
 		}
@@ -1121,8 +1143,10 @@ export class RayzeeRenderer extends EventDispatcher {
 	/**
 	 * Where the model on screen came from, as plain data — what a saved session reopens:
 	 * `{ kind: 'url', url, cacheKey, filename?, element?, pbrtEntry? }`,
-	 * `{ kind: 'local-file', file: {name, size, lastModified, sample}, key, element?, pbrtEntry? }` or
-	 * `{ kind: 'object3d', name }`. Null before a load and after {@link unloadScene}.
+	 * `{ kind: 'local-file', file: {name, size, lastModified, sample}, key, element?, pbrtEntry? }`,
+	 * `{ kind: 'local-folder', folder: {name, size, lastModified, sample, files}, key, flat?, element?, pbrtEntry? }`
+	 * (`flat` when it was loose files rather than one folder) or `{ kind: 'object3d', name }`. Null before a load and
+	 * after {@link unloadScene}.
 	 * @returns {?Object}
 	 */
 	get sceneSource() {
@@ -1134,7 +1158,14 @@ export class RayzeeRenderer extends EventDispatcher {
 	/** The File a local load came from, so a host can save a project that carries it; null otherwise. */
 	get sceneSourceFile() {
 
-		return this._sceneSourceFile ?? null;
+		return this._sceneSourceInput && ! isFolderInput( this._sceneSourceInput ) ? this._sceneSourceInput : null;
+
+	}
+
+	/** The folder a local load came from, as `{ name, files: [{ path, file }] }`; null otherwise. */
+	get sceneSourceFolder() {
+
+		return isFolderInput( this._sceneSourceInput ) ? this._sceneSourceInput : null;
 
 	}
 
@@ -1149,7 +1180,7 @@ export class RayzeeRenderer extends EventDispatcher {
 
 			await loadFn();
 			this._sceneSource = typeof source === 'function' ? await source() : source;
-			this._sceneSourceFile = null;
+			this._sceneSourceInput = null;
 			// A fresh model re-establishes the emissive-sampling auto-default (incremental
 			// rebuilds — add/remove object, texture reprocess — preserve the user's choice).
 			this._emissiveSamplingUserSet = false;
@@ -1196,7 +1227,7 @@ export class RayzeeRenderer extends EventDispatcher {
 	 */
 	_discardFailedLoad() {
 
-		this._sceneSource = this._sceneSourceFile = null;
+		this._sceneSource = this._sceneSourceInput = null;
 
 		try {
 

package/src/Storage/identity.js

@@ -64,9 +64,30 @@ export async function fileIdentity( file ) {
 
 }
 
+/**
+ * A folder's identity: its name, total size, newest change and a SHA-256 over every file's path, size and date. Reads
+ * no file, and changes with any change inside the folder.
+ * @param {{name: string, files: Array<{path: string, file: Blob}>}} folder - from `localFolder`
+ * @returns {Promise<{name: string, size: number, lastModified: number, sample: string, files: number}>}
+ */
+export async function folderIdentity( folder ) {
+
+	let size = 0;
+	let lastModified = 0;
+	const lines = folder.files.map( ( { path, file } ) => {
+
+		size += file.size;
+		lastModified = Math.max( lastModified, file.lastModified ?? 0 );
+		return `${path}|${file.size}|${file.lastModified ?? 0}`;
+
+	} );
+	return { name: folder.name, size, lastModified, sample: await sha256Hex( lines.join( '\n' ) ), files: folder.files.length };
+
+}
+
 export function identityKey( identity ) {
 
-	return `file:${identity.name}|${identity.size}|${identity.lastModified}|${identity.sample}`;
+	return `${identity.files === undefined ? 'file' : 'folder'}:${identity.name}|${identity.size}|${identity.lastModified}|${identity.sample}`;
 
 }
 

package/src/Storage/index.js

@@ -3,7 +3,7 @@ export {
 } from './StorageManager.js';
 export { openStorage, acquireSharedStorage } from './openStorage.js';
 export { sharedStorage } from './shared.js';
-export { fileIdentity, identityKey, sameIdentity, sampleHash, sha256Hex } from './identity.js';
+export { fileIdentity, folderIdentity, identityKey, sameIdentity, sampleHash, sha256Hex } from './identity.js';
 export { DownloadCache, DOWNLOAD_POLICY, fetchFile, nameFromUrl, cachedObjectURL, sharedDownloads } from './DownloadCache.js';
 export { acquireLock, heldLockNames } from './locks.js';
 export { SpillStore } from './SpillStore.js';

package/src/TSL/MaterialEvaluation.js

@@ -108,9 +108,9 @@ const makeEvaluateMaterialResponse = ( deltaOnly ) => Fn( ( [ material, dots ],
 		} ).ElseIf( material.roughness.greaterThan( 0.0 ), isotropic );
 		else If( material.roughness.greaterThan( 0.0 ), isotropic );
 
-		// Compensation factor and total directional albedo from the same table fetch.
+		// Metalness 0: the diffuse lobe loses only the non-metal share's albedo; (1 − metalness) below removes the metal's.
 		const dfg = DFGResult.wrap( evaluateSpecularDFG(
-			bf.f0, bf.f90, bf.eta, bf.F0m, material.metalness, iridF, material.iridescence, F0,
+			bf.f0, bf.f90, bf.eta, bf.F0m, float( 0.0 ), iridF, material.iridescence, F0,
 			dots.NoV, material.roughness,
 		) );
 		const specular = ( deltaOnly ? F : specularSS ).mul( dfg.compensation );
@@ -210,8 +210,9 @@ export const evaluateDiffuseTransmission = Fn( ( [ material, NoV ], builder ) =>
 				F0.assign( mix( F0, iridF, material.iridescence ) );
 
 			} );
+			// Metalness 0, as for the reflected diffuse lobe.
 			const dfg = DFGResult.wrap( evaluateSpecularDFG(
-				bf.f0, bf.f90, bf.eta, bf.F0m, material.metalness, iridF, material.iridescence, F0,
+				bf.f0, bf.f90, bf.eta, bf.F0m, float( 0.0 ), iridF, material.iridescence, F0,
 				NoV, material.roughness,
 			) );
 			kD.mulAssign( vec3( 1.0 ).sub( dfg.E_total ) );

package/src/core.js

@@ -22,7 +22,7 @@ export { configureAssets, getAssetConfig } from './AssetConfig.js';
 export { configurePlatform, getPlatform } from './Platform.js';
 export { LightManager } from './managers/LightManager.js';
 export { listViewTransforms, getViewTransform, onRegistryChange, DEFAULT_VIEW } from './Color/ViewTransforms.js';
-export { ARCHIVE_FORMATS } from './Processor/archiveFormats.js';
+export { ARCHIVE_FORMATS, localFolder } from './Processor/archiveFormats.js';
 export { ENGINE_DEFAULTS, MATERIAL_DEFAULTS } from './EngineDefaults.js';
 export { SKY_DEFAULTS } from './managers/EnvironmentManager.js';
 export { MAX_RESERVABLE_RENDER_SIZE } from './Processor/StorageTexturePool.js';

package/src/index.js

@@ -30,13 +30,13 @@ export { configurePlatform, getPlatform } from './Platform.js';
 
 // On-disk storage (origin private file system): caches, and areas a host defines for its own data
 export {
-	openStorage, StorageManager, STORAGE_KIND, ENGINE_AREAS, fileIdentity, identityKey, sameIdentity,
+	openStorage, StorageManager, STORAGE_KIND, ENGINE_AREAS, fileIdentity, folderIdentity, identityKey, sameIdentity,
 	DownloadCache, DOWNLOAD_POLICY, fetchFile, nameFromUrl, cachedObjectURL, acquireLock, heldLockNames,
 } from './Storage/index.js';
 
 // Archives read in place: one entry at a time, never the whole file in memory
 export { openZip, readZipDirectory } from './Processor/ZipReader.js';
-export { ARCHIVE_FORMATS } from './Processor/archiveFormats.js';
+export { ARCHIVE_FORMATS, localFolder } from './Processor/archiveFormats.js';
 
 // Engine package version, as built
 export { VERSION } from './version.js';

package/dist/archiveFormats-tnAoUL1j.js

@@ -1,94 +0,0 @@
-//#region src/Processor/SceneMetadata.js
-var e = [
-	"sourceFile",
-	"url",
-	"file"
-];
-function t(e) {
-	if (typeof e == "string") try {
-		let t = JSON.parse(e);
-		return t && typeof t == "object" ? t : null;
-	} catch {
-		return null;
-	}
-	return e && typeof e == "object" ? e : null;
-}
-function n(e) {
-	let t = typeof e == "string" ? parseFloat(e) : e;
-	return Number.isFinite(t) ? t : void 0;
-}
-function r(e) {
-	let n = t(e);
-	if (!n) return null;
-	let r = (e) => e && (e.environment !== void 0 || e.render !== void 0), i = t(n.rayzee);
-	return r(i) ? i : r(n) ? n : null;
-}
-function i(r) {
-	let i = t(r);
-	if (!i) return null;
-	let a = e.map((e) => i[e]).find((e) => typeof e == "string" && e.trim());
-	if (!a) return null;
-	let o = n(i.rotation), s = n(i.intensity), c = { sourceFile: a.trim() };
-	return o !== void 0 && (c.rotation = o), s !== void 0 && (c.intensity = Math.max(0, s)), c;
-}
-var a = [
-	"maxBounces",
-	"samples",
-	"width",
-	"height"
-];
-function o(e) {
-	let r = t(e);
-	if (!r) return null;
-	let i = {};
-	for (let e of a) {
-		let t = n(r[e]);
-		t !== void 0 && t > 0 && (i[e] = Math.round(t));
-	}
-	return Object.keys(i).length ? i : null;
-}
-function s(e) {
-	let t = r(e);
-	if (!t) return null;
-	let n = i(t.environment), a = o(t.render);
-	return !n && !a ? null : {
-		...n ? { environment: n } : {},
-		...a ? { render: a } : {}
-	};
-}
-function c(e) {
-	if (!e) return null;
-	let t = [
-		e.userData,
-		e.asset?.extras,
-		e.scene?.userData
-	];
-	Array.isArray(e.scenes) && t.push(...e.scenes.map((e) => e?.userData));
-	for (let e of t) {
-		let t = s(e);
-		if (t) return t;
-	}
-	return null;
-}
-//#endregion
-//#region src/Processor/archiveFormats.js
-var l = Object.freeze({
-	zip: {
-		type: "archive",
-		name: "ZIP Archive"
-	},
-	gz: {
-		type: "archive",
-		name: "Gzipped TAR Archive"
-	},
-	tgz: {
-		type: "archive",
-		name: "Gzipped TAR Archive"
-	},
-	tar: {
-		type: "archive",
-		name: "TAR Archive"
-	}
-});
-//#endregion
-export { c as n, s as r, l as t };