Aspose.3D FOSS for TypeScript

API-referencia a @aspose/3d verzió 24.12.0. Telepítés módja:

npm install @aspose/3d

Futtatókörnyezet: Node.js 18, 20, 22+ · Nyelv: TypeScript 5.0+ / JavaScript (CommonJS) · Licenc: MIT


Alap Jelenetgrafikon

ImageRenderOptions

A 3D jelenet gyökérkonténere. Hívja scene.open() vagy scene.openFromBuffer() a fájl betöltéséhez, és scene.save() a kimenet írásához. Kitetti scene.rootNode mint a csomópont-hierarchia belépési pontját.

ImageRenderOptions

Egy elnevezett csomópont a jelenetfában. Tartalmaz egy Transform, egy opcionális entity (háló, kamera, fény vagy más SceneObject), és nulla vagy több gyermekcsomópontot, amely elérhető a childNodes.

ImageRenderOptions

Alaposztály minden olyan objektumhoz, amely csatolható egy Node mint elsődleges entitása. Leszármaztatva a Mesh, Camera, Light, és mások.

SceneObject

Absztrakt alap az elnevezett objektumok számára, amelyek egy jelenethez tartoznak. Biztosítja a name tulajdonság- és jelenet-tagság nyomon követése, amelyet a csomópontok, entitások és eszközszintű objektumok közösen használnak.

A3DObject

Gyökér alaposztály minden Aspose.3D objektumhoz. Biztosítja a tulajdonság rendszert (getProperty, setProperty) és a name mező, amelyet minden nyilvános osztály örököl.


Geometria és háló

ImageRenderOptions

Poligon hálót reprezentál. Tartalmaz egy controlPoints tömböt Vector4 csúcsok és poligon definíciók, amelyeket a createPolygon(). Hívja a triangulate() az összes poligont háromszögekké konvertálni exportálás előtt.

ImageRenderOptions

Alaposztály minden geometriai típushoz. Tartalmazza controlPoints és a geometriahoz csatolt csúcs elemek (normálok, UV-k, színek) gyűjteményét.

VertexElement

Alaposztály a csúcsonkénti attribútum csatornákhoz, amelyek egy Geometry. Az alosztályok típusos adat tömböket és mappingMode / referenceMode metaadatokat.

VertexElementNormal

Egy VertexElement alaposztály, amely felületi normálokat tárol. Az adat belsőleg úgy van tárolva, mint FVector4[] (örökölve a VertexElementFVector). A legtöbb renderelő számára szükséges a helyes megvilágításhoz.

VertexElementUV

Egy VertexElement alaposztály, amely 2D textúra koordinátákat tárol. Egyetlen háló több UV készlettel is rendelkezhet különböző textúra rétegekhez.

VertexElementVertexColor

A VertexElement alosztály, amely csúcsonkénti RGBA színértékeket tárol.

VertexElementType

Az attribútumcsatorna típusok felsorolása, amely egy VertexElement képviselhet (pl., NORMAL, UV, VERTEX_COLOR, TANGENT, BINORMAL).

MappingMode

Az elemadatok geometriára történő leképezését szabályozó felsorolás: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, vagy ALL_SAME.

ReferenceMode

Az elemindexek adatreferenciáját szabályozó felsorolás: DIRECT (egy‑egy) vagy INDEX_TO_DIRECT (index tömbön keresztül).

TextureMapping

A textúra csatorna szemantikai jelentéseinek felsorolása: DIFFUSE, SPECULAR, NORMAL, EMISSIVE, BUMP, és továbbiak.


Transzformáció és Térbeli

ImageRenderOptions

Tartalmazza a helyi pozíciót (translation), forgás (rotation mint Quaternion), és méret (scaling) egy Node. A változások itt a csomópontot és minden gyermekét érintik.

GlobalTransform

Csak olvasható nézet egy csomópont világkoordinátás transzformációjáról, amelyet az összes ős transzformációk felhalmozásával számítanak ki Transform értékek. Hozzáférés a node.globalTransform.

