API Overview

API Overview — @aspose/3d for TypeScript

Пакет: @аспоз/3d (v24.12.0) · Език: TypeScript / Node.js 18+ · Лиценз: MIT

@aspose/3d е лицензирана от MIT библиотека за четене, изграждане и изнасяне на 3D сцени в Node.js. Тя се доставя с пълни дефиниции от типа TypeScript , една единствена зависимост по време на изпълнение (xmldom), и поддържа седем основни 3D формата на файловете.Всички I/O са синхронни.Не е необходимо да има собствени модули.

npm install @aspose/3d@24.12.0

tsconfig.json настройки за правилна резолюция на подпът:

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

Основни класове

`Scene`

Всички съдържания възела, геометрия, материали и анимации ?? се съхраняват в дърво с корени на scene.rootNode.Използвайте. open() / openFromBuffer() за зареждане на файл и save() / saveToBuffer() за износ.

Член на Съвета	Тип на изпитване	Описание на състоянието
`rootNode`	`Node`	Корен на графиката за сцената
`assetInfo`	`AssetInfo`	Метаданни на файла (създател, единици, координатна система)
`animationClips`	`AnimationClip[]`	Всички анимационни клипове в сцената.
`open(path, opts?)`	`(string, LoadOptions?) → void`	Зареждане на файл от диска
`openFromBuffer(buf, opts?)`	`(Buffer, LoadOptions?) → void`	Натоварване от буфера в паметта
`save(path, opts?)`	`(string, SaveOptions?) → void`	Запишете на диск (формата, извлечен от разширението)
`saveToBuffer(ext, opts?)`	`(string, SaveOptions?) → Buffer`	Запазване в буфера на паметта
`createAnimationClip(name)`	`(string) → AnimationClip`	Създаване и регистриране на нов анимационен клип

`Node`

Наречен дървесен възел в графиката на сцената. Entity (мешка, камера, светлина) и Transform което позиционира възела по отношение на родителския му.

Член на Съвета	Тип на изпитване	Описание на състоянието
`name`	`string`	Име на възел
`childNodes`	`Node[]`	Директни подчинени възли
`entity`	`Entity	null`
`transform`	`Transform`	Местни преводи, ротация и мащаб
`materials`	`Material[]`	Материали, възложени на този възел
`createChildNode(name)`	`(string) → Node`	Добавяне на подчинен възел
`getChildNode(name)`	`(string) → Node	null`

`Mesh`

Полигонна мрежа; първичен тип геометрия. Разширява се Geometry.

Член на Съвета	Тип на изпитване	Описание на състоянието
`controlPoints`	`Vector4[]`	Позиции на върховете (w=1 за позициите)
`polygonCount`	`number`	Броят на многоъгълниците
`createPolygon(indices)`	`(number[]) → void`	Добавете многоъгълник (триъгълен или четворен)
`getElement(type)`	`(VertexElementType) → VertexElement	null`
`createElement(type)`	`(VertexElementType) → VertexElement`	Създаване на елемент за върх

`Transform`

Локална трансформация, приложена към възел.

Член на Съвета	Тип на изпитване	Описание на състоянието
`translation`	`Vector3`	Местна позиция
`eulerAngles`	`Vector3`	Ротация на Ойлър в градуси (поред XYZ)
`rotation`	`Quaternion`	Кватернионно въртене
`scaling`	`Vector3`	Местни размери

Класове материали

Класът	Описание на състоянието	Основни свойства
`LambertMaterial`	Дифузно + обкръжаващо засенчване	`diffuseColor`, `ambientColor`, `transparency`
`PhongMaterial`	Добавя огледален + емисивен към Ламберт.	`specularColor`, `shininess`, `emissiveColor`
`PbrMaterial`	Физически базирани за glTF 2.0	`albedo`, `metallicFactor`, `roughnessFactor`, `emissiveColor`

Уроци по математика.

