Aspose.3D FOSS for TypeScript

Referenčná dokumentácia API pre @aspose/3d verzia 24.12.0. Inštalovať pomocou:

npm install @aspose/3d

Runtime: Node.js 18, 20, 22+ · Jazyk: TypeScript 5.0+ / JavaScript (CommonJS) · Licencia: MIT

Základný graf scény

ImageRenderOptions

Koreňový kontajner pre 3D scénu. Zavolajte scene.open() alebo scene.openFromBuffer() na načítanie súboru a scene.save() na zápis výstupu. Zverejňuje scene.rootNode ako vstupný bod do hierarchie uzlov.

ImageRenderOptions

Pomenovaný uzol v stromovej štruktúre scény. Obsahuje Transform, voliteľný entity (sieť, kamera, svetlo alebo iný SceneObject), a nula alebo viac podriadených uzlov prístupných cez childNodes.

ImageRenderOptions

Základná trieda pre všetky objekty, ktoré môžu byť pripojené k Node ako jej hlavnej entite. Podtriedou sú Mesh, Camera, Light, a ďalšie.

SceneObject

Abstraktný základ pre pomenované objekty, ktoré patria do scény. Poskytuje the name sledovanie vlastností a príslušnosti k scéne zdieľané uzlami, entitami a objektmi na úrovni aktív.

A3DObject

Koreňová základná trieda pre všetky Aspose.3D objekty. Poskytuje systém vlastností (getProperty, setProperty) a name pole zdedené každou verejnou triedou.

Geometria a sieť

ImageRenderOptions

Predstavuje polygonovú sieť. Obsahuje controlPoints pole Vector4 vrcholy a definície polygonov vytvorené pomocou createPolygon(). Zavolajte triangulate() na konverziu všetkých polygonov na trojuholníky pred exportom.

ImageRenderOptions

Základná trieda pre všetky typy geometrie. Obsahuje controlPoints a kolekciu prvkov vrcholov (normály, UV, farby) pripojených k geometrii.

VertexElement

Základná trieda pre kanály atribútov na úrovni vrchola pripojené k Geometry. Podtriedy nesú typované dátové polia a mappingMode / referenceMode metadáta.

VertexElementNormal

A VertexElement podtrieda, ktorá ukladá povrchové normály. Dáta sú uložené interne ako FVector4[] (zdedené z VertexElementFVector). Vyžadované väčšinou renderermi pre správne osvetlenie.

VertexElementUV

A VertexElement podtrieda, ktorá ukladá 2D textúrové súradnice. Jedna sieť môže mať viacero UV sád pre rôzne vrstvy textúr.

VertexElementVertexColor

A VertexElement podtrieda, ktorá ukladá hodnoty farby RGBA pre každý vrchol.

VertexElementType

Výpis typov kanálov atribútu, ktoré VertexElement môže reprezentovať (napr.,)., NORMAL, UV, VERTEX_COLOR, TANGENT, BINORMAL).

MappingMode

Výčtový typ riadiaci, ako sa dáta prvku mapujú na geometriu: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, alebo ALL_SAME.

ReferenceMode

Výčtový typ riadiaci, ako indexy prvkov odkazujú na dáta: DIRECT (jeden na jeden) alebo INDEX_TO_DIRECT (cez pole indexov).

TextureMapping

Výčtový typ semantík textúrových kanálov: DIFFUSE, SPECULAR, NORMAL, EMISSIVE, BUMP, a viac.

Transformácia a Priestor

ImageRenderOptions

Ukladá lokálnu pozíciu (translation), rotáciu (rotation ako Quaternion), a mierku (scaling) Node. Zmeny tu ovplyvňujú uzol a všetky jeho deti.

GlobalTransform

Zobrazenie len na čítanie transformácie uzla vo svetovom priestore, vypočítané akumuláciou všetkých predkov Transform hodnôt. Prístup cez node.globalTransform.

BoundingBox

Osa‑zarovnaný ohraničujúci box definovaný a minimum a maximum Vector3 roh. Používa sa na opis priestorového rozsahu siete alebo scény.

ImageRenderOptions

Material, LambertMaterial, PhongMaterial, PbrMaterial

Material je abstraktná základná trieda pre všetky typy materiálov. K dispozícii sú tri konkrétne implementácie:

  • LambertMaterial — iba difúzny s ambientnými, difúznymi a emisnými farebnými kanálmi. Vhodné pre nespekulárne povrchy.
  • PhongMaterial — rozširuje LambertMaterial s vlastnosťami spekularnej farby a lesku pre Phong shading.
  • PbrMaterial — materiál fyzicky založeného renderovania s kanálmi metalickosti, drsnosti, základnej farby a normálovej mapy. Priamo mapuje na model materiálu glTF 2.0 PBR.

Kamera a osvetlenie

ImageRenderOptions

Entita uzla pohľadu s typom projekcie, zorným poľom, vzdialenosťami blízkeho a vzdialeného orezania a vlastnosťami pomeru strán.

ImageRenderOptions

Entita uzla svetelného zdroja. Typ je riadený LightType enumeráciou.

