API Overview

API Overview — @aspose/3d for TypeScript

Pakke: @aspose/3d (v24.12.0) Språk: TypeScript / Node.js 18+ Lisens: MIT

@aspose/3d er et MIT-lisensiert bibliotek for lesing, konstruksjon og eksport av 3D‑scener i Node.js. Det leveres med komplette TypeScript‑type‑definisjoner, en enkelt kjøretidsavhengighet (xmldom), og støtter syv store 3D‑filformater. All I/O er synkron. Ingen native‑tillegg er påkrevd.

npm install @aspose/3d

tsconfig.json innstillinger for korrekt understi-oppløsning:

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

Kjerneklasser

Rotbeholderen for en 3D‑scene. Alt innhold; noder, geometri, materialer og animasjoner; lagres i et tre med rot i scene.rootNode.Bruk open() / openFromBuffer() for å laste inn en fil og save() / saveToBuffer() for å eksportere.


`rootNode`	`Node`	Roten til scenegrafen
`assetInfo`	`AssetInfo`	Filmetadata (oppretter, enheter, koordinatsystem)
`animationClips`	`AnimationClip[]`	Alle animasjonsklipp i scenen
`open(path, opts?)`	`(string, LoadOptions?) → void`	Last inn en fil fra disk
`openFromBuffer(buf, opts?)`	`(Buffer, LoadOptions?) → void`	Last fra minnebuffer
`save(path, opts?)`	`(string, SaveOptions?) → void`	Lagre til disk (formatet blir utledet fra filendelsen)
`saveToBuffer(ext, opts?)`	`(string, SaveOptions?) → Buffer`	Lagre til minnebuffer
`createAnimationClip(name)`	`(string) → AnimationClip`	Opprett og registrer et nytt animasjonsklipp

En navngitt tre-node i scenegrafen. Noder bærer en valgfri Entity (mesh, camera, light) og en Transform som posisjonerer noden i forhold til dens forelder.


`name`	`string`	Nodenavn
`childNodes`	`Node[]`	Direkte barnenoder
`entity`	`Entity	null`
`transform`	`Transform`	Lokal translasjon, rotasjon, skalering
`materials`	`Material[]`	Materialer tilordnet denne noden
`createChildNode(name)`	`(string) → Node`	Legg til en barnenode
`getChildNode(name)`	`(string) → Node	null`

Polygon-mesh; den primære geometritypen. Utvider Geometry.


`controlPoints`	`Vector4[]`	Vertex-posisjoner (w=1 for posisjoner)
`polygonCount`	`number`	Antall polygoner
`createPolygon(indices)`	`(number[]) → void`	Legg til et polygon (trekant eller firkant)
`getElement(type)`	`(VertexElementType) → VertexElement	null`
`createElement(type)`	`(VertexElementType) → VertexElement`	Opprett et vertex-element

Lokal transformasjon anvendt på en node.


`translation`	`Vector3`	Lokal posisjon
`eulerAngles`	`Vector3`	Euler-rotasjon i grader (XYZ-rekkefølge)
`rotation`	`Quaternion`	Rotasjon som en kvaternion
`scaling`	`Vector3`	Lokal skala

Materialklasser

		Nøkkelegenskaper
`LambertMaterial`	Diffus + omgivende skyggelegging	`diffuseColor`, `ambientColor`, `transparency`
`PhongMaterial`	Legger til spekulær + emissiv til Lambert	`specularColor`, `shininess`, `emissiveColor`
`PbrMaterial`	Fysisk-basert for glTF 2.0	`albedo`, `metallicFactor`, `roughnessFactor`, `emissiveColor`

Matematiske klasser


`Vector3`	3-component double-precision vector (`x`, `y`, `z`)
`Vector4`	4-component vector for homogeneous math (`x`, `y`, `z`, `w`)
`FVector3`	Enkeltpresisjonsvariant brukt i vertex-data
`Matrix4`	4×4 transformation matrix; `multiply`, `invert`, `decompose`
`Quaternion`	Rotasjonskvaternion; `fromEulerAngle`, `toEulerAngles`, `slerp`
`BoundingBox`	Aksialt justert avgrensningsboks; `minimum`, `maximum`, `center`, `size`, `merge`

Animatjonsklasser


`AnimationClip`	Navngitt klipp; inneholder `AnimationNode` liste; aksessert via `scene.animationClips`
`AnimationNode`	Binder et klipp til en navngitt scenenode; inneholder `AnimationChannel` liste
`AnimationChannel`	Målretter en enkelt egenskap (f.eks. oversettelse X); inneholder en `KeyframeSequence`
`KeyframeSequence`	Ordnet liste over `KeyFrame` objekter med `interpolation` og `extrapolation`
`KeyFrame`	Enkelt tid/verdipar


`VertexElementType`	`NORMAL`, `UV`, `VERTEX_COLOR`, `BINORMAL`, `TANGENT`	Vertex-element semantikk
`MappingMode`	`CONTROL_POINT`, `POLYGON_VERTEX`, `POLYGON`, `ALL_SAME`	Hvordan data kartlegges til geometri
`ReferenceMode`	`DIRECT`, `INDEX`, `INDEX_TO_DIRECT`	Indekseringsstrategi for vertex-elementdata
`Interpolation`	`CONSTANT`, `LINEAR`, `BEZIER`	Keyframe-interpolasjon
`Extrapolation`	`CONSTANT`, `GRADIENT`, `CYCLE`, `CYCLE_RELATIVE`, `OSCILLATE`	Oppførsel utenfor nøkkelbildeområdet

Formatmoduler

Formatspesifikke alternativklasser eksporteres fra under‑sti‑moduler. Importer 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`)

	Nøkkelalternativer
`ObjLoadOptions`	`enableMaterials`, `flipCoordinateSystem`, `scale`, `normalizeNormal`

glTF/GLB-modul (`@aspose/3d/formats/gltf`)

	Nøkkelalternativer
`GltfSaveOptions`	`binaryMode` (true → .glb), `flipTexCoordV`
`GltfFormat`	`GltfFormat.getInstance()`: formatinstans for `scene.save()`

STL-modul (`@aspose/3d/formats/stl`)

	Nøkkelalternativer
`StlLoadOptions`	N/A
`StlSaveOptions`	`binaryMode` (false → ASCII, true → binær)

FBX-modul (`@aspose/3d/formats/fbx`)

	Nøkkelalternativer
`FbxLoadOptions`	N/A
`FbxSaveOptions`	`embedTextures`

Støttede formater


	`.obj`
glTF 2.0	`.gltf`
	`.glb`
STL	`.stl`
FBX	`.fbx`	Nei*	Nei*
COLLADA	`.dae`
3MF	`.3mf`

Rask referanseeksempel

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