Collect all Animations/Animators automatically on export and emit them as playing at the start. Animator state chains and loops will automatically be collected and exported in order as well. If this setting is off, Animators need to be registered by components – for example from PlayAnimationOnClick.
Collect all AudioSources automatically on export and emit them as playing at the start. They will loop according to their settings. If this setting is off, Audio Sources need to be registered by components – for example from PlayAudioOnClick.
Extensions to add custom behaviors and interactions to the USDZ file.
You can add your own extensions here by extending IUSDExporterExtension.
the object this component is attached to. Note that this is a threejs Object3D with some additional features
the unique identifier for this component
Enabling this option will export QuickLook-specific preliminary behaviours along with the USDZ files. These extensions are only supported on QuickLook on iOS/visionOS/MacOS. Keep this option off for general USDZ usage.
Assign the object to export as USDZ file. If undefined or null, the whole scene will be exported.
Optional sourceholds the source identifier this object was created with/from (e.g. if it was part of a glTF file the sourceId holds the url to the glTF)
true if the object is enabled and active in the hierarchy
true if this component was destroyed (this.destroy()) or the whole object this component was part of
the layer of the gameObject this component is attached to
the name of the gameObject this component is attached to
shorthand for this.context.scene
the scene of the context
Is the gameObject marked as static
the tag of the gameObject this component is attached to
Optional init: Partial<NoInternalNeedleEngineState<FilterStartingWith<FilterTypes<USDZExporter, Function>, "_">>>Downloads the given blob as a file.
Optional earlyCreates an USDZ file from the current scene or assigned objectToExport and opens it in QuickLook. Use the various public properties of USDZExporter to customize export behaviour.
use exportAndOpen instead
Optional lateOptional onOptional onOptional onOptional onOptional onOptional onOptional onCallback when this component joins a xr session (or becomes active in a running XR session)
Optional onCallback when this component exists a xr session (or when it becomes inactive in a running XR session)
Optional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onOptional onCallback when a xr session updates (while it is still active in XR session)
Optional onOptional onXRControllerCallback when a controller is connected/added while in a XR session
OR when the component joins a running XR session that has already connected controllers
OR when the component becomes active during a running XR session that has already connected controllers
Optional onXRControllerOpens QuickLook on iOS/iPadOS/visionOS with the given content in AR mode.
The URL to the .usdz or .reality file or a blob containing an USDZ file.
Download filename
Optional resolvestarts a coroutine (javascript generator function)yield will wait for the next frame:
yield WaitForSeconds(1) to wait for 1 second.yield WaitForFrames(10) to wait for 10 frames.yield new Promise(...) to wait for a promise to resolve.generator function to start
event to register the coroutine for (default: FrameEvent.Update). Note that all coroutine FrameEvent callbacks are invoked after the matching regular component callbacks. For example FrameEvent.Update will be called after regular component update() methods)
the generator function (use it to stop the coroutine with stopCoroutine)
onEnable() { this.startCoroutine(this.myCoroutine()); }
private *myCoroutine() {
while(this.activeAndEnabled) {
console.log("Hello World", this.context.time.frame);
// wait for 5 frames
for(let i = 0; i < 5; i++) yield;
}
}
Stop a coroutine that was previously started with startCoroutine
the routine to be stopped
the frame event to unregister the routine from (default: FrameEvent.Update)
Optional supportsXROptional callback, you can implement this to only get callbacks for VR or AR sessions if necessary.
true if the mode is supported (if false the mode is not supported by this component and it will not receive XR callbacks for this mode)
Optional updateGenerated using TypeDoc
Exports the current scene or a specific object as USDZ file and opens it in QuickLook on iOS/iPadOS/visionOS.
The USDZ file is generated using the Needle Engine ThreeUSDZExporter.
The exporter supports various extensions to add custom behaviors and interactions to the USDZ file.
The exporter can automatically collect Animations and AudioSources and export them as playing at the start.
The exporter can also add a custom QuickLook overlay with a call to action button and custom branding.
Example