@needle-tools/engine 4.6.2 → 4.7.0-next.2756168

package/src/engine-components/export/usdz/ThreeUSDZExporter.ts

@@ -32,7 +32,8 @@ import {
 	Vector3,
 	Vector4,
 	WebGLRenderer,
-	WebGLRenderTarget} from 'three';
+	WebGLRenderTarget
+} from 'three';
 import * as fflate from 'three/examples/jsm/libs/fflate.module.js';
 
 import { VERSION } from "../../../engine/engine_constants.js";
@@ -42,6 +43,9 @@ import { BehaviorExtension } from '../../api.js';
 import type { IUSDExporterExtension } from './Extension.js';
 import type { AnimationExtension } from './extensions/Animation.js';
 import type { PhysicsExtension } from './extensions/behavior/PhysicsExtension.js';
+import {buildNodeMaterial} from './extensions/NodeMaterialConverter.js';
+
+type MeshPhysicalNodeMaterial = import("three/src/materials/nodes/MeshPhysicalNodeMaterial.js").default;
 
 function makeNameSafe( str ) {
 	// Remove characters that are not allowed in USD ASCII identifiers
@@ -148,7 +152,7 @@ class USDObject {
 	get isDynamic() { return this._isDynamic; }
 	private set isDynamic( value ) { this._isDynamic = value; }
 	geometry: BufferGeometry | null;
-	material: MeshStandardMaterial | MeshBasicMaterial | Material | null;
+	material: MeshStandardMaterial | MeshBasicMaterial | Material | MeshPhysicalNodeMaterial | null;
 	camera: PerspectiveCamera | OrthographicCamera | null;
 	parent: USDObject | null;
 	skinnedMesh: SkinnedMesh | null;
@@ -180,7 +184,7 @@ class USDObject {
 		return empty;
 	}
 
-	constructor( id, name, transform: USDObjectTransform | null = null, mesh: BufferGeometry | null = null, material: MeshStandardMaterial | MeshBasicMaterial | Material | null = null, camera: PerspectiveCamera | OrthographicCamera | null = null, skinnedMesh: SkinnedMesh | null = null, animations: AnimationClip[] | null = null ) {
+	constructor( id, name, transform: USDObjectTransform | null = null, mesh: BufferGeometry | null = null, material: MeshStandardMaterial | MeshBasicMaterial | MeshPhysicalNodeMaterial | Material | null = null, camera: PerspectiveCamera | OrthographicCamera | null = null, skinnedMesh: SkinnedMesh | null = null, animations: AnimationClip[] | null = null ) {
 
 		this.uuid = id;
 		this.name = makeNameSafe( name );
@@ -847,14 +851,16 @@ function traverse( object: Object3D, parentModel: USDObject, context: USDZExport
 	}
 
 	if ( (object instanceof Mesh || object instanceof SkinnedMesh) && 
-		material &&
+		material && typeof material === 'object' &&
 			(material instanceof MeshStandardMaterial || 
-			material instanceof MeshBasicMaterial ||
+			material instanceof MeshBasicMaterial || 
+			// material instanceof MeshPhysicalNodeMaterial ||
+			(material as any).isMeshPhysicalNodeMaterial  ||
 			(material instanceof Material && material.type === "MeshLineMaterial"))) {
 
 		const name = getObjectId( object );
 		const skinnedMeshObject = object instanceof SkinnedMesh ? object : null;
-		model = new USDObject( object.uuid, name, transform, geometry, material, undefined, skinnedMeshObject, object.animations );
+		model = new USDObject( object.uuid, name, transform, geometry, material as any, undefined, skinnedMeshObject, object.animations );
 
 	} else if ( object instanceof PerspectiveCamera || object instanceof OrthographicCamera ) {
 
@@ -1966,6 +1972,137 @@ ${array.join( '' )}
 /** Slot of the exported texture. Some slots (e.g. normal, opacity) require additional processing. */
 declare type MapType = 'diffuse' | 'normal' | 'occlusion' | 'opacity' | 'roughness' | 'emissive' | 'metallic' | 'transmission';
 
+function texName(tex: Texture) {
+	// If we have a source, we only want to use the source's id, not the texture's id
+	// to avoid exporting the same underlying data multiple times.
+	return makeNameSafe(tex.name) + '_' + (tex.source?.id ?? tex.id);
+}
+
+function buildTexture( texture: Texture, mapType: MapType, quickLookCompatible: boolean, textures: TextureMap, material, usedUVChannels, color: Color | undefined = undefined, opacity: number | undefined = undefined ) {
+
+	const name = texName(texture);
+	// File names need to be unique; so when we're baking color and/or opacity into a texture we need to keep track of that.
+	// TODO This currently results in textures potentially being exported multiple times that are actually identical!
+	// const colorHex = color ? color.getHexString() : undefined;
+	// const colorId = ( color && colorHex != 'ffffff' ? '_' + color.getHexString() : '' );
+	const id = name + ( opacity !== undefined && opacity !== 1.0 ? '_' + opacity : '' );
+
+	// Seems neither QuickLook nor usdview support scale/bias on .a values, so we need to bake opacity multipliers into
+	// the texture. This is not ideal.
+	const opacityIsAppliedToTextureAndNotAsScale = quickLookCompatible && opacity !== undefined && opacity !== 1.0;
+	const scaleToApply = opacityIsAppliedToTextureAndNotAsScale ? new Vector4(1, 1, 1, opacity) : undefined;
+
+	// Treat undefined opacity as 1
+	if (opacity === undefined)
+		opacity = 1.0;
+
+	// When we're baking opacity into the texture, we shouldn't apply it as scale as well – so we set it to 1.
+	if (opacityIsAppliedToTextureAndNotAsScale)
+		opacity = 1.0;
+
+	// sanitize scaleToApply.w === 0 - this isn't working right now, seems the PNG can't be read back properly.
+	if (scaleToApply && scaleToApply.w <= 0.05) scaleToApply.w = 0.05;
+
+	textures[ id ] = { texture, scale: scaleToApply };
+
+	const uv = texture.channel > 0 ? 'st' + texture.channel : 'st';
+	usedUVChannels.add(texture.channel);
+
+	const isRGBA = formatsWithAlphaChannel.includes( texture.format );
+
+	const WRAPPINGS = {
+		1000: 'repeat', // RepeatWrapping
+		1001: 'clamp', // ClampToEdgeWrapping
+		1002: 'mirror' // MirroredRepeatWrapping
+	};
+
+	const repeat = texture.repeat.clone();
+	const offset = texture.offset.clone();
+	const rotation = texture.rotation;
+
+	// rotation is around the wrong point. after rotation we need to shift offset again so that we're rotating around the right spot
+	const xRotationOffset = Math.sin(rotation);
+	const yRotationOffset = Math.cos(rotation);
+
+	// texture coordinates start in the opposite corner, need to correct
+	offset.y = 1 - offset.y - repeat.y;
+
+	// turns out QuickLook is buggy and interprets texture repeat inverted.
+	// Apple Feedback: 	FB10036297 and FB11442287
+	if ( quickLookCompatible ) {
+
+		// This is NOT correct yet in QuickLook, but comes close for a range of models.
+		// It becomes more incorrect the bigger the offset is
+
+		// sanitize repeat values to avoid NaNs
+		if (repeat.x === 0) repeat.x = 0.0001;
+		if (repeat.y === 0) repeat.y = 0.0001;
+
+		offset.x = offset.x / repeat.x;
+		offset.y = offset.y / repeat.y;
+
+		offset.x += xRotationOffset / repeat.x;
+		offset.y += yRotationOffset - 1;
+	}
+
+	else {
+
+		// results match glTF results exactly. verified correct in usdview.
+		offset.x += xRotationOffset * repeat.x;
+		offset.y += (1 - yRotationOffset) * repeat.y;
+
+	}
+
+	const materialName = getMaterialName(material);
+
+	const needsTextureTransform = ( repeat.x != 1 || repeat.y != 1 || offset.x != 0 || offset.y != 0 || rotation != 0 );
+	const textureTransformInput = `${materialRoot}/${materialName}/${'uvReader_' + uv}.outputs:result>`;		const textureTransformOutput = `${materialRoot}/${materialName}/Transform2d_${mapType}.outputs:result>`;
+	const needsTextureScale = mapType !== 'normal' && (color && (color.r !== 1 || color.g !== 1 || color.b !== 1 || opacity !== 1)) || false;
+
+	const needsNormalScaleAndBias = mapType === 'normal';
+	const normalScale = material instanceof MeshStandardMaterial ? (material.normalScale ? material.normalScale.x * 2 : 2) : 2;
+	const normalScaleValueString = normalScale.toFixed( PRECISION );
+	const normalBiasString = (-1 * (normalScale / 2)).toFixed( PRECISION );
+	const normalBiasZString = (1 - normalScale).toFixed( PRECISION );
+
+	return `
+		${needsTextureTransform ? `def Shader "Transform2d_${mapType}" (
+			sdrMetadata = {
+				string role = "math"
+			}
+		)
+		{
+			uniform token info:id = "UsdTransform2d"
+			float2 inputs:in.connect = ${textureTransformInput}
+			float2 inputs:scale = ${buildVector2( repeat )}
+			float2 inputs:translation = ${buildVector2( offset )}
+			float inputs:rotation = ${(rotation / Math.PI * 180).toFixed( PRECISION )}
+			float2 outputs:result
+		}
+		` : '' }
+		def Shader "${name}_${mapType}"
+		{
+			uniform token info:id = "UsdUVTexture"
+			asset inputs:file = @textures/${id}.${isRGBA ? 'png' : 'jpg'}@
+			token inputs:sourceColorSpace = "${ texture.colorSpace === 'srgb' ? 'sRGB' : 'raw' }"
+			float2 inputs:st.connect = ${needsTextureTransform ? textureTransformOutput : textureTransformInput}
+			${needsTextureScale ? `
+			float4 inputs:scale = (${color ? color.r + ', ' + color.g + ', ' + color.b : '1, 1, 1'}, ${opacity})
+			` : `` }
+			${needsNormalScaleAndBias ? `
+			float4 inputs:scale = (${normalScaleValueString}, ${normalScaleValueString}, ${normalScaleValueString}, 1)
+			float4 inputs:bias = (${normalBiasString}, ${normalBiasString}, ${normalBiasZString}, 0)
+			` : `` }
+			token inputs:wrapS = "${ WRAPPINGS[ texture.wrapS ] }"
+			token inputs:wrapT = "${ WRAPPINGS[ texture.wrapT ] }"
+			float outputs:r
+			float outputs:g
+			float outputs:b
+			float3 outputs:rgb
+			${material.transparent || material.alphaTest > 0.0 ? 'float outputs:a' : ''}
+		}`;
+}
+
 function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quickLookCompatible = false ) {
 
 	const materialName = getMaterialName(material);
@@ -2008,133 +2145,8 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 	const samplers: Array<string> = [];
 	const usedUVChannels: Set<number> = new Set();
 
-	function texName(tex: Texture) {
-		// If we have a source, we only want to use the source's id, not the texture's id
-		// to avoid exporting the same underlying data multiple times.
-		return makeNameSafe(tex.name) + '_' + (tex.source?.id ?? tex.id);
-	}
-
-	function buildTexture( texture: Texture, mapType: MapType, color: Color | undefined = undefined, opacity: number | undefined = undefined ) {
-
-		const name = texName(texture);
-		// File names need to be unique; so when we're baking color and/or opacity into a texture we need to keep track of that.
-		// TODO This currently results in textures potentially being exported multiple times that are actually identical!
-		// const colorHex = color ? color.getHexString() : undefined;
-		// const colorId = ( color && colorHex != 'ffffff' ? '_' + color.getHexString() : '' );
-		const id = name + ( opacity !== undefined && opacity !== 1.0 ? '_' + opacity : '' );
-
-		// Seems neither QuickLook nor usdview support scale/bias on .a values, so we need to bake opacity multipliers into
-		// the texture. This is not ideal.
-		const opacityIsAppliedToTextureAndNotAsScale = quickLookCompatible && opacity !== undefined && opacity !== 1.0;
-		const scaleToApply = opacityIsAppliedToTextureAndNotAsScale ? new Vector4(1, 1, 1, opacity) : undefined;
-
-		// Treat undefined opacity as 1
-		if (opacity === undefined)
-			opacity = 1.0;
-
-		// When we're baking opacity into the texture, we shouldn't apply it as scale as well – so we set it to 1.
-		if (opacityIsAppliedToTextureAndNotAsScale)
-			opacity = 1.0;
-
-		// sanitize scaleToApply.w === 0 - this isn't working right now, seems the PNG can't be read back properly.
-		if (scaleToApply && scaleToApply.w <= 0.05) scaleToApply.w = 0.05;
-
-		textures[ id ] = { texture, scale: scaleToApply };
-		
-		const uv = texture.channel > 0 ? 'st' + texture.channel : 'st';
-		usedUVChannels.add(texture.channel);
-
-		const isRGBA = formatsWithAlphaChannel.includes( texture.format );
-
-		const WRAPPINGS = {
-			1000: 'repeat', // RepeatWrapping
-			1001: 'clamp', // ClampToEdgeWrapping
-			1002: 'mirror' // MirroredRepeatWrapping
-		};
-
-		const repeat = texture.repeat.clone();
-		const offset = texture.offset.clone();
-		const rotation = texture.rotation;
-
-		// rotation is around the wrong point. after rotation we need to shift offset again so that we're rotating around the right spot
-		const xRotationOffset = Math.sin(rotation);
-		const yRotationOffset = Math.cos(rotation);
-
-		// texture coordinates start in the opposite corner, need to correct
-		offset.y = 1 - offset.y - repeat.y;
-
-		// turns out QuickLook is buggy and interprets texture repeat inverted.
-		// Apple Feedback: 	FB10036297 and FB11442287
-		if ( quickLookCompatible ) {
-
-			// This is NOT correct yet in QuickLook, but comes close for a range of models.
-			// It becomes more incorrect the bigger the offset is
-
-			// sanitize repeat values to avoid NaNs
-			if (repeat.x === 0) repeat.x = 0.0001;
-			if (repeat.y === 0) repeat.y = 0.0001;
-
-			offset.x = offset.x / repeat.x;
-			offset.y = offset.y / repeat.y;
-
-			offset.x += xRotationOffset / repeat.x;
-			offset.y += yRotationOffset - 1;
-		}
-
-		else {
-
-			// results match glTF results exactly. verified correct in usdview.
-			offset.x += xRotationOffset * repeat.x;
-			offset.y += (1 - yRotationOffset) * repeat.y;
-
-		}
-
-		const needsTextureTransform = ( repeat.x != 1 || repeat.y != 1 || offset.x != 0 || offset.y != 0 || rotation != 0 );
-		const textureTransformInput = `${materialRoot}/${materialName}/${'uvReader_' + uv}.outputs:result>`;		const textureTransformOutput = `${materialRoot}/${materialName}/Transform2d_${mapType}.outputs:result>`;
-		const needsTextureScale = mapType !== 'normal' && (color && (color.r !== 1 || color.g !== 1 || color.b !== 1 || opacity !== 1)) || false;
-
-		const needsNormalScaleAndBias = mapType === 'normal';
-		const normalScale = material instanceof MeshStandardMaterial ? (material.normalScale ? material.normalScale.x * 2 : 2) : 2;
-		const normalScaleValueString = normalScale.toFixed( PRECISION );
-		const normalBiasString = (-1 * (normalScale / 2)).toFixed( PRECISION );
-		const normalBiasZString = (1 - normalScale).toFixed( PRECISION );
-
-		return `
-			${needsTextureTransform ? `def Shader "Transform2d_${mapType}" (
-				sdrMetadata = {
-					string role = "math"
-				}
-			)
-			{
-				uniform token info:id = "UsdTransform2d"
-				float2 inputs:in.connect = ${textureTransformInput}
-				float2 inputs:scale = ${buildVector2( repeat )}
-				float2 inputs:translation = ${buildVector2( offset )}
-				float inputs:rotation = ${(rotation / Math.PI * 180).toFixed( PRECISION )}
-				float2 outputs:result
-			}
-			` : '' }
-			def Shader "${name}_${mapType}"
-			{
-				uniform token info:id = "UsdUVTexture"
-				asset inputs:file = @textures/${id}.${isRGBA ? 'png' : 'jpg'}@
-				token inputs:sourceColorSpace = "${ texture.colorSpace === 'srgb' ? 'sRGB' : 'raw' }"
-				float2 inputs:st.connect = ${needsTextureTransform ? textureTransformOutput : textureTransformInput}
-				${needsTextureScale ? `
-				float4 inputs:scale = (${color ? color.r + ', ' + color.g + ', ' + color.b : '1, 1, 1'}, ${opacity})
-				` : `` }
-				${needsNormalScaleAndBias ? `
-				float4 inputs:scale = (${normalScaleValueString}, ${normalScaleValueString}, ${normalScaleValueString}, 1)
-				float4 inputs:bias = (${normalBiasString}, ${normalBiasString}, ${normalBiasZString}, 0)
-				` : `` }
-				token inputs:wrapS = "${ WRAPPINGS[ texture.wrapS ] }"
-				token inputs:wrapT = "${ WRAPPINGS[ texture.wrapT ] }"
-				float outputs:r
-				float outputs:g
-				float outputs:b
-				float3 outputs:rgb
-				${material.transparent || material.alphaTest > 0.0 ? 'float outputs:a' : ''}
-			}`;
+	if ((material as any).isMeshPhysicalNodeMaterial === true) {
+		return buildNodeMaterial(material as unknown as MeshPhysicalNodeMaterial, materialName, textures);
 	}
 
 	let effectiveOpacity = ( material.transparent || material.alphaTest ) ? material.opacity : 1;
@@ -2175,7 +2187,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 
 		}
 
-		samplers.push( buildTexture( material.map, 'diffuse', material.color, effectiveOpacity ) );
+		samplers.push( buildTexture( material.map, 'diffuse', quickLookCompatible, textures, material, usedUVChannels, material.color, effectiveOpacity ) );
 
 	} else {
 
@@ -2200,7 +2212,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 
 		inputs.push( `${pad}float inputs:occlusion.connect = ${materialRoot}/${materialName}/${texName(material.aoMap)}_occlusion.outputs:r>` );
 
-		samplers.push( buildTexture( material.aoMap, 'occlusion' ) );
+		samplers.push( buildTexture( material.aoMap, 'occlusion', quickLookCompatible, textures, material, usedUVChannels ) );
 
 	}
 
@@ -2212,7 +2224,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 		haveConnectedOpacity = true;
 		haveConnectedOpacityThreshold = true;
 
-		samplers.push( buildTexture( material.alphaMap, 'opacity', new Color( 1, 1, 1 ), effectiveOpacity ) );
+		samplers.push( buildTexture( material.alphaMap, 'opacity', quickLookCompatible, textures, material, usedUVChannels, new Color( 1, 1, 1 ), effectiveOpacity ) );
 
 	} else { // opacity will always be connected if we have a map
 
@@ -2243,7 +2255,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 			inputs.push( `${pad}color3f inputs:emissiveColor.connect = ${materialRoot}/${materialName}/${texName(material.emissiveMap)}_emissive.outputs:rgb>` );
 			const color = material.emissive.clone();
 			color.multiplyScalar( material.emissiveIntensity );
-			samplers.push( buildTexture( material.emissiveMap, 'emissive', color ) );
+			samplers.push( buildTexture( material.emissiveMap, 'emissive', quickLookCompatible, textures, material, usedUVChannels, color ) );
 
 		} else if ( material.emissive?.getHex() > 0 ) {
 
@@ -2262,7 +2274,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 
 			inputs.push( `${pad}normal3f inputs:normal.connect = ${materialRoot}/${materialName}/${texName(material.normalMap)}_normal.outputs:rgb>` );
 
-			samplers.push( buildTexture( material.normalMap, 'normal' ) );
+			samplers.push( buildTexture( material.normalMap, 'normal', quickLookCompatible, textures, material, usedUVChannels ) );
 
 		}
 
@@ -2270,7 +2282,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 
 			inputs.push( `${pad}float inputs:roughness.connect = ${materialRoot}/${materialName}/${texName(material.roughnessMap)}_roughness.outputs:g>` );
 
-			samplers.push( buildTexture( material.roughnessMap, 'roughness' ) );
+			samplers.push( buildTexture( material.roughnessMap, 'roughness', quickLookCompatible, textures, material, usedUVChannels ) );
 
 		} else {
 
@@ -2282,7 +2294,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 
 			inputs.push( `${pad}float inputs:metallic.connect = ${materialRoot}/${materialName}/${texName(material.metalnessMap)}_metallic.outputs:b>` );
 
-			samplers.push( buildTexture( material.metalnessMap, 'metallic' ) );
+			samplers.push( buildTexture( material.metalnessMap, 'metallic', quickLookCompatible, textures, material, usedUVChannels ) );
 
 		} else {
 
@@ -2302,7 +2314,7 @@ function buildMaterial( material: MeshBasicMaterial, textures: TextureMap, quick
 
 			inputs.push( `${pad}float inputs:opacity.connect = ${materialRoot}/${materialName}/${texName(material.transmissionMap)}_transmission.outputs:r>` );
 	
-			samplers.push( buildTexture( material.transmissionMap, 'transmission' ) );
+			samplers.push( buildTexture( material.transmissionMap, 'transmission', quickLookCompatible, textures, material, usedUVChannels ) );
 		}
 
 	}
@@ -2399,12 +2411,13 @@ export {
 	buildMatrix,
 	decompressGpuTexture,
 	findStructuralNodesInBoneHierarchy,
+	formatsWithAlphaChannel,
 	getBoneName,
 	getMaterialName as getMaterialNameForUSD,
 	getPathToSkeleton,
 	imageToCanvas, 
 	imageToCanvasUnpremultiplied,
-	makeNameSafe as makeNameSafeForUSD, 
+	makeNameSafe as makeNameSafeForUSD,
 	USDDocument, 
 	fn as usdNumberFormatting, 
 	USDObject,