Installation
Denne vejledning dækker alt, hvad du behøver for at installere Aspose.3D FOSS til TypeScript og bekræfte, at det fungerer korrekt, før du skriver dit første 3D-behandlingsscript.
Forudsætninger
Sørg for, at følgende er installeret og på din PATH før du fortsætter:
| Værktøj | Minimum | Noter |
|---|---|---|
| Node.js | 18 LTS | 20 or 22 LTS recommended |
| npm | 7 | Medfølger Node.js |
| TypeScript | 5.0 | Installer via npm install -D typescript |
For at kontrollere dine versioner:
node --version # v18.x.x or later
npm --version # 7.x or later
npx tsc --version # Version 5.x.xTrin 1: Opret et projekt (om nødvendigt)
Hvis du tilføjer Aspose.3D til et eksisterende TypeScript-projekt, spring dette trin over og gå direkte til Trin 2.
For et nyt projekt:
mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/nodeTrin 2: Installer @aspose/3d
npm install @aspose/3dDette installerer pakken og dens eneste transitive afhængighed, xmldom, automatisk. Ingen yderligere systempakker, native add-ons eller kompilatorer er påkrævet. Installationen er fuldført, når @aspose/3d vises i din package.json under dependencies.
Bekræft installationen:
ls node_modules/@aspose/3dDu bør se pakkemappen med package.json, type definition-filer (.d.ts), og kompileret JavaScript.
Trin 3: Konfigurer TypeScript
Tilføj eller opdater tsconfig.json i roden af dit projekt med følgende indstillinger. Disse er påkrævet for fuld kompatibilitet med bibliotekets type definitioner og CommonJS-output:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "dist"]
}Vigtige indstillinger og hvorfor de er vigtige:
| Indstilling | Værdi | Hvorfor |
|---|---|---|
target | ES2020 | Aktiverer optional chaining, nullish coalescing og andre ES2020-funktioner, der bruges internt |
module | commonjs | Biblioteket leverer CommonJS-output; skal matche |
moduleResolution | node | Påkrævet for korrekt opløsning af @aspose/3d sub‑sti-imports |
esModuleInterop | true | Muliggør standardimporter fra CommonJS-moduler uden navnerums‑omgange |
strict | true | Biblioteket er skrevet med noImplicitAny og strictNullChecks; behold dette tændt |
Trin 4: Bekræft installationen
Opret src/verify.ts med følgende minimale 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);Kompilér og kør:
npx tsc
node dist/verify.jsExpected output:
Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:Rodnodens navn er en tom streng som standard — scene.rootNode oprettes uden navneargument.
Hvis du foretrækker at springe kompileringstrinnet over under udvikling, kør direkte med ts-node:
npx ts-node src/verify.tsTrin 5: Hurtig start: Indlæs en scene og udskriv nodeinformation
Det følgende script indlæser en 3D-fil og udskriver navnet og entitetstypen for hver node i scenen. Det fungerer med alle understøttede formater: 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);Gem dette som src/quickstart.ts og kør det:
npx ts-node src/quickstart.tsFor en OBJ-fil med et mesh ved navn Cube, vil outputtet se sådan ud:
Scene loaded. Node hierarchy:
[(no entity)]
Cube [Mesh]Root-noden har et tomt navn (udskrevet som et tomt præfiks). Underordnede noder arver deres navne fra den indlæste fil.
Afhængighedsnoter
Aspose.3D FOSS for TypeScript har præcis én runtime-afhængighed:
| Pakke | Formål | Installeres automatisk |
|---|---|---|
xmldom | XML-parsing for COLLADA (DAE) og 3MF-formatunderstøttelse | Ja, via npm install @aspose/3d |
Du behøver ikke at installere xmldom manuelt. Det vil dukke op i din node_modules efter hovedinstallationskommandoen. Der er ingen native add-ons (.node filer) og ingen systembiblioteker kræves.
Næste skridt
Nu hvor biblioteket er installeret og verificeret:
- Læs Udviklerguide for en komplet gennemgang af alle funktionsområder.
- Se Funktioner og funktionaliteter for detaljer om formatunderstøttelse, scene-graph mønstre, material- og animations-API’er samt komplette TypeScript kodeeksempler.