Installation
Den här guiden täcker allt du behöver för att installera Aspose.3D FOSS för TypeScript och bekräfta att det fungerar korrekt innan du skriver ditt första 3D‑behandlingsskript.
Förutsättningar
Se till att följande är installerade och på din PATH innan du fortsätter:
| Verktyg | Minimum | Anteckningar |
|---|---|---|
| Node.js | 18 LTS | 20 or 22 LTS recommended |
| npm | 7 | Inkluderad i Node.js |
| TypeScript | 5.0 | Installera via npm install -D typescript |
För att kontrollera dina versioner:
node --version # v18.x.x or later
npm --version # 7.x or later
npx tsc --version # Version 5.x.xSteg 1: Skapa ett projekt (om det behövs)
Om du lägger till Aspose.3D i ett befintligt TypeScript‑projekt, hoppa över detta steg och gå direkt till Steg 2.
För ett nytt projekt:
mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/nodeSteg 2: Installera @aspose/3d
npm install @aspose/3dDetta installerar paketet och dess enda transitiva beroende, xmldom, automatiskt. Inga ytterligare systempaket, inhemska tillägg eller kompilatorer krävs. Installationen är klar när @aspose/3d visas i din package.json under dependencies.
Verifiera installationen:
ls node_modules/@aspose/3dDu bör se paketkatalogen med package.json, typdefinitionsfiler (.d.ts), och kompilerad JavaScript.
Steg 3: Konfigurera TypeScript
Lägg till eller uppdatera tsconfig.json i ditt projektrot med följande inställningar. Dessa krävs för full kompatibilitet med bibliotekets typdefinitioner och CommonJS-utdata:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "dist"]
}Viktiga inställningar och varför de är viktiga:
| Inställning | Värde | Varför |
|---|---|---|
target | ES2020 | Aktiverar optional chaining, nullish coalescing och andra ES2020-funktioner som används internt |
module | commonjs | Biblioteket levereras med CommonJS-utdata; måste matcha |
moduleResolution | node | Krävs för korrekt upplösning av @aspose/3d sub‑sökvägsimport |
esModuleInterop | true | Möjliggör standardimporter från CommonJS-moduler utan namnrymdslösningar |
strict | true | Biblioteket är skrivet med noImplicitAny och strictNullChecks; behåll detta på |
Steg 4: Verifiera installationen
Skapa src/verify.ts med följande minimala importtest:
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);Kompilera och kör:
npx tsc
node dist/verify.jsFörväntad output:
Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:Rotnodens namn är en tom sträng som standard — scene.rootNode skapas utan namnargument.
Om du föredrar att hoppa över kompileringssteget under utveckling, kör direkt med ts-node:
npx ts-node src/verify.tsSteg 5: Snabbstart: Ladda en scen och skriv ut nodinformation
Följande skript laddar en 3D-fil och skriver ut namn och entitetstyp för varje nod i scenen. Det fungerar med alla stödjade format: OBJ, glTF, GLB, STL, 3MF, FBX eller 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);Spara detta som src/quickstart.ts och kör det:
npx ts-node src/quickstart.tsFör en OBJ-fil med ett mesh som heter Cube, kommer utdata att se ut så här:
Scene loaded. Node hierarchy:
[(no entity)]
Cube [Mesh]Rotnoden har ett tomt namn (skrivet som ett tomt prefix). Barnnoder ärver sina namn från den inlästa filen.
Beroendenoteringar
Aspose.3D FOSS för TypeScript har exakt ett körtidberoende:
| Paket | Syfte | Installeras automatiskt |
|---|---|---|
xmldom | XML-parsing för COLLADA (DAE) och 3MF-formatstöd | Ja, via npm install @aspose/3d |
Du behöver inte installera xmldom manuellt. Det kommer att visas i din node_modules efter huvudinstallationskommandot. Det finns inga inbyggda tillägg (.node filer) och inga systembibliotek krävs.
Nästa steg
Nu när biblioteket är installerat och verifierat:
- Läs Utvecklardokumentation för en komplett genomgång av alla funktionsområden.
- Se Funktioner och funktionaliteter för detaljer om formatstöd, scen‑grafmönster, material‑ och animations‑API:er samt kompletta TypeScript‑kodexempel.