LightType

Enumerácia podporovaných typov svetla: POINT, DIRECTIONAL, SPOT, AREA, VOLUME.

ProjectionType

Enumerácia režimov projekcie kamery: PERSPECTIVE a ORTHOGRAPHIC.

Matematické nástroje

ImageRenderOptions

Trojsložkový vektor s x, y, z polami a bežnými aritmetickými metódami (dot, cross, normalize, minus, times). Exportované z @aspose/3d/utilities.

ImageRenderOptions

Štvorzložkový vektor s x, y, z, w polami. Používa sa ako typ položiek v Mesh.controlPoints.

ImageRenderOptions

Dvojzložkový vektor s dvojitou presnosťou x a y polami. Používa sa pre UV textúrové súradnice.

FVector3

Kompaktný trojkomponentový vektor s jednoduchou presnosťou (float) používaný v poliach dát vertex elementov pre normály a tangenty.

ImageRenderOptions

4×4 transformačná matica. Podporuje zreťazenie, inverziu, transpozíciu a dekompozíciu na komponenty posunu, rotácie a mierky. Exportované z @aspose/3d/utilities.

ImageRenderOptions

Jednotkový kvaternion na reprezentáciu rotácií bez gimbal locku. Poskytuje slerp() pre plynulú interpoláciu a konverziu na/z Eulerove uhly a Matrix4. Exportované z @aspose/3d/utilities.

ImageRenderOptions

AnimationClip

Pomenovaná, časovo ohraničená zbierka AnimationNode stopa. Hlavný kontajner pre dáta kľúčových snímok animácie načítané z FBX alebo COLLADA súborov.

AnimationNode

Pomenovaná animačná stopa, ktorá cielení konkrétnu cestu vlastnosti na objekte scény. Obsahuje jeden alebo viac AnimationChannel objektov.

AnimationChannel

Jednotlivý animovaný kanál vlastnosti v rámci AnimationNode. Obsahuje KeyframeSequence pár čas/hodnota.

KeyFrame

Jednotlivý čas/hodnota vzorka v KeyframeSequence. Obsahuje časovú značku (v sekundách), hodnotu a informácie o tangente pre interpoláciu.

KeyframeSequence

Usporiadaný zoznam KeyFrame vzorky pre jeden kanál vlastnosti, spolu s Interpolation a Extrapolation nastaveniami, ktoré riadia prehrávanie.

ImageRenderOptions

Výčtový zoznam režimov interpolácie kľúčových snímok. Známe položky zahŕňajú LINEAR a CONSTANT. Ďalšie položky, ako napríklad BEZIER môže byť k dispozícii.

ImageRenderOptions

Definuje správanie mimo rozsahu kľúčových snímok (pred prvým kľúčom a po poslednom kľúči). Ovláda sa pomocou ExtrapolationType.

StepMode

Výčtový typ, ktorý určuje, ako sa na hraniciach aplikuje kroková (konštantná) interpolácia.

WeightedMode

Výčtový typ pre spracovanie váhy Bézierových tečných: NONE, OUT_WEIGHT, NEXT_IN_WEIGHT, alebo BOTH.

ExtrapolationType

Výčtový zoznam správania mimo rozsah: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, a OSCILLATE.

Formát I/O

FileFormat

Základný opisovač pre 3D formát súboru. Každý podporovaný formát poskytuje konkrétny singleton cez getInstance().

ImageRenderOptions

Základná trieda pre implementácie importu špecifické pre formát. Nie je inštanciovaná priamo; volaná interne scene.open().

ImageRenderOptions

Základná trieda pre implementácie exportu špecifické pre formát. Nie je inštanciovaná priamo; volaná interne scene.save().

LoadOptions

Základná trieda pre objekty možností načítania špecifické pre formát. Odovzdajte inštanciu podtriedy do scene.open() alebo scene.openFromBuffer().

SaveOptions

Základná trieda pre objekty možností ukladania špecifické pre formát. Odovzdajte inštanciu podtriedy do scene.save().

IOService

Interné rozhranie služby, ktoré abstrahuje vstup/výstup súborového systému a bufferu pre importéry a exportéry.

OBJ Format

OBJ podporuje import aj export. Pri ukladaní ako OBJ sa knižnica materiálov (.mtl) sa zapíše automaticky spolu s .obj súborom.

ObjImporter

Interný importér, ktorý číta Wavefront OBJ súbory, rieši .mtl knižnice materiálov a napĺňa a Scene. Volané automaticky, keď ObjLoadOptions je odovzdané do scene.open().

ObjExporter

Interný exportér, ktorý zapisuje Wavefront OBJ súbory. Sprievodný .mtl knižnica materiálov sa zapisuje automaticky. Vyvolá sa, keď scene.save() cieli na .obj cestu.

ObjLoadOptions

Načítajte možnosti pre súbory OBJ. Kľúčové vlastnosti: enableMaterials (boolean, predvolené true), flipCoordinateSystem (boolean), normalizeNormal (boolean, predvolené true), scale (number). Pozri Možnosti načítania a ukladania formátu pre podrobnosti.

