@huggingface/usd-web-viewer

OpenUSD di browser: komposisi USD dalam WebAssembly, dibangun di atas openusd (Rust murni), dirender dengan three.js. Membaca .usd, .usda, .usdc dan .usdz; pemuatan dijalankan dalam Web Worker.

npm install @huggingface/usd-web-viewer three

Penggunaan

Penampil siap pakai (renderer, pencahayaan, kontrol orbit):

import { createViewer } from '@huggingface/usd-web-viewer';

const viewer = createViewer(document.getElementById('viewer')); // a container element
const { info } = await viewer.load(
  'https://huggingface.co/datasets/Robotiq-Official/simready-assets/resolve/main/Robotiq_2F_85/simready_usd/Robotiq_2F_85.usda',
);

Atau ke dalam scene three.js Anda sendiri:

import { loadUsd } from '@huggingface/usd-web-viewer';

const { root, complete, dispose } = await loadUsd(url);
scene.add(root); // a THREE.Group, Y-up, in meters
await complete; // textures stream in after the geometry

Opsi

loadUsd(url, options) dan viewer.load(url, options) menerima:

createViewer(container, options) menerima background (default transparan), onContextLost dan onContextRestored (dipanggil dengan reload dari model terakhir yang ditampilkan).

Gagal adalah UsdLoadError dengan code (aborted, fetch, compose, worker, webgl); apa pun yang tidak dapat ditampilkan secara akurat dicantumkan dalam info.warnings. Setiap opsi, error, dan warning memiliki tipe.

Memuat file yang tidak tepercaya

• Permintaan dikirim seperti <model-viewer>: cookie hanya ke origin halaman itu sendiri (credentials: 'same-origin'), tanpa header kustom, tanpa referrer.
• Lapisan dan tekstur hanya diambil melalui http(s).
• Parsing berjalan di Rust yang dikompilasi ke WebAssembly, di dalam Web Worker.
• Setiap beban dibatasi: maxLayerBytes (768 MiB), maxLayers (1024), maxTextureBytes (512 MiB), maxTriangles (20M) dan maxInstances (100.000); gambar hingga 16384 px per sisi dan 8192 x 8192 px dalam area; prim bersarang hingga kedalaman 256 level; entri .usdz hingga 512 MiB masing-masing dan 1 GiB secara keseluruhan, disimpan tanpa kompresi.
• File yang tidak valid gagal dimuat dengan UsdLoadError.

File lokal

Untuk menampilkan file yang dijatuhkan ke halaman atau dipilih dengan <input type="file" webkitdirectory>, berikan file tersebut sebagai files, dengan kunci berupa path mereka di dalam paket, lalu muat kunci dari lapisan root. Path relatif di dalam file dipecahkan satu sama lain; tidak ada yang diambil untuk path tersebut.

const files = new Map([...input.files].map((file) => [file.webkitRelativePath || file.name, file]));
await viewer.load('chair/simready_usd/sm_chair.usd', { files });

Bundlers

Worker dan biner WASM ditemukan dengan new URL(..., import.meta.url), yang di-resolve dan di-emit oleh Vite, webpack, dan bundler lainnya. Dengan dev server Vite, kecuali paket dari pre-bundling dependensi:

// vite.config.js
export default { optimizeDeps: { exclude: ['@huggingface/usd-web-viewer'] } };

Berlisensi MIT. Lisensi dari crate Rust yang dikompilasi ke dalam biner WASM terdapat di THIRD_PARTY_LICENSES.