Referenčná dokumentácia API pre aspose-3d-foss 26.1.0 (Java 21+, licencia MIT).
Všetky triedy sa nachádzajú v com.aspose.threed koreňovom balíku. Korený import je:
Rozloženie balíka: Takmer všetky verejné triedy sú v com.aspose.threed. Jediný podbalík, ktorý sa bežne používa, je com.aspose.threed.shading (pre PbrMaterial). Tento com.aspose.threed.formats podbalík obsahuje interné importéry/exportéry a zvyčajne sa neimportuje priamo.
Java konvencia pomenovania: Všetky vlastnosti používajú metódy getter/setter. Napríklad použite node.getTransform() namiesto node.transform, a transform.setTranslation(...) namiesto transform.translation = .... Všimnite si, že Vector3, Vector4, Quaternion, Matrix4, a FVector typy používajú verejné polia (v.x, v.y, v.z) namiesto getterov pre prístup k komponentom.
Základný graf scény
| Example | Example |
|---|
Scene | Kontajner najvyššej úrovne pre všetky 3D dáta scény. Obsahuje koreňový uzol, metadáta assetov a animačné klipy. Exponuje fromFile(), open(), a save() ako primárne vstupné/výstupné body. |
Node | Pomenovaný uzol v hierarchii scény. Obsahuje zoznam poduzlov a zoznam pripojených Entity objektov ako siete, kamery a svetlá. Nesie lokálny Transform. |
Entity | Abstraktná základná trieda pre všetky objekty, ktoré môžu byť pripojené k Node. Poskytuje názov a identitu, ale nemá vlastnú geometriu. |
SceneObject | Základná trieda zdieľaná medzi Node a Entity. Poskytuje rozhranie kolekcie vlastností používané pre používateľom definované metadáta. |
A3DObject | Koreňová základná trieda pre všetky Aspose.3D spravované objekty. Exponuje vlastnosť name a Properties kolekciu. |
INamedObject | Rozhranie, ktoré zaručuje getName() metódu. Implementované v Node, Entity, a niekoľko typov deskriptorov špecifických pre formát. |
Geometria a sieť
| Example | Example |
|---|
Mesh | Entita polygonovej siete. Ukladá kontrolné body (pozície vrcholov ako Vector4), zoznamy polygonových plôch (zoznamy indexov kontrolných bodov) a vrstvy prvkov vrcholov (normály, UVs, farby vrcholov). |
Geometry | Abstraktný základ pre typy geometrie podobnej sieti. Definuje pole kontrolných bodov a kolekciu VertexElement vrstiev. Mesh dedí od Geometry. |
VertexElement | Abstraktný základ pre dátovú vrstvu pripojenú k geometrii (normály, UV, farby, atď.). Nesie getMappingMode(), getReferenceMode(), a zoznam dát. |
VertexElementNormal | Ukladá jeden normálový vektor na vrchol alebo na roh polygonu, v závislosti od režimu mapovania. Hodnoty dát sú Vector4 inštancie s w nepoužité. |
VertexElementUV | Ukladá páry textúrových súradníc (Vector2) na vrchol alebo na roh polygonu. Mriežka môže obsahovať viacero UV vrstiev pre rôzne textúrové kanály. |
VertexElementVertexColor | Ukladá RGBA farebné dáta na vrchol alebo na roh ako Vector4 (r, g, b, a v rozsahu 0–1). |
VertexElementType | Výčtový typ identifikujúci sémantickú úlohu vrstvy prvku vrcholu: NORMAL, UV, VERTEX_COLOR, a ďalšie. Predajte hodnoty do Mesh.getElement(). |
MappingMode | Výčtový typ určujúci, ku ktorému primitívu sa hodnota prvku vrcholu mapuje: CONTROL_POINT, POLYGON_VERTEX, alebo POLYGON. |
ReferenceMode | Výčtový typ určujúci, ako sú hodnoty indexované: DIRECT (jedna hodnota na mapovací primitív) alebo INDEX_TO_DIRECT (pole hodnôt plus samostatné pole indexov). |
Transformácia a priestor
| Example | Example |
|---|
Transform | Lokálna transformácia pripojená k a Node. Poskytuje posunutie, rotáciu (ako Quaternion), a komponenty mierky, plus pohodlné metódy pre Eulerove uhly. |
GlobalTransform | Zobrazenie len na čítanie transformácie uzla vo svetovom priestore po zložením všetkých transformácií predkov. Prístupné cez node.getGlobalTransform(). |
AssetInfo | Blok metadát pripojený k Scene. Ukladá názov autorizačnej aplikácie, názov jednotky, faktor mierky jednotky, definície osí súradnicového systému a časové značky vytvorenia/úpravy. |
Materiály a tieňovanie
| Example | Example |
|---|
Material | Abstraktná základná trieda pre všetky typy materiálov. Poskytuje názov a kolekciu vlastností pre číselné a farebné parametre. |
PbrMaterial | Materiál založený na fyzikálne založenom renderovaní (Physically Based Rendering). Ukladá albedo, kovový faktor, faktor drsnosti, emisnú farbu, priehľadnosť a súvisiace textúry. Používa sa v glTF 2.0 a ďalších formátoch podporujúcich PBR. Import: com.aspose.threed.shading.PbrMaterial. |
Example
| Example | Example |
|---|
Camera | Entita kamery. Dedičná od Entity. V edícii Java FOSS nie sú vystavené žiadne špecifické vlastnosti formátu okrem zdedeného názvu a kolekcie vlastností. Pripojené k Node na definovanie transformácií pohľadu. |
Poznámka: Example Light trieda nie je dostupná v edícii Java Aspose.3D FOSS. Údaje o osvetlení scény z importovaných súborov sú uložené ako generické Entity objekty.
Matematické nástroje
| Example | Example |
|---|
Vector2 | Dvojitá presnosť 2-komponentový vektor (x, y). Používa sa pre UV textúrové súradnice. |
Vector3 | Dvojitá presnosť 3-komponentový vektor (x, y, z). Používa sa pre pozície, smerovanie a mierku. |
Vector4 | Dvojitá presnosť 4-komponentový vektor (x, y, z, w). Používa sa pre kontrolné body (homogénne pozície) a normálové dáta. |
FVector3 | Jednopresnostný 3-komponentový float vektor. Objavuje sa v poliach dát vertex elementov pre normály a tangenty. |
FVector4 | Jednopresnostný 4-komponentový float vektor. Typ úložiska pre VertexElementFVector dáta. |
Quaternion | Jednotkový kvaternion pre reprezentáciu rotácií (w, x, y, z). Používa sa Transform.getRotation(). |
Matrix4 | 4x4 double-precision transformation matrix. Used for world/local transform computations and can be constructed from TRS decompositions. |
BoundingBox | Osa‑zarovnaný ohraničovací box definovaný getMinimum() a getMaximum() Vector3 rohy. Používa sa pre priestorové dotazy a pomocníkov pre orezávanie frustru. |
Example
| Example | Example |
|---|
AnimationClip | Pomenovaný kontajner pre rozsah animácie. A Scene môže obsahovať viacero klipov (napr. “Walk”, “Run”). Deklarácia stub — dáta kľúčových snímok a prehrávanie ešte nie sú implementované. |
Formát I/O
| Example | Example |
|---|
Scene.fromFile(path) | Statická metóda. Otvára súbor na path, detekuje formát podľa prípony a vráti naplnený Scene. Vyvolá výnimku pri nenájdení súboru alebo nepodporovanom formáte. |
Scene.open(path, options) | Inštančná metóda. Otvára súbor do existujúceho Scene inštanciu, voliteľne s formátovo‑špecifickým LoadOptions podtriedou. |
Scene.save(path, options) | Inštančná metóda. Serializuje scénu do path pomocou formátu odhadnutého z prípony, voliteľne pomocou formátu‑špecifického SaveOptions podtrieda. |
FileFormat | Register podporovaných formátov súborov. Obsahuje položky ako FileFormat.WAVEFRONT_OBJ(), FileFormat.GLTF2(), FileFormat.FBX7400ASCII(). |
IOService | Interná I/O abstrakcia používaná importérmi a exportérmi formátov. Zvyčajne sa nepoužíva priamo v aplikačnom kóde. |
LoadOptions | Základná trieda pre všetky objekty s možnosťami načítania špecifické pre formát. Dedičná trieda pre ObjLoadOptions, StlLoadOptions, GltfLoadOptions, FbxLoadOptions. |
SaveOptions | Základná trieda pre všetky objekty s možnosťami ukladania špecifické pre formát. Dedičná trieda pre ObjSaveOptions, StlSaveOptions, GltfSaveOptions. |
Formát OBJ
| Example | Example |
|---|
ObjImporter | Interná trieda importéra, ktorá parsuje súbory Wavefront OBJ a MTL. Automaticky volaná cez Scene.fromFile() pre .obj rozšírenia. |
ObjLoadOptions | Možnosti načítania pre súbory Wavefront OBJ. Kľúčové vlastnosti: setFlipCoordinateSystem(), setScale(), setEnableMaterials(), setNormalizeNormal(). |
ObjSaveOptions | Možnosti ukladania pre výstup Wavefront OBJ. Ovláda normály, UV, referencie materiálov a režim bodového oblaku. |
ObjFormat | Popisovač formátu pre Wavefront OBJ. Prístupný ako FileFormat.WAVEFRONT_OBJ(). |
Formát STL
| Example | Example |
|---|
StlImporter | Interný importér, ktorý číta binárne aj ASCII STL súbory. Automaticky vybraný podľa rozšírenia. |
StlExporter | Interný exportér, ktorý zapisuje STL. |
StlLoadOptions | Možnosti načítania pre STL súbory. Podporuje setFlipCoordinateSystem(), setRecalculateNormal(), a setContentType(). |
StlSaveOptions | Možnosti ukladania pre výstup STL. Ovláda setFlipCoordinateSystem(), setAxisSystem(), a setContentType(). |
StlFormat | Popisovač formátu pre STL. |
Formát glTF
| Example | Example |
|---|
GltfLoadOptions | Načítanie možností pre súbory glTF 2.0 a GLB. Kľúčové vlastnosti: setFlipCoordinateSystem(), setPrettyPrint(). |
GltfSaveOptions | Možnosti ukladania pre výstup glTF 2.0 a GLB. Použite setContentType(FileContentType.BINARY) na vytvorenie samostatného .glb balíka. |
GltfFormat | Formátový opis pre glTF 2.0 / GLB. Prístupný ako FileFormat.GLTF2(). |
Formát FBX
FBX je podporovaný pre iba import. Export do FBX nie je dostupný v edícii Java FOSS.
| Example | Example |
|---|
FbxLoadOptions | Možnosti načítania pre súbory FBX. Kľúčová vlastnosť: setFlipCoordinateSystem(). |
FbxFormat | Formátový opis pre FBX. Prístupný ako FileFormat.FBX7400ASCII(). |
Example
| Example | Example |
|---|
Axis | Identifikuje os súradníc: X_AXIS, Y_AXIS, Z_AXIS. Používa sa v možnostiach premapovania súradnicového systému. |
CoordinateSystem | Určuje konvenciu pravosti/ľavosti: RIGHT_HANDED alebo LEFT_HANDED. |
TextureMapping | Identifikuje, ako je textúra mapovaná na geometriu: DIFFUSE, SPECULAR, EMISSIVE, NORMAL, AMBIENT, atď. |
BooleanOperation | Typ Booleovskej operácie CSG: UNION, DIFFERENCE, INTERSECTION. |
Systém vlastností
| Example | Example |
|---|
Property | Jedna pomenovaná typová vlastnosť na A3DObject. Ukladá názov vlastnosti, opis typu a aktuálnu hodnotu. |
PropertyCollection | Iterovateľná kolekcia of Property objekty pripojené k A3DObject. Podporuje vyhľadávanie podľa názvu a iteráciu cez všetky definované vlastnosti. |
CustomObject | Ľahký A3DObject podtrieda, ktorá nesie iba názov a ľubovoľný PropertyCollection. Používa sa na ukladanie používateľom definovaných metadát na objektoch scény. |
Obrázok a renderovanie
| Example | Example |
|---|
ImageRenderOptions | Možnosti softvérovej rasterizácie pri renderovaní scény do obrazového bufferu. Ukladá farbu pozadia, rozmery obrázka a referenciu kamery. Táto funkcia je dostupná v podporovaných konfiguráciách. |
Pozri tiež
