Aspose.3D FOSS for Python

API referenčná dokumentácia pre aspose-3d-foss 26.1.0 (Python 3.7 – 3.12, licencia MIT).

Všetky triedy sú importované z aspose.threed balíka alebo jeho podbalíkov. Hlavný import je:

import aspose.threed
##or selectively:
from aspose.threed import Scene, Node
from aspose.threed.entities import Mesh, Camera, Light
from aspose.threed.formats import ObjLoadOptions, StlSaveOptions, GltfSaveOptions
from aspose.threed.utilities import Vector3, Matrix4, BoundingBox
from aspose.threed.animation import AnimationClip, KeyFrame

Základný graf scény

ExampleExample
SceneKontajner najvyššej úrovne pre všetky 3D dáta scény. Obsahuje koreňový uzol, metadáta aktív a animačné klipy. Poskytuje from_file(), open(), a save() ako hlavné vstupné/výstupné body.
NodePomenovaný uzol v hierarchii scény. Obsahuje zoznam poduzlov a zoznam pripojených Entity objektov, ako sú siete, kamery a svetlá. Nesie lokálny Transform.
EntityAbstraktná základná trieda pre všetky objekty, ktoré môžu byť pripojené k Node. Poskytuje názov a identitu, ale nemá vlastnú geometriu.
SceneObjectZákladná trieda zdieľaná Node a Entity. Poskytuje rozhranie kolekcie vlastností používané pre používateľom definované metadáta.
A3DObjectKoreňová základná trieda pre všetky Aspose.3D spravované objekty. Poskytuje vlastnosť názvu a Properties kolekcia.
INamedObjectRozhranie, ktoré zaručuje name vlastnosť. Implementované Node, Entity, a niekoľko formátovo-špecifických typov opisovačov.

Geometria a sieť

ExampleExample
MeshEntita 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, UV, farby vrcholov).
GeometryAbstraktný základ pre typy geometrie podobnej sieti. Definuje pole kontrolných bodov a kolekciu VertexElement vrstiev. Mesh dedí od Geometry.
VertexElementAbstraktný základ pre dátovú vrstvu pripojenú k geometrii (normály, UV, farby, atď.). Nesie mapping_mode, reference_mode, a data zoznam.
VertexElementNormalUkladá jeden normálový vektor na vrchol alebo na roh polygonu, v závislosti od mapping_mode. Hodnoty dát sú FVector4 inštancie (jednoduchá presnosť) s w nepoužité.
VertexElementUVUkladá dáta textúrových súradníc ako FVector4 na vrchol alebo na roh polygonu (iba x a y komponenty sa používajú pre UV). Sieť môže niesť viacero UV vrstiev pre rôzne textúrové kanály.
VertexElementVertexColorUkladá údaje o farbe RGBA na vrchol alebo na roh ako FVector4 (r, g, b, a v rozsahu 0–1).
VertexElementSmoothingGroupUkladá celočíselné ID skupín vyhladzovania na polygon, ktoré používa importér OBJ na reprodukciu pôvodných priradení skupín vyhladzovania zo zdrojového súboru.
VertexElementTypeVýčtový typ identifikujúci sémantickú úlohu vrstvy prvku vrcholu: NORMAL, UV, VERTEX_COLOR, SMOOTHING_GROUP, a ďalšie. Predať hodnoty do Mesh.get_element().
MappingModeVýčtový typ, ktorý určuje, ku ktorému primitívu sa hodnota prvku vrchola mapuje: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, alebo ALL_SAME.
ReferenceModeVýčtový typ, ktorý určuje, ako sú hodnoty indexované: DIRECT (jedna hodnota na mapovací primitív) alebo INDEX_TO_DIRECT (pole hodnôt plus samostatné pole indexov).
PolygonModifierStatická pomocná trieda s metódami na trianguláciu Mesh objektov a celých Scene grafov.

Transformácia a priestor

ExampleExample
TransformLokálna transformácia pripojená k Node. Poskytuje posunutie, rotáciu (ako Quaternion), a komponenty mierky, plus pohodlné vlastnosti pre Eulerove uhly.
GlobalTransformZobrazenie len na čítanie transformácie uzla vo svetovom priestore po zložením všetkých transformácií predkov. Prístupné cez Node.global_transform.
AssetInfoBlok metadát pripojený k Scene. Ukladá názov aplikácie na tvorbu, názov jednotky, faktor mierky jednotky, definície osí súradnicového systému a časové značky vytvorenia/modifikácie.

Materiály a tieňovanie

