[name]

An exporter for `USDZ`.

[link:https://graphics.pixar.com/usd/docs/index.html USDZ] (Universal Scene Description ZIP archive) is a [link:https://openusd.org/release/index.html USD-based format] for 3D content optimized for sharing and viewing. USDZ files are ZIP archives containing USD scene data and associated textures. The format supports meshes, materials, textures, and cameras.

Import

[name] is an add-on, and must be imported explicitly. See [link:#manual/introduction/Installation Installation / Addons].


			import { USDZExporter } from 'three/addons/exporters/USDZExporter.js';

Features

USDZExporter supports the following features:

Meshes with MeshStandardMaterial
Textures (diffuse, normal, emissive, roughness, metalness, alpha, ambient occlusion)
Clearcoat and clearcoat roughness (from MeshPhysicalMaterial)
Cameras (perspective and orthographic)
AR anchoring properties for iOS Quick Look
Texture compression support with texture utils

Code Example


		// Instantiate a exporter
		const exporter = new USDZExporter();

		// Configure export options
		const options = { maxTextureSize: 2048 };

		try {

			// Parse the input and generate the USDZ output
			const arraybuffer = await exporter.parseAsync( scene, options );
			downloadUSDZ( arraybuffer );

		} catch ( error ) {

			console.error( 'Export failed:', error );

		}

Examples

[example:misc_exporter_usdz]

Constructor

[name]()

Creates a new [name].

Methods

[method:undefined parse]( [param:Object3D scene], [param:Function onCompleted], [param:Function onError], [param:Object options] )

[page:Object3D scene] — Scene or object to export.
[page:Function onCompleted] — Will be called when the export completes. The argument will be the generated USDZ ArrayBuffer.
[page:Function onError] — Will be called if there are any errors during the USDZ generation.
[page:Options options] — Export options

`maxTextureSize` - int. Restricts the image maximum size (both width and height) to the given value. Default is 1024.
`includeAnchoringProperties` - bool. Whether to include anchoring properties for AR. Default is true.
`onlyVisible` - bool. Export only visible 3D objects. Default is true.
`quickLookCompatible` - bool. Whether to make the exported USDZ compatible with Apple's QuickLook. Default is false.
`ar` - Object. AR-specific options including anchoring type and plane anchoring alignment.

Generates a USDZ ArrayBuffer output from the input Object3D. Note that only MeshStandardMaterial is supported.

[method:Promise parseAsync]( [param:Object3D scene], [param:Object options] )

Generates a USDZ ArrayBuffer output from the input Object3D.

This is just like the [page:.parse]() method, but instead of accepting callbacks it returns a promise that resolves with the ArrayBuffer result, and otherwise accepts the same options.

[method:undefined setTextureUtils]( [param:Object utils] )

Sets the texture utils for this exporter. Only relevant when compressed textures have to be exported. Depending on whether you use WebGLRenderer or WebGPURenderer, you must inject the corresponding texture utils WebGLTextureUtils or WebGPUTextureUtils.

Source

[link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/exporters/USDZExporter.js examples/jsm/exporters/USDZExporter.js]