API Overview — @aspose/3d for TypeScript

Package: @aspose/3d (v24.12.0) · Language: TypeScript / Node.js 18+ · License: MIT

@aspose/3d is an MIT-licensed library for reading, building, and exporting 3D scenes in Node.js. It ships with full TypeScript type definitions, a single runtime dependency (xmldom), and supports seven major 3D file formats. All I/O is synchronous. No native modules are required.

npm install @aspose/3d@24.12.0

tsconfig.json settings for correct subpath resolution:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "strict": true
  }
}

Core Classes

Scene

The root container of a 3D scene. All content — nodes, geometry, materials, and animations — is stored in a tree rooted at scene.rootNode. Use open() / openFromBuffer() to load a file and save() / saveToBuffer() to export.

Node

A named tree node in the scene graph. Nodes carry an optional Entity (mesh, camera, light) and a Transform that positions the node relative to its parent.

Mesh

Polygon mesh; the primary geometry type. Extends Geometry.

Transform

Local transformation applied to a node.

Material Classes

Math Classes

Animation Classes

Enumerations

Format Modules

Format-specific option classes are exported from subpath modules. Import them separately:

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)

glTF/GLB Module (@aspose/3d/formats/gltf)

STL Module (@aspose/3d/formats/stl)

FBX Module (@aspose/3d/formats/fbx)

Supported Formats

Quick Reference Example

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);

See Also

• Scene class
• Node class
• Mesh class
• Features and capabilities
• Format support

Related Resources

• Aspose.3D — Enterprise Product Family