API Overview — @aspose/3d for TypeScript
Paketas: @aspose/3d (v24.12.0) Kalba: TypeScript / Node.js 18+ Licencija: MIT
@aspose/3d yra MIT licencijuota biblioteka, skirta skaityti, kurti ir eksportuoti 3D scenas Node.js aplinkoje. Ji tiekiama su pilnais TypeScript tipų apibrėžimais, viena vykdymo laiko priklausomybe («<SEG_7»>), ir palaiko septynis pagrindinius 3D failų formatus. Visa įvestis/išvestis yra sinchroninė. Nereikia jokių natūralių papildinių.xmldom), ir palaiko septynis pagrindinius 3D failų formatus. Visa įvestis/išvestis yra sinchroninė. Nereikia jokių natūralių papildinių.
npm install @aspose/3d{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true
}
}Pagrindinės klasės
Šakninis konteineris 3D scenai. Visa turinys; mazgai, geometrija, medžiagos ir animacijos; saugomi medyje, kurio šaknys yra scene.rootNode. Naudokite open() / openFromBuffer() įkelti failą ir save() / saveToBuffer() eksportuoti.
| —————————- | ——————————— | ——————————————————————– |
| rootNode | Node | Scenos grafiko šaknis |
| assetInfo | AssetInfo | Failo metaduomenys (kūrėjas, matavimo vienetai, koordinačių sistema) |
| animationClips | AnimationClip[] | Visi animacijos klipai scenoje |
| open(path, opts?) | (string, LoadOptions?) → void | Įkelti failą iš disko |
| openFromBuffer(buf, opts?) | (Buffer, LoadOptions?) → void | Įkelti iš atminties buferio |
| save(path, opts?) | Transform | Išsaugoti į diską (formatas nustatomas pagal plėtinį) |
| saveToBuffer(ext, opts?) | (string, SaveOptions?) → Buffer | Išsaugoti į atminties buferį |
| createAnimationClip(name) | (string) → AnimationClip | Sukurti ir užregistruoti naują animacijos klipą |
Pavadintas medžio mazgas scenos grafike. Mazgai neša pasirenkamą Entity (mesh, camera, light) ir Transform kuris pozicionuoja mazgą santykinai prie jo tėvo.
| ————————- | ————————- | —————————————- |
| name | string | Mazgo pavadinimas |
| childNodes | Node[] | Tiesioginiai vaiko mazgai |
| entity | Entity | null | Prijungta geometrija, kamera arba šviesa |
| transform | Transform | Vietinis perkėlimas, sukimas, mastelis |
| materials | Material[] | Medžiagos, priskirtos šiam mazgui |
| createChildNode(name) | (string) → Node | Pridėti vaikų mazgą |
| getChildNode(name) | (string) → Node | null | Rasti vaiką pagal pavadinimą |
Poligonų tinklelis; pagrindinis geometrijos tipas. Išplečia Geometry.
| ————————- | ——————————————– | ——————————————- |
| controlPoints | Vector4[] | Viršūnių pozicijos (w=1 pozicijoms) |
| polygonCount | number | Poligonų skaičius |
| createPolygon(indices) | (number[]) → void | Pridėti poligoną (trikampį arba keturkampį) |
| getElement(type) | (VertexElementType) → VertexElement | null | Gauti viršūnės elementą pagal semantiką |
| createElement(type) | (VertexElementType) → VertexElement | Sukurti viršūnės elementą |
Vietinė transformacija, taikoma mazgui.
| ————————- | ————————- | ————————————— |
| translation | Vector3 | Vietinė pozicija |
| eulerAngles | Vector3 | Eilerio sukimas laipsniais (XYZ tvarka) |
| rotation | Quaternion | Sukimas kaip kvaternionas |
| scaling | Vector3 | Vietinis mastelis |
Medžiagų klasės
| ————————- | —————————————- | ————————————————————– |
| LambertMaterial | Difuzinis + aplinkos šešėliavimas | diffuseColor, ambientColor, transparency |
| PhongMaterial | Prideda specular + emissive prie Lambert | specularColor, shininess, emissiveColor |
| PbrMaterial | Fizinio pagrindo glTF 2.0 | albedo, metallicFactor, roughnessFactor, emissiveColor |
Matematikos klasės
| ————————- | ————————————————————————— |
| Vector3 | 3-component double-precision vector (x, y, z) |
| Vector4 | 4-component vector for homogeneous math (x, y, z, w) |
| FVector3 | Viengubo tikslumo variantas, naudojamas viršūnių duomenyse |
| Matrix4 | 4×4 transformation matrix; multiply, invert, decompose |
| Quaternion | Sukimo kvaternionas; fromEulerAngle, toEulerAngles, slerp |
| BoundingBox | Ašies lygiuota ribinė dėžė; minimum, maximum, center, size, merge |
Animacijos klasės
| ————————- | ————————————————————————————— |
| AnimationClip | Pavadintas klipas; turi AnimationNode sąrašas; pasiekiamas per scene.animationClips |
| AnimationNode | Susieja klipą su pavadintu scenos mazgu; turi AnimationChannel sąrašas |
| AnimationChannel | Nurodo vieną savybę (pvz. translation X); talpina KeyframeSequence |
| KeyframeSequence | Rūšiuotas sąrašas KeyFrame objektų su interpolation ir extrapolation |
| KeyFrame | Vienas laiko/vertės pora |
| ————————- | ————————————————————– | ————————————————– |
| VertexElementType | NORMAL, UV, VERTEX_COLOR, BINORMAL, TANGENT | Viršūnės elemento semantika |
| MappingMode | CONTROL_POINT, POLYGON_VERTEX, POLYGON, ALL_SAME | Kaip duomenys susiejami su geometrija |
| ReferenceMode | DIRECT, INDEX, INDEX_TO_DIRECT | Indeksavimo strategija viršūnės elemento duomenims |
| Interpolation | CONSTANT, LINEAR, BEZIER | Raktų kadro interpoliacija |
| Extrapolation | CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE | Elgsena už raktinių kadrų intervalo |
Formato moduliai
Formato specifinės parinkčių klasės eksportuojamos iš sub‑kelio modulių. Importuokite jas atskirai:
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';OBJ modulis (@aspose/3d/formats/obj)
| ————————- | ——————————————————————— |
| ObjLoadOptions | enableMaterials, flipCoordinateSystem, scale, normalizeNormal |
glTF/GLB modulis (@aspose/3d/formats/gltf)
| ————————- | ——————————————————————– |
| GltfSaveOptions | binaryMode (true → .glb), flipTexCoordV |
| GltfFormat | GltfFormat.getInstance(): formato egzempliorius for scene.save() |
STL modulis (@aspose/3d/formats/stl)
| ————————- | ———————————————- |
| StlLoadOptions | N/A |
| StlSaveOptions | binaryMode (false → ASCII, true → binarinis) |
FBX modulis (@aspose/3d/formats/fbx)
| ————————- | ——————— |
| FbxLoadOptions | N/A |
| FbxSaveOptions | embedTextures |
Palaikomi formatai
| ————————- | ————————- | ————————- | ————————- |
| FBX | .fbx | Ne* | Ne* |
Greitosios nuorodos pavyzdys
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);