ExampleExample
MaterialAbstraktná základná trieda pre všetky typy materiálov. Poskytuje názov a kolekciu vlastností pre číselné a farebné parametre.
LambertMaterialModel materiálu len s difúznym odrazom. Ukladá ambientnú farbu, difúznu farbu, emisnú farbu a priehľadnosť. Načítané z OBJ súborov, ktoré používajú základné Ka/Kd/Ke deklarácie.
PhongMaterialExample LambertMaterial s odrazovou farbou a lesklosťou (špeculárny exponent). Načítané z OBJ súborov, ktoré používajú Ks/Ns deklarácie.
PbrMaterialMateriál založený na fyzickom renderovaní. Ukladá albedo, kovový faktor, faktor drsnosti a súvisiace textúry. Používa sa v glTF 2.0 a ďalších formátoch podporujúcich PBR.

Kamera a osvetlenie

ExampleExample
CameraEntita kamery. Iba projection_type a name sú funkčné v tomto vydaní; všetky ostatné číselné vlastnosti (near_plane, far_plane, field_of_view, aspect_ratio) sú len šablóny, ktoré vracajú predvolené hodnoty. Pripojené k Node na definovanie transformácií pohľadu.
LightEntita svetelného zdroja. Dedičí od Camera ako šablónovej triedy; Light táto trieda sama o sebe neodhaľuje ďalšie vlastnosti v tomto vydaní.
LightTypeVýčtový zoznam podporovaných kategórií svetla: POINT, DIRECTIONAL, SPOT, AREA, VOLUME.
ProjectionTypeVýčtový zoznam režimov projekcie kamery: PERSPECTIVE a ORTHOGRAPHIC.

Matematické nástroje

ExampleExample
Vector2Dvojité presnosťou 2-komponentový vektor (x, y). Používa sa pre UV textúrové súradnice.
Vector3Dvojité presnosťou 3-komponentový vektor (x, y, z). Používa sa pre pozície, smerovanie a mierku.
Vector4Dvojitá presnosť 4-komponentový vektor (x, y, z, w). Používa sa pre riadiace body (homogénne pozície) a normálové dáta.
FVector2Jednopresnostný 2-komponentový float vektor. Používa sa interne na kompaktné ukladanie v poliach dát elementov vrcholov.
FVector3Jednopresnostný 3-komponentový float vektor. Objavuje sa v poliach dát elementov vrcholov pre normály a tangenty.
FVector4Jednopresnostný 4‑komponentový float vektor. Typ úložiska pre VertexElementFVector.data.
QuaternionJednotkový kvaternion pre reprezentáciu rotácií (w, x, y, z) Používa sa v Transform.rotation.
Matrix44×4 double-precision transformation matrix. Used for world/local transform computations and can be constructed from TRS decompositions.
BoundingBoxOsovo zarovnaná ohraničovacia krabica definovaná minimum a maximum Vector3 rohov. Používa sa pre priestorové dotazy a pomocníkov pre orezávanie výrezu.

Example

ExampleExample
AnimationClipPomenovaný kontajner pre sadu animovaných kanálov pokrývajúcich jeden rozsah prehrávania. A Scene môže obsahovať viacero klipov (napr. „Walk“, „Run“).
AnimationNodeViaže AnimationClip k špecifickému uzlu scény alebo vlastnosti. Pôsobí ako most medzi dátami klipu a objektmi grafu scény.
AnimationChannelJediný animovaný prúd vlastnosti v rámci klipu, cielený na pomenovanú vlastnosť objektu (napr., Transform.translation.x).
KeyFrameJediný čas‑hodnotový vzor v KeyframeSequence. Ukladá čas (v sekundách) a hodnotu v tom čase.
KeyframeSequenceUsporiadaný zoznam KeyFrame objektov pre jeden skalárny kanál, spolu s nastaveniami interpolácie a extrapolácie.
InterpolationVýčtový zoznam režimov interpolácie medzi kľúčovými snímkami: CONSTANT, LINEAR, BEZIER, B_SPLINE, CARDINAL_SPLINE, TCB_SPLINE.
ExtrapolationTypeEnumerácia správaní mimo prvého a posledného kľúčového snímku: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE.

Formát I/O

