Aspose.3D FOSS for TypeScript
API nuoroda, skirta @aspose/3d versija 24.12.0. Įdiekite per:
npm install @aspose/3dVykdymo aplinka: Node.js 18, 20, 22+ · Kalba: TypeScript 5.0+ / JavaScript (CommonJS) · Licencija: MIT
Pagrindinis scenos grafas
ImageRenderOptions
Pagrindinis konteineris 3D scenai. Iškvieskite scene.open() arba scene.openFromBuffer() įkelti failą, ir scene.save() rašyti išvestį. Atveria scene.rootNode kaip įėjimo taškas į mazgų hierarchiją.
ImageRenderOptions
Pavadintas mazgas scenos medyje. Laiko Transform, neprivalomas entity (tinklas, kamera, šviesa arba kitas SceneObject), ir nulis arba daugiau vaikų mazgų, prieinamų per childNodes.
ImageRenderOptions
Bazinė klasė visiems objektams, kuriuos galima prisegti prie Node kaip pagrindinę entitetą. Paveldima Mesh, Camera, Light, ir kiti.
SceneObject
Abstrakti bazė pavadintiems objektams, priklausantiems scenai. Suteikia name savybę ir scenos narystės sekimą, kurią dalijasi mazgai, entitetai ir turto lygio objektai.
A3DObject
Pagrindinė bazinė klasė visiems Aspose.3D objektams. Suteikia savybių sistemą (getProperty, setProperty) ir name lauką, paveldimą visų viešų klasių.
Geometrija ir tinklas
ImageRenderOptions
Atstovauja daugiakampio tinklelį. Turi controlPoints masyvą Vector4 viršūnes ir daugiakampio apibrėžimus, sukurtus per createPolygon(). Iškvieskite triangulate() konvertuoti visus daugiakampius į trikampius prieš eksportavimą.
ImageRenderOptions
Bazinė klasė visiems geometrijos tipams. Laiko controlPoints ir viršūnių elementų (normales, UV, spalvas) rinkinį, priskirtą geometrijai.
VertexElement
Bazinė klasė viršūnės atributų kanalams, priskirtiems Geometry. Potominės klasės talpina tipizuotus duomenų masyvus ir mappingMode / referenceMode metaduomenis.
VertexElementNormal
A VertexElement potominė klasė, sauganti paviršiaus normas. Duomenys saugomi viduje kaip FVector4[] (paveldėta iš VertexElementFVector). Reikalinga daugumai rendererių teisingam apšvietimui.
VertexElementUV
A VertexElement potominė klasė, sauganti 2D tekstūros koordinates. Vienas tinklas gali turėti kelis UV rinkinius skirtingoms tekstūros sluoksniams.
VertexElementVertexColor
A VertexElement subklasė, kuri saugo RGBA spalvų reikšmes kiekvienam viršūnei.
VertexElementType
Atributų kanalo tipų išvardinimas, kurį VertexElement gali atstovauti (pvz., NORMAL, UV, VERTEX_COLOR, TANGENT, BINORMAL).
MappingMode
Išvardijimas, kontroliuojantis, kaip elementų duomenys susiejami su geometrija: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, arba ALL_SAME.
ReferenceMode
Išvardijimas, kontroliuojantis, kaip elementų indeksai nurodo duomenis: DIRECT (vienas‑prie‑vieno) arba INDEX_TO_DIRECT (per indekso masyvą).
TextureMapping
Tekstūros kanalo semantikos išvardinimas: DIFFUSE, SPECULAR, NORMAL, EMISSIVE, BUMP, ir daugiau.
Transformacija ir Erdvė
ImageRenderOptions
Saugo vietinę poziciją (translation), sukimą (rotation kaip Quaternion), ir mastelis (scaling) kažkokio Node. Čia atlikti pakeitimai veikia mazgą ir visus jo vaikus.
GlobalTransform
Tik skaitymui skirta mazgo pasaulio erdvės transformacijos peržiūra, apskaičiuota sukauptų visų protėvių Transform reikšmes. Prieiga per node.globalTransform.
BoundingBox
Ašies lygių ribų dėžutė, apibrėžta pagal minimum ir maximum Vector3 kampą. Naudojama apibūdinti erdvinį tinklo arba scenos išsidėstymą.
ImageRenderOptions
Material, LambertMaterial, PhongMaterial, PbrMaterial
Material yra abstrakti bazinė klasė visiems medžiagų tipams. Prieinami trys konkretūs įgyvendinimai:
- LambertMaterial — tik difuzinis su aplinkos, difuzinio ir emisijos spalvų kanalais. Tinka nešvytiniams paviršiams.
- PhongMaterial — išplečia
LambertMaterialsu spinduliuojančios spalvos ir blizgesio savybėmis Phong šešėliavimui. - PbrMaterial — fizikinio pagrindo atvaizdavimo medžiaga su metaliniu, šiukštingumo, bazinės spalvos ir normalios žemėlapio kanalais. Tiesiogiai atitinka glTF 2.0 PBR medžiagos modelį.
Kamera ir apšvietimas
ImageRenderOptions
Žiūrėjimo taško mazgo objektas su projekcijos tipu, matymo lauku, artimo/nuotolinio apkirpimo atstumais ir kraštinių santykio savybėmis.
ImageRenderOptions
Šviesos šaltinio mazgo objektas. Tipas valdomas pagal LightType enumeraciją.
LightType
Palaikomų šviesos tipų enumeracija: POINT, DIRECTIONAL, SPOT, AREA, VOLUME.
ProjectionType
Kamerų projekcijos režimų enumeracija: PERSPECTIVE ir ORTHOGRAPHIC.
Matematinės priemonės
ImageRenderOptions
Trijų komponentų slankaus kablelio vektorius su x, y, z laukais ir bendrais aritmetiniais metodais (dot, cross, normalize, minus, times). Eksportuota iš @aspose/3d/utilities.
ImageRenderOptions
Keturių komponentų slankaus kablelio vektorius su x, y, z, w laukais. Naudojamas kaip įrašų tipas, esančių Mesh.controlPoints.
ImageRenderOptions
Dviejų komponentų dvigubo tikslumo vektorius su x ir y laukais. Naudojamas UV tekstūros koordinatėms.
FVector3
Kompaktiškas trijų komponentų viengubo tikslumo slankaus kablelio vektorius, naudojamas viršūnių elementų duomenų masyvuose normalių ir tangentų reikšmėms.
ImageRenderOptions
4×4 transformacijos matrica. Palaiko sujungimą, inversiją, transponavimą ir dekompoziciją į perkėlimo, sukimo ir mastelio komponentus. Eksportuota iš @aspose/3d/utilities.
ImageRenderOptions
Vienetinis kvaternionas, skirtas atvaizduoti sukimus be gimbal lock. Teikia slerp() sklandžiam interpoliavimui ir konversijai į/iš Euler angles ir Matrix4. Eksportuota iš @aspose/3d/utilities.
ImageRenderOptions
AnimationClip
Pavadinta, laiku apribota kolekcija AnimationNode takų. Pagrindinis konteineris raktų kadro animacijos duomenims, įkeltų iš FBX arba COLLADA failų.
AnimationNode
Pavadintas animacijos takas, nukreiptas į konkretų savybės kelią scenos objekte. Turi vieną arba kelias AnimationChannel objektus.
AnimationChannel
Vienas animuotas savybės kanalas, esantis AnimationNode. Laiko KeyframeSequence laiko/reikšmės porų.
KeyFrame
Vienas laiko/reikšmės mėginys KeyframeSequence. Nurodo laiko žymą (sekundėmis), reikšmę ir tangentės informaciją interpolacijai.
KeyframeSequence
Rūšiuotas sąrašas. KeyFrame pavyzdžiai vienam savybės kanalui, kartu su Interpolation ir Extrapolation nustatymai, kurie valdo atkūrimą.
ImageRenderOptions
Išvardinimas rėmelio interpolacijos režimų. Žinomi nariai apima LINEAR ir CONSTANT. Papildomi nariai, tokie kaip BEZIER gali būti prieinami.
ImageRenderOptions
Apibrėžia elgseną už rėmelio intervalo ribų (prieš pirmąjį rėmelį ir po paskutiniojo rėmelio). Valdo ExtrapolationType.
StepMode
Išvardijimas, valdomas, kaip laiptinė (konstanta) interpoliacija taikoma ribose.
WeightedMode
Išvardinimas Bezier tangento svorio tvarkymui: NONE, OUT_WEIGHT, NEXT_IN_WEIGHT, arba BOTH.
ExtrapolationType
Išvardinimas už ribų elgsenų: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, ir OSCILLATE.
Formato Į/I
FileFormat
Pagrindinis aprašas 3D failų formatui. Kiekvienas palaikomas formatas suteikia konkretų vienetą per getInstance().
ImageRenderOptions
Pagrindinė klasė formatui specifiniams importo įgyvendinimams. Nesukuriama tiesiogiai; iškviečiama viduje per scene.open().
ImageRenderOptions
Pagrindinė klasė formatui specifiniams eksporto įgyvendinimams. Nesukuriama tiesiogiai; iškviečiama viduje per scene.save().
LoadOptions
Pagrindinė klasė formatui specifiniams įkėlimo parinkčių objektams. Perduokite subklasės egzempliorių į scene.open() arba scene.openFromBuffer().
SaveOptions
Pagrindinė klasė formatui specifiniams išsaugojimo parinkčių objektams. Perduokite subklasės egzempliorių į scene.save().
IOService
Vidinė paslaugų sąsaja, kuri abstrahuoja failų sistemos ir buferio I/O importuotojams ir eksportuotojams.
OBJ formatas
OBJ palaiko tiek importą, tiek eksportą. Išsaugant kaip OBJ, medžiagų biblioteka (.mtl) rašoma automatiškai kartu su .obj failu.
ObjImporter
Vidinis importuotojas, kuris skaito Wavefront OBJ failus, išsprendžia .mtl medžiagų bibliotekas ir užpildo Scene. Iškviečiamas automatiškai, kai ObjLoadOptions yra perduodamas į scene.open().
ObjExporter
Vidinis eksportuotojas, kuris rašo Wavefront OBJ failus. Priedas .mtl medžiagų biblioteka įrašoma automatiškai. Iškviečiama, kai scene.save() taikosi į .obj kelias.
ObjLoadOptions
Įkelti parinktis OBJ failams. Pagrindinės savybės: enableMaterials (boolean, numatytasis true), flipCoordinateSystem (boolean), normalizeNormal (boolean, numatytasis true), scale (number). Žr Formato įkėlimo ir išsaugojimo parinktys pilnai išsamiai.
ObjSaveOptions
Išsaugoti OBJ eksporto parinktis. Perduokite į scene.save() norint valdyti OBJ išvesties elgseną. Žr. Formato įkėlimo ir išsaugojimo parinktys detalių.
ObjFormat
Formato aprašymo vienetinis objektas OBJ. Abu canImport ir canExport yra true.
glTF formatas
GltfImporter
Skaito glTF 2.0 JSON (.gltf) ir binarinį GLB (.glb) failus. Tvarko įterptus ir išorinius buferio nuorodas, PBR medžiagas, odų ir animacijos klipus.
GltfExporter
Rašo glTF 2.0 išvestį. Kai GltfSaveOptions.binaryMode yra true, sukuria savarankišką GLB; kitu atveju rašo JSON .gltf su gretutu .bin buferis.
GltfLoadOptions
Įkėlimo parinktys glTF/GLB failams. Valdo buferio išraišką ir tekstūrų įkėlimo elgseną.
GltfSaveOptions
Išsaugojimo parinktys glTF/GLB eksportui. Pastebimos savybės: binaryMode (boolean, true → GLB, numatytasis false), flipTexCoordV (boolean, apverčia UV vertikalią ašį, numatytasis true). Žr. Formato įkėlimo ir išsaugojimo parinktys pilnai išsamiai.
GltfFormat
Formato aprašymo vienetinis objektas. Gauti per GltfFormat.getInstance() ir perduoti į scene.save() kaip antrą argumentą.
STL formatas
StlImporter
Nuskaito tiek ASCII, tiek binarinius STL failus į Scene kuriame yra vienas Mesh objektas.
StlExporter
Įrašo dvejetainį STL. Išvestis turi iš scenos sutrianguliuotą tinklą; ne trikampės daugiakampės figūros automatiškai sutrianguliuojamos.
StlLoadOptions
Įkėlimo parinktys STL. Valdo, ar importuotojas apverčia normalės importavimo metu.
StlSaveOptions
Išsaugojimo parinktys STL eksportui. Pagrindinė savybė: binaryMode (loginis, numatytasis false). Valdo, ar išvestis yra ASCII ar binarinis STL. Žr. Formato įkėlimo ir išsaugojimo parinktys pilnai išsamiai.
StlFormat
Formato aprašymo vienetinis objektas. Gauti per StlFormat.getInstance().
3MF Format
ThreeMfImporter
Nuskaito Open Packaging Convention 3MF archyvus ir užpildo Scene tinklo objektais, spalvomis ir medžiagų savybėmis.
ThreeMfExporter
Įrašo galiojantį 3MF archyvą iš esamos scenos. Tinka 3D spausdinimo darbo srautams.
ThreeMfLoadOptions
Įkėlimo parinktys 3MF failams.
ThreeMfSaveOptions
Išsaugojimo parinktys 3MF eksportui.
ThreeMfFormat
Formato aprašymo vienetinis objektas. Gauti per ThreeMfFormat.getInstance().
FBX formatas
FbxImporter
Skaito FBX binarinius ir ASCII failus, įskaitant geometriją, medžiagas, skeleto struktūras, blend shape’us ir animacijos klipus.
FbxExporter
Rašo FBX failus iš dabartinės scenos. Priklausomai nuo parinkčių, palaikoma tiek binarinė, tiek ASCII FBX išvestis.
FbxLoadOptions
Įkėlimo parinktys FBX. Valdo, ar importuojama animacija, odos (skins) ir blend shape’ai.
FbxSaveOptions
Išsaugojimo parinktys FBX eksportui. Pagrindinė savybė: embedTextures (boolean, numatytasis false). Žr. Formato įkėlimo ir išsaugojimo parinktys pilnai informacijai.
FbxFormat
Formato aprašymo vienetinis objektas. Gauti per FbxFormat.getInstance().
COLLADA formatas
COLLADA importavimas ir eksportavimas reikalauja xmldom priklausomybės pora, kuri automatiškai įdiegiama kartu su @aspose/3d.
ColladaImporter
Skaito COLLADA (.dae) XML failus naudojant xmldom. Apdoroja geometriją, medžiagas, kameras, šviesas ir animaciją.
ColladaExporter
Rašo COLLADA XML išvestį iš dabartinės scenos. Tinka duomenų mainams su DCC įrankiais (Blender, Maya ir kt.).
ColladaFormat
Formato aprašymo singleton. Gauti per ColladaFormat.getInstance().
Savybių sistema
ImageRenderOptions
Tipizuota name/value pora, kurią galima prisegti prie bet kurio A3DObject. Palaiko skaliarų ir vektorinių tipų reikšmes.
PropertyCollection
Surūšiuotas konteineris, kuriame yra Property objektų. Prieinamas bet kuriame A3DObject per properties prieigos metodą.
CustomObject
Laisvos formos savybių rinkinys, kuris išplečia A3DObject. Naudojamas saugoti bet kokius metaduomenis, kurie neatitinka jokios standartinės klasės.
Turto informacija
AssetInfo
Perneša scenos lygio metaduomenis, įkeltus iš šaltinio failo: autorius, programos pavadinimas, sukūrimo data, vieneto mastelis ir koordinačių ašies informacija.
ImageRenderOptions
Parinktys, valdančios, kaip tekstūros ir vaizdai yra išsprendžiami ir koduojami, kai įrašoma į formatus, kurie įterpia vaizdo duomenis (pvz., GLB su binaryMode: true).
Žr. taip pat
- Žinių bazė: Vadovai
- Išsamus API apžvalga
- Scenos klasė
- Mazgo klasė
- Tinklo klasė
- Transformacijos klasė
- Globalios transformacijos klasė
- Kameros klasė
- Šviesos klasė
- Vector3 klasė
- Quaternion klasė
- Matrix4 klasė
- BoundingBox klasė
- Material, LambertMaterial, PhongMaterial, PbrMaterial
- Formato įkėlimo ir išsaugojimo parinktys
- Vector2, Vector4 nuoroda
- Property, PropertyCollection, AssetInfo nuoroda
- A3DObject, SceneObject, Entity nuoroda
- VertexElement, VertexElementNormal, VertexElementUV nuoroda
- Išvardijimų nuoroda
- npm: @aspose/3d
- GitHub: aspose-3d-node