Installation
Този наръчник обхваща всичко, което ви е необходимо, за да инсталирате Aspose.3D FOSS за TypeScript и да потвърдите, че работи правилно, преди да напишете първия си скрипт за 3D обработка.
Предпоставки
Уверете се, че следните са инсталирани и на вашия PATH преди да продължите:
| Инструмент | Минимум | Бележки |
|---|---|---|
| Node.js | 18 LTS | 20 or 22 LTS recommended |
| npm | 7 | Включено с Node.js |
| TypeScript | 5.0 | Инсталирайте чрез npm install -D typescript |
За да проверите версиите си:
node --version # v18.x.x or later
npm --version # 7.x or later
npx tsc --version # Version 5.x.xСтъпка 1: Създайте проект (ако е необходимо)
Ако добавяте Aspose.3D към съществуващ TypeScript проект, пропуснете тази стъпка и преминете директно към Стъпка 2.
За нов проект:
mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/nodeСтъпка 2: Инсталирайте @aspose/3d
npm install @aspose/3dТова инсталира пакета и неговата единствена транзитивна зависимост, xmldom, автоматично. Не са необходими допълнителни системни пакети, native addons или компилатори. Инсталацията е завършена, когато @aspose/3d се появи във вашия package.json под dependencies.
Проверете инсталацията:
ls node_modules/@aspose/3dТрябва да видите директорията на пакета с package.json, файлове с типове (.d.ts), и компилиран JavaScript.
Стъпка 3: Конфигурирайте TypeScript
Добавете или актуализирайте tsconfig.json в корена на вашия проект със следните настройки. Те са необходими за пълна съвместимост с типови дефиниции на библиотеката и CommonJS изхода:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "dist"]
}Ключови настройки и защо са важни:
| Настройка | Стойност | Защо |
|---|---|---|
target | ES2020 | Позволява optional chaining, nullish coalescing и други ES2020 функции, използвани вътрешно |
module | commonjs | Библиотеката доставя CommonJS изход; трябва да съвпада |
moduleResolution | node | Необходимо за правилно разрешаване на @aspose/3d импорти от подпътека |
esModuleInterop | true | Позволява импортиране по подразбиране от CommonJS модули без обходи на namespace |
strict | true | Библиотеката е написана с noImplicitAny и strictNullChecks; оставете това включено |
Стъпка 4: Проверете инсталацията
Създай src/verify.ts със следния минимален тест за импорт:
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);Компилирайте и изпълнете:
npx tsc
node dist/verify.jsExpected output:
Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:Името на кореновия възел по подразбиране е празен низ — scene.rootNode се създава без аргумент за име.
Ако предпочитате да пропуснете стъпката на компилиране по време на разработка, изпълнете директно с ts-node:
npx ts-node src/verify.tsСтъпка 5: Бърз старт: Зареждане на сцена и отпечатване на информация за възлите
Следният скрипт зарежда 3D файл и отпечатва името и типа на обекта за всеки възел в сцената. Работи с всички поддържани формати: OBJ, glTF, GLB, STL, 3MF, FBX или 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);Запазете това като src/quickstart.ts и го изпълнете:
npx ts-node src/quickstart.tsЗа OBJ файл с една мрежа, наречена Cube, изходът ще изглежда така:
Scene loaded. Node hierarchy:
[(no entity)]
Cube [Mesh]Кореновият възел има празно име (отпечатано като празен префикс). Дъщерните възли наследяват имената си от заредения файл.
Бележки за зависимостите
Aspose.3D FOSS for TypeScript има точно една runtime зависимост:
| Пакет | Цел | Инсталира се автоматично |
|---|---|---|
xmldom | XML парсинг за поддръжка на формати COLLADA (DAE) и 3MF | Да, чрез npm install @aspose/3d |
Не е необходимо да инсталирате xmldom ръчно. Той ще се появи във вашия node_modules след главната команда за инсталиране. Няма вградени добавки (.node файлове) и не се изискват системни библиотеки.
Следващи стъпки
Сега, след като библиотеката е инсталирана и проверена:
- Прочетете Ръководство за разработчици за пълен преглед на всички функционални области.
- Виж Характеристики и функционалности за подробности относно поддръжката на формати, шаблони за сценичен граф, API за материали и анимация, както и пълни примери с код на TypeScript.