ExampleExample
Scene.from_file(path)Statická metóda. Otvára súbor na path, detekuje formát z prípony a vracia naplnený Scene. Vyvolá výnimku pri nenájdení súboru alebo nepodporovanom formáte.
Scene.open(path, options=None)Metóda inštancie. Otvorí súbor do existujúcej Scene inštancie, voliteľne s použitím formátovo špecifického LoadOptions podtriedy.
Scene.save(path, options=None)Metóda inštancie. Serializuje scénu do path pomocou formátu odvodeného z prípony, voliteľne s použitím formátovo špecifického SaveOptions podtriedy.
FileFormatRegister podporovaných formátov súborov. Obsahuje položky ako FileFormat.WAVEFRONT_OBJ, FileFormat.GLTF, FileFormat.FBX7400ASCII, FileFormat.MICROSOFT_3MF. Formátovo špecifické varianty sú prístupné cez triedy možností (napr., ColladaSaveOptions, GltfSaveOptions).
IOServiceInterná I/O abstrakcia používaná importérmi a exportérmi formátov. Zvyčajne sa nepoužíva priamo v aplikačnom kóde.
LoadOptionsZákladná trieda pre všetky formátovo špecifické objekty načítacích možností. Podtriedou sú ObjLoadOptions, StlLoadOptions, GltfLoadOptions, FbxLoadOptions, ColladaLoadOptions, ThreeMfLoadOptions.
SaveOptionsZákladná trieda pre všetky formátovo špecifické objekty ukladacích možností. Podtriedou sú ObjSaveOptions, StlSaveOptions, GltfSaveOptions, FbxSaveOptions, ColladaSaveOptions, ThreeMfSaveOptions.

Formát OBJ

ExampleExample
ObjImporterInterná trieda importéra, ktorá parsuje súbory Wavefront OBJ a MTL. Automaticky volaná Scene.from_file() pre .obj prípony.
ObjLoadOptionsMožnosti načítania pre súbory Wavefront OBJ. Kľúčové vlastnosti: flip_coordinate_system, scale, enable_materials, normalize_normal.
ObjSaveOptionsUložiť možnosti pre výstup Wavefront OBJ. Ovláda normály, UV mapy, referencie materiálov a režim bodového oblaku.
ObjFormatFormátový popis pre Wavefront OBJ. Prístupný ako FileFormat.WAVEFRONT_OBJ().

Formát STL

ExampleExample
StlImporterInterný importér, ktorý číta binárne aj ASCII súbory STL. Vyberá sa automaticky podľa prípony.
StlExporterInterný exportér, ktorý zapisuje STL.
StlLoadOptionsMožnosti načítania pre súbory STL. Podporuje flip_coordinate_system a scale.
StlSaveOptionsMožnosti ukladania pre výstup STL. Ovláda binary_mode, scale, a flip_coordinate_system.
StlFormatPopis formátu pre STL.

Formát glTF

ExampleExample
GltfLoadOptionsMožnosti načítania pre súbory glTF 2.0 a GLB. Kľúčová vlastnosť: flip_tex_coord_v.
GltfSaveOptionsMožnosti ukladania pre výstup glTF 2.0. Použite binary_mode=True pre samostatný balík GLB.
GltfFormatPopis formátu pre glTF 2.0 / GLB. Prístupný ako FileFormat.GLTF2().

Formát FBX

ExampleExample
FbxLoadOptionsMožnosti načítania pre súbory FBX. Kľúčové vlastnosti: keep_builtin_global_settings, compatible_mode.
FbxSaveOptionsMožnosti ukladania pre výstup FBX. Ovláda kompresiu, vkladanie textúr a vlastnosti materiálu.
FbxFormatPopis formátu pre FBX. Prístupný ako FileFormat.FBX7400ASCII().

Formát COLLADA

ExampleExample
ColladaLoadOptionsMožnosti načítania pre COLLADA (.dae) súbory. Ovláda premapovanie osi a mierku jednotiek pri importe.
ColladaSaveOptionsMožnosti ukladania pre výstup COLLADA. Ovláda indented, flip_coordinate_system, a export materiálu.
ColladaFormatPopis formátu pre COLLADA. Automaticky určený z .dae prípony súboru.

3MF Format

ExampleExample
ThreeMfLoadOptionsMožnosti načítania pre 3MF (.3mf) súbory.
ThreeMfSaveOptionsUložiť možnosti pre výstup 3MF. 3MF je preferovaný formát pre pracovné postupy 3D tlače.
ThreeMfFormatPopisovač formátu pre 3MF. Prístupný ako FileFormat.MICROSOFT_3MF_FORMAT().

Example

ExampleExample
TextureMappingUrčuje, ako je textúra mapovaná na geometriu: DIFFUSE, SPECULAR, EMISSIVE, NORMAL, AMBIENT, atď.
BooleanOperationTyp Booleovskej operácie CSG: UNION, DIFFERENCE, INTERSECTION.

Systém vlastností

ExampleExample
PropertyA jedinečná pomenovaná typová vlastnosť na A3DObject. Ukladá názov vlastnosti, popisovač typu a aktuálnu hodnotu.
PropertyCollectionIterovateľná kolekcia 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

ExampleExample
ImageRenderOptionsMož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ž

 Slovenčina