BoundingBox

Egy tengelyekhez igazított határoló doboz, amelyet egy minimum és maximum Vector3 sarok. A háló vagy jelenet térbeli kiterjedésének leírására használják.


ImageRenderOptions

Material, LambertMaterial, PhongMaterial, PbrMaterial

A Material az összes anyagtípus absztrakt alaposztálya. Három konkrét megvalósítás érhető el:

  • LambertMaterial — diffuse-only, ambient, diffuse és emissive színcsatornákkal. Nem spekuláris felületekhez alkalmas.
  • PhongMaterial — kiterjeszti LambertMaterial speculáris szín és fényesség tulajdonságokkal a Phong árnyaláshoz.
  • PbrMaterial — fizikailag alapú renderelési anyag fémes, durvaság, alapszín és normál térkép csatornákkal. Közvetlenül a glTF 2.0 PBR anyagmodellhez térképezi.

Kamera és megvilágítás

ImageRenderOptions

Egy nézőpont csomópont entitás, amely projekció típussal, látószöggel, közeli/távoli vágási távolságokkal és képarány tulajdonságokkal rendelkezik.

ImageRenderOptions

Egy fényforrás csomópont entitás. A típust a LightType enumeráció.

LightType

A támogatott fény típusok felsorolása: POINT, DIRECTIONAL, SPOT, AREA, VOLUME.

ProjectionType

A kamera projekciós módok felsorolása: PERSPECTIVE és ORTHOGRAPHIC.


Matematikai segédeszközök

ImageRenderOptions

Háromkomponensű lebegőpontos vektor a x, y, z mezőkkel és általános aritmetikai módszerekkel (dot, cross, normalize, minus, times). Exportálva innen @aspose/3d/utilities.

ImageRenderOptions

Négy komponensű lebegőpontos vektor, amely x, y, z, w mezők. Használják a bejegyzések típusaként a Mesh.controlPoints.

ImageRenderOptions

Két komponensű dupla pontosságú vektor, amely x és y mezők. UV textúra koordinátákhoz használják.

FVector3

Egy kompakt háromkomponensű, egyszeres pontosságú lebegőpontos vektor, amely a csúcs elem adat tömbökben a normálok és érintők számára használatos.

ImageRenderOptions

Egy 4×4 transzformációs mátrix. Támogatja az összefűzést, inverziót, transzpozíciót, valamint a transzláció, rotáció és skálázás komponensekre való felbontást. Exportálva innen @aspose/3d/utilities.

ImageRenderOptions

Egy egységkvaternion a forgatások gimbal lock nélküli ábrázolásához. Biztosítja slerp() a sima interpolációhoz és az Euler‑szögek közötti/az Euler‑szögekből történő konverzióhoz Matrix4. Exportálva innen @aspose/3d/utilities.


ImageRenderOptions

AnimationClip

Egy névvel ellátott, időkorlátos gyűjtemény AnimationNode sávok. Az elsődleges tároló a FBX vagy COLLADA fájlokból betöltött kulcskocka-animációs adatok számára.

AnimationNode

Egy névvel ellátott animációs sáv, amely egy adott tulajdonságútra céloz egy jelenetobjektumon. Egy vagy több AnimationChannel objektumot.

AnimationChannel

Egyetlen animált tulajdonságcsatorna egy AnimationNode. Tartalmaz egy KeyframeSequence idő/érték párok sorozatát.

KeyFrame

Egyetlen idő/érték minta egy KeyframeSequence. Tartalmazza az időbélyeget (másodpercben), az értéket, valamint a tangens információkat az interpolációhoz.

KeyframeSequence

Rendezett lista a KeyFrame mintákról egy tulajdonságcsatornához, valamint a Interpolation és Extrapolation beállítások, amelyek a lejátszást szabályozzák.

ImageRenderOptions

Kulcskocka-interpolációs módok felsorolása. Ismert elemek közé tartozik LINEAR és CONSTANT. További elemek, például BEZIER elérhető lehet.

ImageRenderOptions

