API Overview — @aspose/3d for TypeScript
Paket: @aspose/3d (v24.12.0) Språk: TypeScript / Node.js 18+ Licens: MIT
@aspose/3d är ett MIT-licensierat bibliotek för att läsa, konstruera och exportera 3D-scener i Node.js. Det levereras med kompletta TypeScript-typdefinitioner, ett enda runtime‑beroende (xmldom), och stödjer sju stora 3D‑filformat. All I/O är synkron. Inga inhemska tillägg krävs.
npm install @aspose/3d{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true
}
}Kärnklasser
Rotbehållaren för en 3D-scen. Allt innehåll; noder, geometri, material och animationer; lagras i ett träd rotat vid scene.rootNode.Använd open() / openFromBuffer() för att läsa in en fil och save() / saveToBuffer() för att exportera.
| —————————- | ——————————— | ———————————————— |
| rootNode | Node | Roten i scengrafen |
| assetInfo | AssetInfo | Filmetadata (skapare, enheter, koordinatsystem) |
| animationClips | AnimationClip[] | Alla animationsklipp i scenen |
| open(path, opts?) | (string, LoadOptions?) → void | Läs in en fil från disk |
| openFromBuffer(buf, opts?) | (Buffer, LoadOptions?) → void | Läs in från minnesbuffert |
| save(path, opts?) | Transform | Spara till disk (format härlett från filändelse) |
| saveToBuffer(ext, opts?) | (string, SaveOptions?) → Buffer | Spara till minnesbuffert |
| createAnimationClip(name) | (string) → AnimationClip | Skapa och registrera ett nytt animationsklipp |
En namngiven trädnod i scengrafen. Noder bär en valfri Entity (mesh, kamera, ljus) och en Transform som placerar noden relativt sin förälder.
| ————————- | ————————- | ———————————– |
| name | string | Nodnamn |
| childNodes | Node[] | Direkta barnnoder |
| entity | Entity | null | Bifogad geometri, kamera eller ljus |
| transform | Transform | Lokal translation, rotation, skala |
| materials | Material[] | Material som tilldelats denna nod |
| createChildNode(name) | (string) → Node | Lägg till en barnnod |
| getChildNode(name) | (string) → Node | null | Hitta ett barn efter namn |
Polygonmesh; den primära geometritypen. Utökar Geometry.
| ————————- | ——————————————– | ——————————————— |
| controlPoints | Vector4[] | Vertexpositioner (w=1 för positioner) |
| polygonCount | number | Antal polygoner |
| createPolygon(indices) | (number[]) → void | Lägg till en polygon (triangel eller fyrkant) |
| getElement(type) | (VertexElementType) → VertexElement | null | Hämta ett vertexelement efter semantik |
| createElement(type) | (VertexElementType) → VertexElement | Skapa ett vertexelement |
Lokal transformation som tillämpas på en nod.
| ————————- | ————————- | ————————————- |
| translation | Vector3 | Lokal position |
| eulerAngles | Vector3 | Euler-rotation i grader (XYZ-ordning) |
| rotation | Quaternion | Rotation som en kvaternion |
| scaling | Vector3 | Lokal skala |
Materialklasser
| ————————- | ——————————————- | ————————————————————– |
| LambertMaterial | Diffus + omgivande skuggning | diffuseColor, ambientColor, transparency |
| PhongMaterial | Lägger till spekulär + emissiv till Lambert | specularColor, shininess, emissiveColor |
| PbrMaterial | Fysikbaserad för glTF 2.0 | albedo, metallicFactor, roughnessFactor, emissiveColor |
Matematikklasser
| ————————- | —————————————————————————– |
| Vector3 | 3-component double-precision vector (x, y, z) |
| Vector4 | 4-component vector for homogeneous math (x, y, z, w) |
| FVector3 | Enkelprecision variant som används i vertexdata |
| Matrix4 | 4×4 transformation matrix; multiply, invert, decompose |
| Quaternion | Rotationskvaternion; fromEulerAngle, toEulerAngles, slerp |
| BoundingBox | Axeljusterad avgränsningsbox; minimum, maximum, center, size, merge |
Animationsklasser
| ————————- | ————————————————————————————- |
| AnimationClip | Namngiven clip; innehåller AnimationNode lista; åtkomlig via scene.animationClips |
| AnimationNode | Kopplar ett clip till en namngiven scennod; innehåller AnimationChannel lista |
| AnimationChannel | Målar mot en enskild egenskap (t.ex. translation X); innehåller en KeyframeSequence |
| KeyframeSequence | Ordnad lista över KeyFrame objekt med interpolation och extrapolation |
| KeyFrame | Enstaka tid/värde-par |
| ————————- | ————————————————————– | —————————————— |
| VertexElementType | NORMAL, UV, VERTEX_COLOR, BINORMAL, TANGENT | Vertex-elementsemantik |
| MappingMode | CONTROL_POINT, POLYGON_VERTEX, POLYGON, ALL_SAME | Hur data mappas till geometri |
| ReferenceMode | DIRECT, INDEX, INDEX_TO_DIRECT | Indexeringsstrategi för vertex-elementdata |
| Interpolation | CONSTANT, LINEAR, BEZIER | Interpolering av nyckelramar |
| Extrapolation | CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE | Beteende utanför nyckelbildsintervall |
Formatmoduler
Format‑specifika alternativklasser exporteras från sub‑sökvägsmoduler. Importera dem separat:
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-modul (@aspose/3d/formats/obj)
| ————————- | ——————————————————————— |
| ObjLoadOptions | enableMaterials, flipCoordinateSystem, scale, normalizeNormal |
glTF/GLB-modul (@aspose/3d/formats/gltf)
| ————————- | ———————————————————— |
| GltfSaveOptions | binaryMode (true → .glb), flipTexCoordV |
| GltfFormat | GltfFormat.getInstance(): formatinstans för scene.save() |
STL-modul (@aspose/3d/formats/stl)
| ————————- | —————————————— |
| StlLoadOptions | N/A |
| StlSaveOptions | binaryMode (false → ASCII, true → binär) |
FBX-modul (@aspose/3d/formats/fbx)
| ————————- | —————- |
| FbxLoadOptions | N/A |
| FbxSaveOptions | embedTextures |
Stödda format
| ————————- | ————————- | ————————- | ————————- |
| FBX | .fbx | Nej* | Nej* |
Exempel på snabbreferens
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);