Installation
Aquesta guia cobreix tot el que necessites per instal·lar Aspose.3D FOSS per a TypeScript i confirmar que funciona correctament abans d’escriure el teu primer script de processament 3D.
Requisits previs
Assegureu-vos que el següent estigui instal·lat i al vostre PATH abans de continuar:
| Eina | Mínim | Notes |
|---|---|---|
| Node.js | 18 LTS | 20 or 22 LTS recommended |
| npm | 7 | Inclòs amb Node.js |
| TypeScript | 5.0 | Instal·la via npm install -D typescript |
Per comprovar les teves versions:
node --version # v18.x.x or later
npm --version # 7.x or later
npx tsc --version # Version 5.x.xPas 1: Crea un projecte (si cal)
Si estàs afegint Aspose.3D a un projecte TypeScript existent, omet aquest pas i ves directament al Pas 2.
Per a un projecte nou:
mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/nodePas 2: Instal·la @aspose/3d
npm install @aspose/3dAixò instal·la el paquet i la seva única dependència transitiva, xmldom, automàticament. No es requereixen paquets de sistema addicionals, complements natius o compiladors. La instal·lació s’ha completat quan @aspose/3d apareix al vostre package.json a sota dependencies.
Verifica la instal·lació:
ls node_modules/@aspose/3dHauríeu de veure el directori del paquet amb package.json, fitxers de definició de tipus (.d.ts), i JavaScript compilat.
Pas 3: Configura TypeScript
Afegiu o actualitzeu tsconfig.json al directori arrel del vostre projecte amb la configuració següent. Aquests són necessaris per a una compatibilitat completa amb les definicions de tipus de la biblioteca i la sortida CommonJS:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "dist"]
}Configuracions clau i per què són importants:
| Configuració | Valor | Per què |
|---|---|---|
target | ES2020 | Activa l’encadenament opcional, la coalescència nul·la i altres funcions ES2020 utilitzades internament |
module | commonjs | La biblioteca proporciona una sortida CommonJS; ha de coincidir |
moduleResolution | node | Necessari per a la resolució correcta del @aspose/3d imports de subcamí |
esModuleInterop | true | Permet imports per defecte des de mòduls CommonJS sense recórrer a solucions d’espai de noms |
strict | true | La biblioteca està escrita amb noImplicitAny i strictNullChecks; mantingueu això activat |
Pas 4: Verifica la instal·lació
Creeu src/verify.ts amb la següent prova d’importació mínima:
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);Compila i executa:
npx tsc
node dist/verify.jsExpected output:
Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:El nom del node arrel és una cadena buida per defecte — scene.rootNode es crea sense cap argument de nom.
Si preferiu ometre l’etapa de compilació durant el desenvolupament, executeu directament amb ts-node:
npx ts-node src/verify.tsPas 5: Inici ràpid: Carrega una escena i imprimeix la informació del node
L’script següent carrega un fitxer 3D i imprimeix el nom i el tipus d’entitat de cada node de l’escena. Funciona amb qualsevol format compatible: OBJ, glTF, GLB, STL, 3MF, FBX o 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);Deseu això com a src/quickstart.ts i executeu-lo:
npx ts-node src/quickstart.tsPer a un fitxer OBJ amb una malla anomenada Cube, la sortida es veurà així:
Scene loaded. Node hierarchy:
[(no entity)]
Cube [Mesh]El node arrel té un nom buit (imprimit com un prefix buit). Els nodes fills hereten els seus noms del fitxer carregat.
Notes de dependències
Aspose.3D FOSS per a TypeScript té exactament una dependència d’execució:
| Paquet | Propòsit | Instal·lat automàticament |
|---|---|---|
xmldom | Anàlisi XML per al suport dels formats COLLADA (DAE) i 3MF | Sí, a través de npm install @aspose/3d |
No cal que instal·leu xmldom manualment. Apareixerà al vostre node_modules després de l’ordre d’instal·lació principal. No hi ha complements natius (.node fitxers) i no es requereixen biblioteques del sistema.
Propers passos
Ara que la biblioteca està instal·lada i verificada:
- Llegeix el Guia del desenvolupador per a una guia completa de totes les àrees de funcionalitat.
- Vegeu Funcionalitats i Característiques per a detalls de suport de formats, patrons de gràfics d’escena, APIs de material i animació, i exemples complets de codi TypeScript.