Meghatározza a viselkedést a kulcskocka-tartományon kívül (az első kulcs előtt és az utolsó kulcs után). Irányítja a ExtrapolationType.

StepMode

Felsorolás, amely szabályozza, hogyan alkalmazzák a lépcsőzetes (konstans) interpolációt a határokon.

WeightedMode

Enumeráció a Bezier érintő súlykezeléséhez: NONE, OUT_WEIGHT, NEXT_IN_WEIGHT, vagy BOTH.

ExtrapolationType

A tartományon kívüli viselkedések felsorolása: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, és OSCILLATE.


Formátum I/O

FileFormat

Alap leíró egy 3D fájlformátumhoz. Minden támogatott formátum konkrét singleton-t biztosít a getInstance().

ImageRenderOptions

Alaposztály a formátum-specifikus import megvalósításokhoz. Nem példányosítják közvetlenül; belsőleg hívja a scene.open().

ImageRenderOptions

Alaposztály a formátum-specifikus export megvalósításokhoz. Nem példányosítják közvetlenül; belsőleg hívja a scene.save().

LoadOptions

Alaposztály a formátum-specifikus betöltési opció objektumokhoz. Adj át egy alosztály példányt a scene.open() vagy scene.openFromBuffer().

SaveOptions

Alaposztály a formátum-specifikus mentési opció objektumokhoz. Adj át egy alosztály példányt a scene.save().

IOService

Belső szolgáltatás interfész, amely elrejti a fájlrendszer és a puffer I/O műveleteket az importálók és exportálók számára.


OBJ formátum

Az OBJ támogatja az importot és az exportot is. OBJ-ként mentéskor az anyagkönyvtár (.mtl) automatikusan a .obj fájl.

ObjImporter

Belső importáló, amely beolvassa a Wavefront OBJ fájlokat, feloldja a .mtl anyagkönyvtárakat, és feltölti egy Scene. Automatikusan meghívva, amikor ObjLoadOptions átadva a scene.open().

ObjExporter

Belső exportáló, amely Wavefront OBJ fájlokat ír. Egy társ .mtl az anyagkönyvtár automatikusan kerül írásra. Meghíváskor, amikor scene.save() célpont egy .obj útvonal.

ObjLoadOptions

OBJ fájlok betöltési beállításai. Kulcsfontosságú tulajdonságok: enableMaterials (logikai, alapértelmezett true), flipCoordinateSystem (logikai), normalizeNormal (logikai, alapértelmezett true), scale (szám). Lásd Formátum betöltési és mentési beállítások a teljes részletekért.

ObjSaveOptions

OBJ exportálás mentési beállításai. Átadja a scene.save() az OBJ kimenet viselkedésének szabályozásához. Lásd Formátum betöltési és mentési beállítások a teljes részletekért.

ObjFormat

Formátum leíró egyed az OBJ-hez. Mindkettő canImport és canExport vannak true.


glTF formátum

GltfImporter

Olvas glTF 2.0 JSON (.gltf) és bináris GLB (.glb) fájlok. Kezeli a beágyazott és külső puffer hivatkozásokat, PBR anyagokat, skin-ek, és animációs klipeket.

GltfExporter

Ír glTF 2.0 kimenetet. Amikor GltfSaveOptions.binaryMode van true, egy önálló GLB-t állít elő; egyébként JSON-t ír .gltf egy kísérő .bin puffer.

GltfLoadOptions

Betöltési beállítások glTF/GLB fájlokhoz. Szabályozza a pufferek feloldását és a textúra betöltésének viselkedését.

GltfSaveOptions

Mentési beállítások a glTF/GLB exportáláshoz. Figyelemre méltó tulajdonságok: binaryMode (logikai, true → GLB, alapértelmezett false), flipTexCoordV (logikai, függőleges UV tengelyt fordít, alapértelmezett true). Lásd Formátum betöltési és mentési beállítások a részletekért.

GltfFormat

Formátumleíró singleton. Szerezhető meg a következővel: GltfFormat.getInstance() és átadva a következőnek: scene.save() második argumentumként.


