API Overview

API Overview — @aspose/3d for TypeScript

Pakiet: @aspose/3d (v24.12.0) Język: TypeScript / Node.js 18+ Licencja: MIT

@aspose/3d jest biblioteką na licencji MIT do odczytu, konstruowania i eksportowania scen 3D w Node.js. Dostarcza pełne definicje typów TypeScript, jedną zależność w czasie wykonywania (xmldom), i wspiera siedem głównych formatów plików 3D. Cały I/O jest synchroniczny. Nie są wymagane natywne dodatki.

npm install @aspose/3d

tsconfig.json ustawienia dla prawidłowego rozwiązywania podścieżek:

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

Klasy podstawowe

Główny kontener sceny 3D. Cała zawartość; węzły, geometria, materiały i animacje; jest przechowywana w drzewie z korzeniem w scene.rootNode.Użyj open() / openFromBuffer() aby wczytać plik i save() / saveToBuffer() do eksportu.


`rootNode`	`Node`	Korzeń grafu sceny
`assetInfo`	`AssetInfo`	Metadane pliku (twórca, jednostki, układ współrzędnych)
`animationClips`	`AnimationClip[]`	Wszystkie klipy animacji w scenie
`open(path, opts?)`	`(string, LoadOptions?) → void`	Wczytaj plik z dysku
`openFromBuffer(buf, opts?)`	`(Buffer, LoadOptions?) → void`	Załaduj z bufora w pamięci
`save(path, opts?)`	`(string, SaveOptions?) → void`	Zapisz na dysk (format określany na podstawie rozszerzenia)
`saveToBuffer(ext, opts?)`	`(string, SaveOptions?) → Buffer`	Zapisz do bufora w pamięci
`createAnimationClip(name)`	`(string) → AnimationClip`	Utwórz i zarejestruj nowy klip animacji

Nazwany węzeł drzewa w grafie sceny. Węzły niosą opcjonalny Entity (mesh, camera, light) i Transform która pozycjonuje węzeł względem jego rodzica.


`name`	`string`	Nazwa węzła
`childNodes`	`Node[]`	Bezpośrednie węzły potomne
`entity`	`Entity	null`
`transform`	`Transform`	Lokalna translacja, rotacja, skalowanie
`materials`	`Material[]`	Materiały przypisane do tego węzła
`createChildNode(name)`	`(string) → Node`	Dodaj węzeł potomny
`getChildNode(name)`	`(string) → Node	null`

Siatka wielokątowa; podstawowy typ geometrii. Rozszerza Geometry.


`controlPoints`	`Vector4[]`	Pozycje wierzchołków (w=1 dla pozycji)
`polygonCount`	`number`	Liczba wielokątów
`createPolygon(indices)`	`(number[]) → void`	Dodaj wielokąt (trójkąt lub czworokąt)
`getElement(type)`	`(VertexElementType) → VertexElement	null`
`createElement(type)`	`(VertexElementType) → VertexElement`	Utwórz element wierzchołka

Lokalna transformacja zastosowana do węzła.


`translation`	`Vector3`	Pozycja lokalna
`eulerAngles`	`Vector3`	Rotacja Eulera w stopniach (kolejność XYZ)
`rotation`	`Quaternion`	Rotacja jako kwaternion
`scaling`	`Vector3`	Skala lokalna

Klasy materiałów

		Kluczowe właściwości
`LambertMaterial`	Rozproszone + cieniowanie otoczenia	`diffuseColor`, `ambientColor`, `transparency`
`PhongMaterial`	Dodaje odbicia + emisję do Lambert	`specularColor`, `shininess`, `emissiveColor`
`PbrMaterial`	Oparte na fizyce dla glTF 2.0	`albedo`, `metallicFactor`, `roughnessFactor`, `emissiveColor`

Klasy matematyczne


`Vector3`	3-component double-precision vector (`x`, `y`, `z`)
`Vector4`	4-component vector for homogeneous math (`x`, `y`, `z`, `w`)
`FVector3`	Wariant single-precision używany w danych wierzchołków
`Matrix4`	4×4 transformation matrix; `multiply`, `invert`, `decompose`
`Quaternion`	Quaternion obrotu; `fromEulerAngle`, `toEulerAngles`, `slerp`
`BoundingBox`	Prostopadłościan ograniczający wyrównany do osi; `minimum`, `maximum`, `center`, `size`, `merge`

Klasy animacji


`AnimationClip`	Nazwany clip; zawiera `AnimationNode` lista; dostępna przez `scene.animationClips`
`AnimationNode`	Łączy clip z nazwanym scene node; zawiera `AnimationChannel` lista
`AnimationChannel`	Celuje w pojedynczą właściwość (np. translation X); przechowuje a `KeyframeSequence`
`KeyframeSequence`	Uporządkowana lista `KeyFrame` obiekty z `interpolation` i `extrapolation`
`KeyFrame`	Pojedyncza para czas/wartość


`VertexElementType`	`NORMAL`, `UV`, `VERTEX_COLOR`, `BINORMAL`, `TANGENT`	Semantyka elementu wierzchołka
`MappingMode`	`CONTROL_POINT`, `POLYGON_VERTEX`, `POLYGON`, `ALL_SAME`	Jak dane mapują się na geometrię
`ReferenceMode`	`DIRECT`, `INDEX`, `INDEX_TO_DIRECT`	Strategia indeksowania danych elementu wierzchołka
`Interpolation`	`CONSTANT`, `LINEAR`, `BEZIER`	Interpolacja klatek kluczowych
`Extrapolation`	`CONSTANT`, `GRADIENT`, `CYCLE`, `CYCLE_RELATIVE`, `OSCILLATE`	Zachowanie poza zakresem klatek kluczowych

Moduły formatów

Klasy opcji specyficznych dla formatu są eksportowane z modułów podścieżek. Importuj je osobno:

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

Moduł OBJ (`@aspose/3d/formats/obj`)

	Kluczowe opcje
`ObjLoadOptions`	`enableMaterials`, `flipCoordinateSystem`, `scale`, `normalizeNormal`

Moduł glTF/GLB (`@aspose/3d/formats/gltf`)

	Kluczowe opcje
`GltfSaveOptions`	`binaryMode` (true → .glb), `flipTexCoordV`
`GltfFormat`	`GltfFormat.getInstance()`:instancja formatu dla `scene.save()`

Moduł STL (`@aspose/3d/formats/stl`)

	Kluczowe opcje
`StlLoadOptions`	N/A
`StlSaveOptions`	`binaryMode` (false → ASCII, true → binarny)

Moduł FBX (`@aspose/3d/formats/fbx`)

	Kluczowe opcje
`FbxLoadOptions`	N/A
`FbxSaveOptions`	`embedTextures`

Obsługiwane formaty


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

Przykład szybkiego odniesienia

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