ObjSaveOptions

Uložte možnosti pre export OBJ. Odovzdajte do scene.save() na kontrolu správania výstupu OBJ. Pozri Možnosti načítania a ukladania formátu pre podrobnosti.

ObjFormat

Jednotný popisovač formátu pre OBJ. Obe canImport a canExport sú true.

Formát glTF

GltfImporter

Číta glTF 2.0 JSON (.gltf).glb) súbory. Spracováva vložené a externé odkazy na buffery, PBR materiály, kožuchy a animácie.

GltfExporter

Zapíše výstup glTF 2.0. Keď GltfSaveOptions.binaryMode je true, vytvorí samostatný GLB; inak zapíše JSON .gltf s doplnkom .bin buffer.

GltfLoadOptions

Možnosti načítania pre súbory glTF/GLB. Ovláda riešenie bufferov a správanie načítania textúr.

GltfSaveOptions

Možnosti ukladania pre export glTF/GLB. Významné vlastnosti: binaryMode (boolean, true → GLB, predvolené false), flipTexCoordV (boolean, otáča vertikálnu os UV, predvolené true). Pozri Možnosti načítania a ukladania formátu pre úplné podrobnosti.

GltfFormat

Singleton popisovača formátu. Získajte cez GltfFormat.getInstance() a odovzdajte do scene.save() ako druhý argument.

Formát STL

StlImporter

Načíta oba typy súborov STL – ASCII aj binárne – do Scene obsahujúceho jeden Mesh entitu.

StlExporter

Zapíše binárny STL. Výstup obsahuje triangulovanú sieť zo scény; polygóny, ktoré nie sú trojuholníky, sa automaticky triangulujú.

StlLoadOptions

Možnosti načítania pre STL. Ovláda, či importér počas importu prevracia normály.

StlSaveOptions

Možnosti ukladania pre export STL. Kľúčová vlastnosť: binaryMode (boolean, predvolené false). Ovláda, či je výstup ASCII alebo binárny STL. Pozri Možnosti načítania a ukladania formátu pre úplné podrobnosti.

StlFormat

Singleton popisovača formátu. Získajte cez StlFormat.getInstance().

3MF Format

ThreeMfImporter

Číta archívy Open Packaging Convention 3MF a napĺňa Scene s sieťovými objektmi, farbami a vlastnosťami materiálu.

ThreeMfExporter

Zapíše platný archív 3MF z aktuálnej scény. Vhodné pre pracovné postupy 3D tlače.

ThreeMfLoadOptions

Možnosti načítania pre súbory 3MF.

ThreeMfSaveOptions

Možnosti ukladania pre export 3MF.

ThreeMfFormat

Singleton opisovača formátu. Získajte cez ThreeMfFormat.getInstance().

Formát FBX

FbxImporter

Číta binárne a ASCII súbory FBX vrátane geometrie, materiálov, kostry, blend shapes a animačných klipov.

FbxExporter

Zapíše FBX súbory z aktuálnej scény. Podľa nastavení sú podporované výstupy FBX v binárnom aj ASCII formáte.

FbxLoadOptions

Možnosti načítania pre FBX. Ovládajú, či sa importujú animácie, skiny a blend shapes.

FbxSaveOptions

Možnosti ukladania pre export FBX. Kľúčová vlastnosť: embedTextures (boolean, predvolené false) Možnosti načítania a ukladania formátu Pozri.

FbxFormat

Formátový popisovač singleton. Získajte cez FbxFormat.getInstance().

Formát COLLADA

Import a export COLLADA vyžadujú xmldom peer závislosť, ktorá sa automaticky nainštaluje s @aspose/3d.

ColladaImporter

Číta COLLADA (.dae) xmldom. Spracováva geometriu, materiály, kamery, svetlá a animáciu.

ColladaExporter

Zapíše výstup COLLADA XML z aktuálnej scény. Vhodné na výmenu s DCC nástrojmi (Blender, Maya, atď.).

ColladaFormat

Formátový popisovač singleton. Získajte cez ColladaFormat.getInstance().

Systém vlastností

ImageRenderOptions

Typovaný pár názov/hodnota, ktorý môže byť pripojený k akémukoľvek A3DObject. Podporuje skalárne a vektorové typy hodnôt.

PropertyCollection

Usporiadaný kontajner Property objektov. Prístupný na akomkoľvek A3DObject prostredníctvom properties prístupu.

CustomObject

Voľne definovaný kontajner vlastností, ktorý rozširuje A3DObject. Používa sa na uloženie ľubovoľných metadát, ktoré neodpovedajú štandardnej triede.

Informácie o aktíve

AssetInfo

Obsahuje metadáta úrovne scény načítané zo zdrojového súboru: autor, názov aplikácie, dátum vytvorenia, mierka jednotiek a informácie o osiach súradníc.

ImageRenderOptions

Možnosti ovládajúce, ako sa textúry a obrázky riešia a kódujú pri ukladaní do formátov, ktoré vkladajú obrazové dáta (napr. GLB s binaryMode: true).

Pozri tiež

 Slovenčina