Cài đặt
Hướng dẫn này bao gồm mọi thứ bạn cần để cài đặt Aspose.3D FOSS cho TypeScript và xác nhận rằng nó hoạt động đúng trước khi bạn viết script xử lý 3D đầu tiên của mình.
Yêu cầu trước
Đảm bảo các mục sau đã được cài đặt và trên máy của bạn PATH trước khi tiếp tục:
| Công cụ | Tối thiểu | Ghi chú |
|---|---|---|
| Node.js | 18 LTS | 20 or 22 LTS recommended |
| npm | 7 | Được đóng gói cùng Node.js |
| TypeScript | 5.0 | Cài đặt qua npm install -D typescript |
Để kiểm tra phiên bản của bạn:
node --version # v18.x.x or later
npm --version # 7.x or later
npx tsc --version # Version 5.x.xBước 1: Tạo một dự án (nếu cần)
Nếu bạn đang thêm Aspose.3D vào một dự án TypeScript hiện có, bỏ qua bước này và chuyển thẳng tới Bước 2.
Đối với một dự án mới:
mkdir my-3d-project && cd my-3d-project
npm init -y
npm install -D typescript ts-node @types/nodeBước 2: Cài đặt @aspose/3d
npm install @aspose/3dĐiều này sẽ cài đặt gói và phụ thuộc truyền tải duy nhất của nó, xmldom, tự động. Không cần các gói hệ thống bổ sung, addon gốc, hoặc trình biên dịch. Quá trình cài đặt hoàn tất khi @aspose/3d xuất hiện trong package.json dưới dependencies.
Xác minh việc cài đặt:
ls node_modules/@aspose/3dBạn sẽ thấy thư mục gói có package.json, các tệp định nghĩa kiểu (.d.ts), và JavaScript đã biên dịch.
Bước 3: Cấu hình TypeScript
Thêm hoặc cập nhật tsconfig.json trong thư mục gốc dự án của bạn với các cài đặt sau. Những cài đặt này cần thiết để tương thích đầy đủ với các định nghĩa kiểu của thư viện và đầu ra CommonJS:
{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true,
"outDir": "dist",
"rootDir": "src"
},
"include": ["src/**/*.ts"],
"exclude": ["node_modules", "dist"]
}Các cài đặt quan trọng và lý do chúng quan trọng:
| Cài đặt | Giá trị | Tại sao |
|---|---|---|
target | ES2020 | Kích hoạt optional chaining, nullish coalescing và các tính năng ES2020 khác được sử dụng nội bộ |
module | commonjs | Thư viện cung cấp đầu ra CommonJS; phải khớp |
moduleResolution | node | Cần thiết để giải quyết đúng @aspose/3d các import sub-path |
esModuleInterop | true | Cho phép import mặc định từ các mô-đun CommonJS mà không cần các giải pháp vòng quanh namespace |
strict | true | Thư viện được viết bằng noImplicitAny và strictNullChecks; giữ cái này bật |
Bước 4: Xác minh việc cài đặt
Tạo src/verify.ts với bài kiểm tra import tối thiểu sau:
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);Biên dịch và chạy:
npx tsc
node dist/verify.jsKết quả mong đợi:
Aspose.3D FOSS for TypeScript is installed correctly.
rootNode name:Tên nút gốc mặc định là một chuỗi rỗng — scene.rootNode được tạo mà không có đối số tên.
Nếu bạn muốn bỏ qua bước biên dịch trong quá trình phát triển, hãy chạy trực tiếp bằng ts-node:
npx ts-node src/verify.tsBước 5: Bắt đầu nhanh: Tải một Scene và In thông tin Node
Script sau tải một tệp 3D và in ra tên và loại thực thể của mỗi node trong scene. Nó hoạt động với bất kỳ định dạng nào được hỗ trợ: OBJ, glTF, GLB, STL, 3MF, FBX, hoặc 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);Lưu lại dưới dạng src/quickstart.ts và chạy nó:
npx ts-node src/quickstart.tsĐối với tệp OBJ có một lưới tên Cube, đầu ra sẽ trông như sau:
Scene loaded. Node hierarchy:
[(no entity)]
Cube [Mesh]Nút gốc có tên rỗng (được in như một tiền tố trống). Các node con kế thừa tên của chúng từ tệp đã tải.
Ghi chú về phụ thuộc
Aspose.3D FOSS for TypeScript có đúng một phụ thuộc thời gian chạy:
| Gói | Mục đích | Được cài đặt tự động |
|---|---|---|
xmldom | Phân tích XML để hỗ trợ định dạng COLLADA (DAE) và 3MF | Có, thông qua npm install @aspose/3d |
Bạn không cần cài đặt xmldom bằng tay. Nó sẽ xuất hiện trong node_modules sau lệnh cài đặt chính. Không có addon gốc (.node tệp) và không yêu cầu thư viện hệ thống.
Các bước tiếp theo
Bây giờ thư viện đã được cài đặt và xác minh:
- Đọc Hướng dẫn dành cho nhà phát triển để có hướng dẫn chi tiết toàn bộ các khu vực tính năng.
- Xem Các tính năng và chức năng để biết chi tiết hỗ trợ định dạng, các mẫu đồ thị cảnh, API vật liệu và hoạt hình, và các ví dụ mã TypeScript đầy đủ.