Класът	Описание на състоянието
`Vector3`	3-component double-precision vector (`x`, `y`, `z`)
`Vector4`	4-component vector for homogeneous math (`x`, `y`, `z`, `w`)
`FVector3`	Единна прецизна вариант, използвана в данни за върховете
`Matrix4`	4×4 transformation matrix; `multiply`, `invert`, `decompose`
`Quaternion`	Ротационен квартион; `fromEulerAngle`, `toEulerAngles`, `slerp`
`BoundingBox`	Ограничителна кутия, изравнена с оста; `minimum`, `maximum`, `center`, `size`, `merge`

Клас на анимация.

Класът	Описание на състоянието
`AnimationClip`	Названо клип; съдържа: `AnimationNode` списък; достъпни чрез: `scene.animationClips`
`AnimationNode`	Свързва клип към именуван възел на сцена; съдържа: `AnimationChannel` списък на
`AnimationChannel`	Целира едно свойство (напр. превод X); притежава един `KeyframeSequence`
`KeyframeSequence`	Поръчен списък на: `KeyFrame` обекти с: `interpolation` и в) `extrapolation`
`KeyFrame`	Единствено време/ценен двойка

Изброявания

Енум	Стойности	Описание на състоянието
`VertexElementType`	`NORMAL`, `UV`, `VERTEX_COLOR`, `BINORMAL`, `TANGENT`	Семантичен елемент на върха
`MappingMode`	`CONTROL_POINT`, `POLYGON_VERTEX`, `POLYGON`, `ALL_SAME`	Как данните се картографират с геометрията
`ReferenceMode`	`DIRECT`, `INDEX`, `INDEX_TO_DIRECT`	Стратегия за индексиране на данни от вертексните елементи
`Interpolation`	`CONSTANT`, `LINEAR`, `BEZIER`	Интерполация на ключови рамки
`Extrapolation`	`CONSTANT`, `GRADIENT`, `CYCLE`, `CYCLE_RELATIVE`, `OSCILLATE`	Поведение извън обхвата на ключовите рамки

Форматиращи модули

Класовете за опции, специфични за формат, се изнасят от модули на подпът. Импортирайте ги отделно:

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 (`@aspose/3d/formats/obj`)

Класът	Основни опции
`ObjLoadOptions`	`enableMaterials`, `flipCoordinateSystem`, `scale`, `normalizeNormal`

Модул glTF/GLB (`@aspose/3d/formats/gltf`)

Класът	Основни опции
`GltfSaveOptions`	`binaryMode` (истинско → .glb), `flipTexCoordV`
`GltfFormat`	`GltfFormat.getInstance()`: формат на екземпляр за: `scene.save()`

STL модул (`@aspose/3d/formats/stl`)

Класът	Основни опции
`StlLoadOptions`	N/A
`StlSaveOptions`	`binaryMode` (false → ASCII, true → двоичен)

FBX модул (`@aspose/3d/formats/fbx`)

Класът	Основни опции
`FbxLoadOptions`	N/A
`FbxSaveOptions`	`embedTextures`

Поддържани формати

Формат на изображението	Разширяване на срока	Зареждане	Запиши
Обратно на обръщение (OBJ)	`.obj`	Да, да. - Какво?	Да, да. - Какво?
glTF 2.0 (включително слънчеви)	`.gltf`	Да, да. - Какво?	Да, да. - Какво?
GLB (binary glTF) - Какво?	`.glb`	Да, да. - Какво?	Да, да. - Какво?
STL	`.stl`	Да, да. - Какво?	Да, да. - Какво?
FBX	`.fbx`	Не, не мога.	Не, не мога.
COLLADA	`.dae`	Да, да. - Какво?	Да, да. - Какво?
3MF	`.3mf`	Да, да. - Какво?	Да, да. - Какво?

Бърз пример за справка

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

Вижте също:

Свързани ресурси

Aspose.3D Семейство продукти на предприятието