Inštalácia
Tento sprievodca pokrýva všetko, čo potrebujete na inštaláciu Aspose.3D FOSS pre TypeScript a overenie, že funguje správne, predtým než napíšete svoj prvý 3D spracovateľský skript.
Predpoklady
Uistite sa, že nasledujúce sú nainštalované a vo vašom PATH pred pokračovaním:
| Nástroj | Minimum | Poznámky |
|---|---|---|
| Node.js | 18 LTS | 20 or 22 LTS recommended |
| npm | 7 | Zahrnuté s Node.js |
| TypeScript | 5.0 | Inštalovať cez npm install -D typescript |
Ako skontrolovať svoje verzie:
node --version # v18.x.x or later
npm --version # 7.x or later
npx tsc --version # Version 5.x.xKrok 1: Vytvorte projekt (ak je to potrebné)
Ak pridávate Aspose.3D do existujúceho TypeScript projektu, preskočte tento krok a prejdite priamo na Krok 2.
Pre nový projekt:
mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/nodeKrok 2: Nainštalujte @aspose/3d
npm install @aspose/3dTýmto sa nainštaluje balík a jeho jediná tranzitívna závislosť, xmldom, automaticky. Nie sú potrebné žiadne ďalšie systémové balíky, natívne doplnky ani kompilátory. Inštalácia je dokončená, keď @aspose/3d sa objaví vo vašom package.json pod dependencies.
Overte inštaláciu:
ls node_modules/@aspose/3dMali by ste vidieť adresár balíka s package.json, súbormi s typovými definíciami (.d.ts), a skompilovaným JavaScriptom.
Krok 3: Nakonfigurujte TypeScript
Pridajte alebo aktualizujte tsconfig.json vo vašom koreňovom adresári projektu s nasledujúcimi nastaveniami. Toto je potrebné pre úplnú kompatibilitu s typovými definíciami knižnice a výstupom CommonJS:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "dist"]
}Kľúčové nastavenia a prečo sú dôležité:
| Nastavenie | Hodnota | Prečo |
|---|---|---|
target | ES2020 | Umožňuje voliteľné reťazenie, nullish koalescenciu a ďalšie funkcie ES2020 používané interne |
module | commonjs | Knižnica dodáva výstup CommonJS; musí sa zhodovať |
moduleResolution | node | Vyžadované pre správne rozlíšenie @aspose/3d importov podcesty |
esModuleInterop | true | Umožňuje predvolené importy z modulov CommonJS bez obchádzok menného priestoru |
strict | true | Knižnica je napísaná s noImplicitAny a strictNullChecks; ponechajte to zapnuté |
Krok 4: Overte inštaláciu
Vytvorte src/verify.ts s nasledujúcim minimálnym testom importu:
import { Scene } from '@aspose/3d';
const scene = new Scene();
console.log('Aspose.3D FOSS for TypeScript is installed correctly.');
console.log('rootNode name:', scene.rootNode.name);Skompilujte a spustite:
npx tsc
node dist/verify.jsOčakávaný výstup:
Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:Názov koreňového uzla je predvolene prázdny reťazec — scene.rootNode je vytvorený bez argumentu názvu.
Ak radšej preskočíte krok kompilácie počas vývoja, spustite priamo s ts-node:
npx ts-node src/verify.tsKrok 5: Rýchly štart: Načítanie scény a výpis informácií o uzloch
Nasledujúci skript načíta 3D súbor a vypíše názov a typ entity každého uzla v scéne. Funguje s akýmkoľvek podporovaným formátom: OBJ, glTF, GLB, STL, 3MF, FBX alebo COLLADA.
import { Scene, Node } from '@aspose/3d';
function printNode(node: Node, depth: number = 0): void {
const indent = ' '.repeat(depth);
const entityType = node.entity ? node.entity.constructor.name : '(no entity)';
console.log(`${indent}${node.name} [${entityType}]`);
for (const child of node.childNodes) {
printNode(child, depth + 1);
}
}
const scene = new Scene();
// Replace 'model.obj' with any supported 3D file path.
// Format is detected automatically from binary magic numbers.
scene.open('model.obj');
console.log('Scene loaded. Node hierarchy:');
printNode(scene.rootNode);Uložte to ako src/quickstart.ts a spustite to:
npx ts-node src/quickstart.tsPre OBJ súbor s jedným meshom nazvaným Cube, výstup bude vyzerať takto:
Scene loaded. Node hierarchy:
[(no entity)]
Cube [Mesh]Koreňový uzol má prázdny názov (vypísaný ako prázdny prefix). Podriadené uzly zdedia svoje názvy z načítaného súboru.
Poznámky k závislostiam
Aspose.3D FOSS pre TypeScript má presne jednu runtime závislosť:
| Balík | Účel | Inštalované automaticky |
|---|---|---|
xmldom | XML parsovanie pre podporu formátov COLLADA (DAE) a 3MF | Áno, cez npm install @aspose/3d |
Nemusíte inštalovať xmldom manuálne. Objaví sa vo vašom node_modules po hlavnom príkaze inštalácie. Neexistujú žiadne natívne doplnky (.node súbory) a nie sú potrebné žiadne systémové knižnice.
Ďalšie kroky
Teraz, keď je knižnica nainštalovaná a overená:
- Prečítajte si Príručku pre vývojárov pre kompletný prehľad všetkých oblastí funkcií.
- Pozrite si Funkcie a vlastnosti pre podrobnosti o podpore formátov, vzoroch scény‑grafu, API materiálov a animácií a kompletné príklady kódu v TypeScripte.