STL formátum

StlImporter

Beolvassa az ASCII és bináris STL fájlokat egy Scene tartalmazó egyetlen Mesh entitást.

StlExporter

Bináris STL-t ír ki. A kimenet a jelenetből származó triangulált hálót tartalmaz; a nem háromszögű poligonok automatikusan triangulálódnak.

StlLoadOptions

Betöltési beállítások STL-hez. Szabályozza, hogy az importáló megfordítja-e a normálvektorokat importálás közben.

StlSaveOptions

Mentési beállítások STL exporthoz. Kulcsfontosságú tulajdonság: binaryMode (logikai, alapértelmezett false). Szabályozza, hogy a kimenet ASCII vagy bináris STL legyen. Lásd Formátum betöltési és mentési beállítások a részletekért.

StlFormat

Formátumleíró singleton. Szerezhető meg a következővel: StlFormat.getInstance().


3MF Format

ThreeMfImporter

Olvassa az Open Packaging Convention 3MF archívumokat, és feltölti egy Scene háló objektumokkal, színekkel és anyagtulajdonságokkal.

ThreeMfExporter

Érvényes 3MF archívumot ír ki a jelenlegi jelenetből. Alkalmas 3D nyomtatási munkafolyamatokhoz.

ThreeMfLoadOptions

Betöltési beállítások 3MF fájlokhoz.

ThreeMfSaveOptions

Mentési beállítások 3MF exporthoz.

ThreeMfFormat

Formátumleíró singleton. Elérhető a ThreeMfFormat.getInstance().


FBX formátum

FbxImporter

Olvas FBX bináris és ASCII fájlokat, beleértve a geometriát, anyagokat, csontvázakat, blend shape-eket és animációs klipeket.

FbxExporter

FBX fájlokat ír az aktuális jelenetből. A bináris és az ASCII FBX kimenet egyaránt támogatott a beállításoktól függően.

FbxLoadOptions

Betöltési beállítások FBX-hez. Szabályozza, hogy animációk, skin-ek és blend shape-ek legyenek-e importálva.

FbxSaveOptions

Mentési beállítások FBX exporthoz. Kulcsfontosságú tulajdonság: embedTextures (logikai, alapértelmezett false). Lásd Formátum betöltési és mentési beállítások a részletekért.

FbxFormat

Formátumleíró egyed. Szerezhető meg a FbxFormat.getInstance().


COLLADA formátum

COLLADA import és export megköveteli a xmldom társfüggőséget, amely automatikusan települ a @aspose/3d.

ColladaImporter

Beolvassa a COLLADA (.dae) XML fájlokat a xmldom. Kezeli a geometriát, anyagokat, kamerákat, fényeket és animációt.

ColladaExporter

A jelenlegi jelenetből COLLADA XML kimenetet ír. Alkalmas az adatcsere DCC eszközökkel (Blender, Maya, stb.).

ColladaFormat

Formátumleíró egyed. Elérhető a ColladaFormat.getInstance().


Tulajdonságok rendszere

ImageRenderOptions

Egy típusos név/érték pár, amely bármilyen A3DObject. Támogatja a skalár és vektor értéktípusokat.

PropertyCollection

Rendezett tároló, amely Property objektumok. Elérhető bármely A3DObject a properties hozzáférő.

CustomObject

Szabad formájú tulajdonság-táska, amely kiterjeszti A3DObject. Arbitrári metaadatok tárolására szolgál, amelyek nem illeszkednek szabványos osztályba.


Eszköz információ

AssetInfo

A forrásfájlból betöltött jelenetszintű metaadatokat tartalmazza: szerző, alkalmazás neve, létrehozás dátuma, egységskála és koordináta tengely információk.

ImageRenderOptions

Beállítások, amelyek szabályozzák, hogyan kerülnek feloldásra és kódolásra a textúrák és képek, amikor olyan formátumokba mentünk, amelyek beágyazott képadatot tartalmaznak (például GLB a binaryMode: true).


Lásd még

 Magyar