API Overview — @aspose/3d for TypeScript
Pakej: @aspose/3d (v24.12.0) Bahasa: TypeScript / Node.js 18+ Lesen: MIT
@aspose/3d adalah perpustakaan berlesen MIT untuk membaca, membina, dan mengeksport adegan 3D dalam Node.js. Ia disertakan dengan definisi jenis TypeScript yang lengkap, satu kebergantungan masa jalan ( ), dan menyokong tujuh format fail 3D utama. Semua I/O bersifat segerak. Tiada add-on asli diperlukan.xmldomtetapan untuk resolusi sub-laluan yang betul:.
npm install @aspose/3d{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true
}
}Kelas Teras
. Gunakan scene.rootNode. Use open() / openFromBuffer() untuk memuatkan fail dan save() / saveToBuffer() untuk mengeksport.
| —————————- | ——————————— | ——————————————————- |
| rootNode | Node | Akar graf adegan |
| assetInfo | AssetInfo | Metadata fail (pencipta, unit, sistem koordinat) |
| animationClips | AnimationClip[] | Semua klip animasi dalam adegan |
| open(path, opts?) | (string, LoadOptions?) → void | Muat fail dari cakera |
| openFromBuffer(buf, opts?) | (Buffer, LoadOptions?) → void | Muat dari penampan dalam memori |
| save(path, opts?) | Transform | Simpan ke cakera (format ditentukan daripada sambungan) |
| saveToBuffer(ext, opts?) | (string, SaveOptions?) → Buffer | Simpan ke penampan dalam memori |
| createAnimationClip(name) | (string) → AnimationClip | Cipta dan daftar klip animasi baru |
Sebuah nod pokok bernama dalam graf adegan. Nod membawa pilihan Entity (mesh, camera, light) dan satu Transform yang menempatkan nod relatif kepada induknya.
| ————————- | ————————- | ———————————————- |
| name | string | Nama nod |
| childNodes | Node[] | Nod anak langsung |
| entity | Entity | null | Geometri, kamera, atau cahaya yang dilampirkan |
| transform | Transform | Terjemahan, putaran, skala setempat |
| materials | Material[] | Bahan yang ditetapkan kepada nod ini |
| createChildNode(name) | (string) → Node | Tambah nod anak |
| getChildNode(name) | (string) → Node | null | Cari anak mengikut nama |
Mesh poligon; jenis geometri utama. Memperluas Geometry.
| ————————- | ——————————————– | —————————————– |
| controlPoints | Vector4[] | Kedudukan verteks (w=1 untuk kedudukan) |
| polygonCount | number | Bilangan poligon |
| createPolygon(indices) | (number[]) → void | Tambah poligon (segitiga atau kuad) |
| getElement(type) | (VertexElementType) → VertexElement | null | Dapatkan elemen verteks mengikut semantik |
| createElement(type) | (VertexElementType) → VertexElement | Cipta elemen verteks |
Transformasi setempat yang diterapkan pada nod.
| ————————- | ————————- | —————————————- |
| translation | Vector3 | Posisi tempatan |
| eulerAngles | Vector3 | Putaran Euler dalam darjah (susunan XYZ) |
| rotation | Quaternion | Putaran sebagai kuaternion |
| scaling | Vector3 | Skala tempatan |
Kelas Bahan
| ————————- | ——————————————- | ————————————————————– |
| LambertMaterial | Difus + bayang ambient | diffuseColor, ambientColor, transparency |
| PhongMaterial | Menambah specular + emissive kepada Lambert | specularColor, shininess, emissiveColor |
| PbrMaterial | Berasaskan fizikal untuk glTF 2.0 | albedo, metallicFactor, roughnessFactor, emissiveColor |
Kelas Matematik
| ————————- | —————————————————————————- |
| Vector3 | 3-component double-precision vector (x, y, z) |
| Vector4 | 4-component vector for homogeneous math (x, y, z, w) |
| FVector3 | Varian ketepatan tunggal yang digunakan dalam data vertex |
| Matrix4 | 4×4 transformation matrix; multiply, invert, decompose |
| Quaternion | Quaternion putaran; fromEulerAngle, toEulerAngles, slerp |
| BoundingBox | Kotak sempadan selari paksi; minimum, maximum, center, size, merge |
Kelas Animasi
| ————————- | —————————————————————————————– |
| AnimationClip | Klip bernama; mengandungi AnimationNode senarai; diakses melalui scene.animationClips |
| AnimationNode | Mengikat klip kepada nod adegan bernama; mengandungi AnimationChannel senarai |
| AnimationChannel | Menyasarkan satu sifat (contoh: terjemahan X); menyimpan satu KeyframeSequence |
| KeyframeSequence | Senarai teratur bagi KeyFrame objek dengan interpolation dan extrapolation |
| KeyFrame | Pasangan masa/nilai tunggal |
| ————————- | ————————————————————– | ———————————————– |
| VertexElementType | NORMAL, UV, VERTEX_COLOR, BINORMAL, TANGENT | Semantik elemen verteks |
| MappingMode | CONTROL_POINT, POLYGON_VERTEX, POLYGON, ALL_SAME | Bagaimana data dipetakan ke geometri |
| ReferenceMode | DIRECT, INDEX, INDEX_TO_DIRECT | Strategi pengindeksan untuk data elemen verteks |
| Interpolation | CONSTANT, LINEAR, BEZIER | Interpolasi bingkai kunci |
| Extrapolation | CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE | Kelakuan di luar julat keyframe |
Modul Format
Kelas pilihan khusus format dieksport dari modul sub‑laluan. Import mereka secara berasingan:
import { ObjLoadOptions } from '@aspose/3d/formats/obj';
import { GltfSaveOptions, GltfFormat } from '@aspose/3d/formats/gltf';
import { StlLoadOptions, StlSaveOptions } from '@aspose/3d/formats/stl';
import { FbxLoadOptions, FbxSaveOptions } from '@aspose/3d/formats/fbx';
import { ColladaLoadOptions } from '@aspose/3d/formats/collada';
import { ThreeMfSaveOptions } from '@aspose/3d/formats/3mf';Modul OBJ (@aspose/3d/formats/obj)
| ————————- | ——————————————————————— |
| ObjLoadOptions | enableMaterials, flipCoordinateSystem, scale, normalizeNormal |
Modul glTF/GLB (@aspose/3d/formats/gltf)
| ————————- | ————————————————————– |
| GltfSaveOptions | binaryMode (true → .glb), flipTexCoordV |
| GltfFormat | GltfFormat.getInstance(): contoh format untuk scene.save() |
Modul STL (@aspose/3d/formats/stl)
| ————————- | ——————————————- |
| StlLoadOptions | N/A |
| StlSaveOptions | binaryMode (false → ASCII, true → binari) |
Modul FBX (@aspose/3d/formats/fbx)
| ————————- | ————— |
| FbxLoadOptions | N/A |
| FbxSaveOptions | embedTextures |
Format yang Disokong
| ————————- | ————————- | ————————- | ————————- |
| FBX | .fbx | Tidak* | Tidak* |
Contoh Rujukan Pantas
import { Scene } from '@aspose/3d';
import { ObjLoadOptions } from '@aspose/3d/formats/obj';
import { GltfSaveOptions } from '@aspose/3d/formats/gltf';
// Load OBJ with materials
const scene = new Scene();
const loadOpts = new ObjLoadOptions();
loadOpts.enableMaterials = true;
scene.open('input.obj', loadOpts);
// Inspect root nodes
for (const node of scene.rootNode.childNodes) {
console.log(`Node: ${node.name}, entity: ${node.entity?.constructor.name}`);
}
// Export as GLB (binary glTF)
const saveOpts = new GltfSaveOptions();
saveOpts.binaryMode = true;
scene.save('output.glb', saveOpts);