https://github.com/coryrylan/usd-viewer
Experimental Web Component for displaying 3d files in USDZ format
https://github.com/coryrylan/usd-viewer
usd usdz web-component
Last synced: about 1 year ago
JSON representation
Experimental Web Component for displaying 3d files in USDZ format
- Host: GitHub
- URL: https://github.com/coryrylan/usd-viewer
- Owner: coryrylan
- License: mit
- Created: 2023-02-19T17:39:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-25T21:25:39.000Z (over 3 years ago)
- Last Synced: 2025-04-10T18:46:44.291Z (about 1 year ago)
- Topics: usd, usdz, web-component
- Language: JavaScript
- Homepage: https://usd-viewer.web.app/usd-viewer-interactive-iframe
- Size: 15.3 MB
- Stars: 36
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# usd-viewer
[](https://www.npmjs.com/package/usd-viewer)
### [usd-viewer demo](https://usd-viewer.web.app/usd-viewer-interactive-iframe)
**Experimental** Web Component for rendering USDZ 3d format. Built on the experimental work and efforts of [github.com/autodesk-forks/USD/tree/release](https://github.com/autodesk-forks/USD/tree/release)
## Instalation
```shell
npm install usd-viewer
```
## Web Assembly Dependencies
Currently this depends on the [SharedArrayBuffer](https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) so to enable in the browser the following response headers must be set:
```json
"Cross-Origin-Embedder-Policy": "require-corp"
"Cross-Origin-Opener-Policy": "same-origin"
```
To load the Wasm dependencies in the browser copy them from the `node_modules` into your host env.
```
cpy node_modules/usd-viewer/wasm/**/* dist/wasm
```
To change the default path (`./wasm`) of the Wasm resources add the following meta tag to the document.
```html
```
## Usage
```html
import 'usd-viewer/include.js';
```
## API
| Property | Attribute | Type | Description |
| ----------------- | ------------------- | ------ | ---------------------------------------------- |
| `src` | `src` | string | source path for usd/usdz file |
| `alt` | `alt` | string | alt descriptive text |
| `controls` | `conrols` | boolean | enable or disable model touch/mouse controls |
| `fileName` | `file-name` | boolean | enable or disable display of file name |
| `autoRotate` | `auto-rotate` | boolean | enable or disable auto rotation of model |
| `autoRotateSpeed` | `auto-rotate-speed` | number | adjust speed of rotations of model |
| `minDistance` | `min-distance` | number | minimum zoom distance of model |
| `maxDistance` | `max-distance` | number | maximum zoom distance of model |
| `zoom` | `zoom` | number | default zoom level of camera relative to model |
## Licensing
The Web Component of this project is MIT licensed, however refer to the following external dependencies and explicitly marked file headers. For additional license details see:
- https://github.com/autodesk-forks/USD
- https://github.com/autodesk-forks/USD/tree/gh-pages/usd_for_web_demos