API Overview — @aspose/3d for TypeScript
Pakket: @aspose/3d (v24.12.0) Taal: TypeScript / Node.js 18+ Licentie: MIT
@aspose/3d is een MIT-gelicentieerde bibliotheek voor het lezen, construeren en exporteren van 3D‑scènes in Node.js. Het wordt geleverd met volledige TypeScript-typedefinities, een enkele runtime‑afhankelijkheid (xmldom), en ondersteunt zeven belangrijke 3D-bestandsformaten. Alle I/O is synchroon. Er zijn geen native add-ons vereist.
npm install @aspose/3d{
"compilerOptions": {
"target": "ES2020",
"module": "commonjs",
"moduleResolution": "node",
"esModuleInterop": true,
"strict": true
}
}Kernklassen
De rootcontainer voor een 3D‑scène. Alle inhoud; knooppunten, geometrie, materialen en animaties; wordt opgeslagen in een boom die is geworteld in scene.rootNode. Gebruik open() / openFromBuffer() om een bestand te laden en save() / saveToBuffer() exporteren.
| —————————- | ——————————— | —————————————————— |
| rootNode | Node | Root van de scenegraph |
| assetInfo | AssetInfo | Bestandsmetadata (maker, eenheden, coördinatensysteem) |
| animationClips | AnimationClip[] | Alle animatieclips in de scène |
| open(path, opts?) | (string, LoadOptions?) → void | Laad een bestand van schijf |
| openFromBuffer(buf, opts?) | (Buffer, LoadOptions?) → void | Laden vanuit in-memory buffer |
| save(path, opts?) | Transform | Opslaan naar schijf (formaat afgeleid van extensie) |
| saveToBuffer(ext, opts?) | (string, SaveOptions?) → Buffer | Opslaan naar in-memory buffer |
| createAnimationClip(name) | (string) → AnimationClip | Maak en registreer een nieuwe animatieclip |
Een benoemde boomknooppunt in de scènegrafiek. Knooppunten dragen een optionele Entity (mesh, camera, light) en een Transform die de knoop positioneert ten opzichte van zijn ouder.
| ————————- | ————————- | ————————————— |
| name | string | Knooppuntnaam |
| childNodes | Node[] | Directe kindknooppunten |
| entity | Entity | null | Aangehechte geometrie, camera of licht |
| transform | Transform | Lokale translatie, rotatie, schaal |
| materials | Material[] | Materialen toegewezen aan dit knooppunt |
| createChildNode(name) | (string) → Node | Voeg een kindknooppunt toe |
| getChildNode(name) | (string) → Node | null | Zoek een kind op naam |
Polygon mesh; het primaire geometrietype. Breidt uit Geometry.
| ————————- | ——————————————– | ————————————————- |
| controlPoints | Vector4[] | Vertexposities (w=1 voor posities) |
| polygonCount | number | Aantal polygonen |
| createPolygon(indices) | (number[]) → void | Voeg een polygoon toe (driehoek of quad) |
| getElement(type) | (VertexElementType) → VertexElement | null | Haal een vertex‑element op op basis van semantiek |
| createElement(type) | (VertexElementType) → VertexElement | Maak een vertex‑element aan |
Lokale transformatie toegepast op een knooppunt.
| ————————- | ————————- | ————————————– |
| translation | Vector3 | Lokale positie |
| eulerAngles | Vector3 | Euler-rotatie in graden (XYZ-volgorde) |
| rotation | Quaternion | Rotatie als een quaternion |
| scaling | Vector3 | Lokale schaal |
Materiaalklassen
| ————————- | —————————————– | ————————————————————– |
| LambertMaterial | Diffuse + ambient shading | diffuseColor, ambientColor, transparency |
| PhongMaterial | Voegt specular + emissive toe aan Lambert | specularColor, shininess, emissiveColor |
| PbrMaterial | Fysiek gebaseerd voor glTF 2.0 | albedo, metallicFactor, roughnessFactor, emissiveColor |
Wiskundeklassen
| ————————- | ——————————————————————————- |
| Vector3 | 3-component double-precision vector (x, y, z) |
| Vector4 | 4-component vector for homogeneous math (x, y, z, w) |
| FVector3 | Single-precision variant gebruikt in vertex data |
| Matrix4 | 4×4 transformation matrix; multiply, invert, decompose |
| Quaternion | Rotatiequaternion; fromEulerAngle, toEulerAngles, slerp |
| BoundingBox | As-uitgelijnde begrenzingsdoos; minimum, maximum, center, size, merge |
Animatieklassen
| ————————- | ——————————————————————————- |
| AnimationClip | Genaam clip; bevat AnimationNode lijst; benaderd via scene.animationClips |
| AnimationNode | Bindt een clip aan een genaamde sceneknoop; bevat AnimationChannel lijst |
| AnimationChannel | Richt zich op één eigenschap (bijv. translatie X); bevat een KeyframeSequence |
| KeyframeSequence | Geordende lijst van KeyFrame objecten met interpolation en extrapolation |
| KeyFrame | Enkele tijd/waarde-paar |
| ————————- | ————————————————————– | ——————————————– |
| VertexElementType | NORMAL, UV, VERTEX_COLOR, BINORMAL, TANGENT | Vertex-elementsemantiek |
| MappingMode | CONTROL_POINT, POLYGON_VERTEX, POLYGON, ALL_SAME | Hoe data wordt gemapt op geometrie |
| ReferenceMode | DIRECT, INDEX, INDEX_TO_DIRECT | Indexeringsstrategie voor vertex-elementdata |
| Interpolation | CONSTANT, LINEAR, BEZIER | Keyframe-interpolatie |
| Extrapolation | CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE | Gedrag buiten keyframe-bereik |
Formaatmodules
Formaat‑specifieke optieklassen worden geëxporteerd vanuit sub‑padmodules. Importeer ze afzonderlijk:
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-module (@aspose/3d/formats/obj)
| ————————- | ——————————————————————— |
| ObjLoadOptions | enableMaterials, flipCoordinateSystem, scale, normalizeNormal |
glTF/GLB-module (@aspose/3d/formats/gltf)
| ————————- | ————————————————————— |
| GltfSaveOptions | binaryMode (true → .glb), flipTexCoordV |
| GltfFormat | GltfFormat.getInstance(): formatinstantie voor scene.save() |
STL-module (@aspose/3d/formats/stl)
| ————————- | ——————————————- |
| StlLoadOptions | N/A |
| StlSaveOptions | binaryMode (false → ASCII, true → binair) |
FBX-module (@aspose/3d/formats/fbx)
| ————————- | ————— |
| FbxLoadOptions | N/A |
| FbxSaveOptions | embedTextures |
Ondersteunde formaten
| ————————- | ————————- | ————————- | ————————- |
| FBX | .fbx | Nee* | Nee* |
Snelreferentie-voorbeeld
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);