Installation
Dieser Leitfaden umfasst alles, was Sie benötigen, um Aspose.3D FOSS für TypeScript zu installieren und bestätigt, dass es richtig funktioniert, bevor Sie Ihr erstes 3D-Verarbeitungsskripte schreiben.
Prerequisites
Stellen Sie sicher, dass die folgenden installiert sind und auf Ihrem PATH Vor dem Verfahren:
| Tool | Minimum | Notizen |
|---|---|---|
| Node.js | 18 LTS | 20 oder 22 LTS empfohlen |
| npm | 7 | Verknüpft mit Node.js |
| TypeScript | 5.0 | Installation über npm install -D typescript |
Um Ihre Versionen zu überprüfen:
node --version # v18.x.x or later
npm --version # 7.x or later
npx tsc --version # Version 5.x.xSchritt 1: Erstellen eines Projekts (wenn nötig)
Wenn Sie Aspose.3D zu einem vorhandenen TypeScript-Projekt hinzufügen, gehen Sie diesen Schritt los und gehen direkt zum Schritt 2.
Für ein neues Projekt:
mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/nodeSchritt 2: Installation @aspose/3d
git clone https://github.com/aspose-3d-foss/Aspose.3D-FOSS-for-TypeScript.git
cd Aspose.3D-FOSS-for-TypeScript
npm install
npm run buildDies installiert das Paket und seine einzige transitive Abhängigkeit, xmldom, automatisch. Keine zusätzlichen Systempakete, native Addons oder Compilatoren sind erforderlich. Die Installation ist fertig, wenn @aspose/3d erscheint in deinem package.json Unter dependencies.
Überprüfen Sie die Installation:
ls node_modules/@aspose/3dSie sollten das Paket-Dokument mit package.json, die Form der Datei Definition (.d.tsund JavaScript zusammengestellt.
Schritt 3: Konfigurieren von TypeScript
Aktualisieren oder hinzufügen tsconfig.json in Ihrer Projektwurzel mit den folgenden Einstellungen. Diese sind erforderlich, um vollständige Kompatibilität mit der Typdefinition der Bibliothek und CommonJS-Ausgang:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "dist"]
}Die wichtigsten Einstellungen und warum sie bedeuten:
| Setting | Wert | Warum |
|---|---|---|
target | ES2020 | Erlaubt optionale Ketten, null-Kühlung und andere Funktionen von ES2020 internt genutzt |
module | commonjs | Die Bibliothek schiffe CommonJS-Ausgang; muss mitkommen |
moduleResolution | node | Für eine korrekte Lösung der @aspose/3d Sub-Path Import |
esModuleInterop | true | Erlaubt Standardimporten aus CommonJS-Modulen ohne Namespace Workarounds |
strict | true | Die Bibliothek ist mit noImplicitAny und strictNullChecks;· Haltet dies auf |
Schritt 4: Überprüfen Sie die Installation
Kreativität src/verify.ts mit dem folgenden Mindestimporttests:
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);Kompilieren und runnen:
npx tsc
node dist/verify.jsErwartete Produktion:
Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:Der Root-Node ist ein leer String nach Vorwahl - scene.rootNode Es wird mit keinem Namen Argument geschaffen.
Wenn Sie während der Entwicklung den kompilierten Schritt überwinden möchten, fahren Sie direkt mit dem ts-node:
npx ts-node src/verify.tsSchritt 5: Schnelle Start: Laden Sie eine Szenen- und Drucknoteninformationen herunter
Das folgende Script laden ein 3D-Datei herunter und drucken den Namen und die Entitätstyp jedes Node in der Szene. Es funktioniert mit jedem unterstützten Format: OBJ, glTF, GLB, STL, 3MF oder 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);So sparen Sie das als src/quickstart.ts Und runzt es:
npx ts-node src/quickstart.tsFür eine OBJ-Datei mit einem Mesh namens Cube,Die Produktion wird wie:
Scene loaded. Node hierarchy:
[(no entity)]
Cube [Mesh]Die Wurzelnode hat einen leeren Namen (druckt als weißer Vorwahl). Kinder Noden erfassen ihre Namen aus dem ladenen Datei.
Abhängigkeit Notes
Aspose.3D FOSS für TypeScript hat genau eine Laufzeitabhängigkeit:
| Package | Purpose | automatisch installiert |
|---|---|---|
xmldom | XML-Parting für COLLADA (DAE) und 3MF Format unterstützt | Ja, durch npm install @aspose/3d |
Sie müssen nicht installieren xmldom manuell. es wird in deinem node_modules Nach der Hauptinstallation. es gibt keine native Addons (.node Dateien) und keine Systembibliotheken erforderlich.
Nächste Schritte
Jetzt, wenn die Bibliothek installiert und verifiziert ist:
- Lesen Sie die Entwickler Guide für einen vollständigen Spaziergang aller Funktionsgebiete.
- Sehen Sie Eigenschaften und Funktionen für Format-Supportdetails, Scene-Graphmuster, Material und Animation APIs sowie vollständige TypeScript-Code Beispiele.