API reference pro aspose-3d-foss 26.1.0 (Python 3.7 – 3.12, licence MIT).
Všechny třídy jsou importovány z aspose.threed balíčku nebo jeho podbalíčků. Kořenový import je:
Jádrový graf scény
| Methods | Methods |
|---|
Scene | Kontejner nejvyšší úrovně pro všechna 3D data scény. Uchovává kořenový uzel, metadata aktiv a animační klipy. Poskytuje from_file(), open(), a save() jako hlavní vstupní/výstupní body. |
Node | Pojmenovaný uzel v hierarchii scény. Obsahuje seznam podřízených uzlů a seznam připojených Entity objektů, jako jsou sítě, kamery a světla. Nese lokální Transform. |
Entity | Abstraktní základní třída pro všechny objekty, které mohou být připojeny k Node. Poskytuje název a identitu, ale nemá vlastní geometrii. |
SceneObject | Základní třída sdílená Node a Entity. Poskytuje rozhraní kolekce vlastností používané pro uživatelem definovaná metadata. |
A3DObject | Kořenová základní třída pro všechny Aspose.3D spravované objekty. Exponuje vlastnost name a the Properties kolekce. |
INamedObject | Rozhraní, které zaručuje name vlastnost. Implementováno v Node, Entity, a několik formátově specifických typů deskriptorů. |
Geometrie a síť
| Methods | Methods |
|---|
Mesh | Entita polygonové sítě. Ukládá řídicí body (pozice vrcholů jako Vector4), seznamy polygonových ploch (seznamy indexů řídicích bodů) a vrstvy elementů vrcholů (normály, UV, barvy vrcholů). |
Geometry | Abstraktní základ pro typy geometrie podobné sítím. Definuje pole řídicích bodů a kolekci VertexElement vrstev. Mesh dědí z Geometry. |
VertexElement | Abstraktní základ pro datovou vrstvu připojenou k geometrii (normály, UV, barvy atd.). Nese mapping_mode, reference_mode, a data seznam. |
VertexElementNormal | Ukládá jeden normálový vektor na vrchol nebo na roh polygonu, v závislosti na mapping_mode. Hodnoty dat jsou FVector4 instance (jednoduchá přesnost) s w nepoužité. |
VertexElementUV | Ukládá data texturovacích souřadnic jako FVector4 na vrchol nebo na roh polygonu (pouze x a y komponenty jsou použity pro UV). Síť může nést více UV vrstev pro různé texturové kanály. |
VertexElementVertexColor | Ukládá data barvy RGBA na úrovni vrcholu (per-vertex) nebo rohu (per-corner) jako FVector4 (r, g, b, a v rozsahu 0–1). |
VertexElementSmoothingGroup | Ukládá celočíselná ID skupin vyhlazování per-polygon, která importér OBJ používá k reprodukci původních přiřazení skupin vyhlazování ze zdrojového souboru. |
VertexElementType | Výčet identifikující sémantickou roli vrstvy elementu vrcholu: NORMAL, UV, VERTEX_COLOR, SMOOTHING_GROUP, a další. Předávejte hodnoty do Mesh.get_element(). |
MappingMode | Výčtový typ řídící, ke kterému primitivu se hodnota vrcholového elementu mapuje: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, nebo ALL_SAME. |
ReferenceMode | Výčtový typ řídící, jak jsou hodnoty indexovány: DIRECT (jedna hodnota na mapovací primitivum) nebo INDEX_TO_DIRECT (pole hodnot plus samostatné pole indexů). |
PolygonModifier | Statická pomocná třída s metodami pro triangulaci Mesh objektů a celých Scene grafů. |
Transformace a prostorové
| Methods | Methods |
|---|
Transform | Lokální transformace připojená k Node. Poskytuje translaci, rotaci (jako Quaternion), a komponenty měřítka, plus pohodlné vlastnosti pro Eulerovy úhly. |
GlobalTransform | Read‑only pohled na transformaci uzlu ve světovém prostoru po složení všech transformací předků. Přístupné přes Node.global_transform. |
AssetInfo | Metadata blok připojený k Scene. Ukládá název autorovací aplikace, název jednotky, faktor měřítka jednotky, definice os souřadnicového systému a časové značky vytvoření/úpravy. |
Materiály a stínování
| Methods | Methods |
|---|
Material | Abstraktní základní třída pro všechny typy materiálů. Poskytuje název a kolekci vlastností pro číselné a barevné parametry. |
LambertMaterial | Materiálový model pouze s difúzním osvětlením. Ukládá ambientní barvu, difúzní barvu, emisní barvu a průhlednost. Načítá se z OBJ souborů, které používají základní Ka/Kd/Ke deklarace. |
PhongMaterial | Methods LambertMaterial s odleskovou barvou a leskem (speculární exponent). Načítá se z OBJ souborů, které používají Ks/Ns deklarace. |
PbrMaterial | Materiál založený na fyzikálně založeném renderování. Ukládá albedo, kovový faktor, faktor drsnosti a související textury. Používá se v glTF 2.0 a dalších formátech podporujících PBR. |
Kamera a osvětlení
| Methods | Methods |
|---|
Camera | Entita kamery. Pouze projection_type a name jsou v této edici funkční; všechny ostatní číselné vlastnosti (near_plane, far_plane, field_of_view, aspect_ratio) jsou zástupné funkce, které vrací výchozí hodnoty. Připojeno k Node pro definování transformací pohledu. |
Light | Entita světelného zdroje. Dědí z Camera jako zástupné třídy; Light třída sama o sobě v tomto vydání neuvádí žádné další vlastnosti. |
LightType | Výčet podporovaných kategorií světel: POINT, DIRECTIONAL, SPOT, AREA, VOLUME. |
ProjectionType | Výčet režimů projekce kamery: PERSPECTIVE a ORTHOGRAPHIC. |
Matematické utility
| Methods | Methods |
|---|
Vector2 | Dvojitá přesnost 2‑komponentový vektor (x, y). |
Vector3 | Dvojitá přesnost 3‑komponentový vektor (x, y, z). |
Vector4 | Vektor se čtyřmi komponentami s dvojitou přesností (x, y, z, w). Používá se pro řídicí body (homogenní pozice) a data normál. |
FVector2 | Jednopřesnostní 2-komponentový float vektor. Používá se interně pro kompaktní ukládání v polích dat elementů vrcholů. |
FVector3 | Jednopřesnostní 3-komponentový float vektor. Objevuje se v polích dat elementů vrcholů pro normály a tangenty. |
FVector4 | Jednopřesnostní 4‑komponentový float vektor. Typ úložiště pro VertexElementFVector.data. |
Quaternion | Jednotkový kvaternion pro reprezentaci rotací (w, x, y, z) Používá se v Transform.rotation. |
Matrix4 | 4×4 double-precision transformation matrix. Used for world/local transform computations and can be constructed from TRS decompositions. |
BoundingBox | Osově zarovnaná ohraničující krabice definovaná minimum a maximum Vector3 rohy. Používá se pro prostorové dotazy a pomocníky pro ořezávání frustru. |
Methods
| Methods | Methods |
|---|
AnimationClip | Pojmenovaný kontejner pro sadu animovaných kanálů pokrývajících jeden přehrávací rozsah. Scene může obsahovat více klipů (např. „Walk“, „Run“). |
AnimationNode | Váže AnimationClip k určitému uzlu scény nebo vlastnosti. Funguje jako most mezi daty klipu a objekty grafu scény. |
AnimationChannel | Jednotlivý animovaný proud vlastnosti v rámci klipu, cílící na pojmenovanou vlastnost objektu (např., Transform.translation.x). |
KeyFrame | Jednotlivý čas‑hodnotový vzorek v rámci KeyframeSequence. Ukládá čas (v sekundách) a hodnotu v tomto čase. |
KeyframeSequence | Uspořádaný seznam KeyFrame objektů pro jeden skalární kanál, spolu s nastavením interpolace a extrapolace. |
Interpolation | Výčet režimů interpolace mezi klíčovými snímky: CONSTANT, LINEAR, BEZIER, B_SPLINE, CARDINAL_SPLINE, TCB_SPLINE. |
ExtrapolationType | Výčet chování mimo první a poslední klíčový snímek: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE. |
Formát I/O
| Methods | Methods |
|---|
Scene.from_file(path) | Statická metoda. Otevírá soubor na path, zjistí formát podle přípony a vrátí naplněný Scene. Vyvolá výjimku při nenalezení souboru nebo nepodporovaném formátu. |
Scene.open(path, options=None) | Metoda instance. Otevře soubor do existující Scene instance, volitelně pomocí formátově specifické LoadOptions podtřídy. |
Scene.save(path, options=None) | Metoda instance. Serializuje scénu do path používá formát odvozený z přípony, volitelně pomocí formátově specifické SaveOptions podtřídy. |
FileFormat | Registr podporovaných formátů souborů. Obsahuje položky jako FileFormat.WAVEFRONT_OBJ, FileFormat.GLTF, FileFormat.FBX7400ASCII, FileFormat.MICROSOFT_3MF. Varianty specifické pro formát jsou přístupné přes třídy možností (např., ColladaSaveOptions, GltfSaveOptions). |
IOService | Interní abstrakce I/O používaná importéry a exportéry formátů. Obvykle není používána přímo aplikačním kódem. |
LoadOptions | Základní třída pro všechny objekty možností načítání specifické pro formát. Děděna třídou ObjLoadOptions, StlLoadOptions, GltfLoadOptions, FbxLoadOptions, ColladaLoadOptions, ThreeMfLoadOptions. |
SaveOptions | Základní třída pro všechny objekty možností ukládání specifické pro formát. Děděna třídou ObjSaveOptions, StlSaveOptions, GltfSaveOptions, FbxSaveOptions, ColladaSaveOptions, ThreeMfSaveOptions. |
Formát OBJ
| Methods | Methods |
|---|
ObjImporter | Interní třída importéru, která parsuje soubory Wavefront OBJ a MTL. Automaticky volána Scene.from_file() pro .obj přípony. |
ObjLoadOptions | Možnosti načítání pro soubory Wavefront OBJ. Klíčové vlastnosti: flip_coordinate_system, scale, enable_materials, normalize_normal. |
ObjSaveOptions | Uložit možnosti pro výstup Wavefront OBJ. Ovládá normály, UV souřadnice, odkazy na materiály a režim bodového mraku. |
ObjFormat | Popis formátu pro Wavefront OBJ. Přístupný jako FileFormat.WAVEFRONT_OBJ(). |
Formát STL
| Methods | Methods |
|---|
StlImporter | Interní importér, který čte jak binární, tak ASCII soubory STL. Vybráno automaticky podle přípony. |
StlExporter | Interní exportér, který zapisuje STL. |
StlLoadOptions | Možnosti načítání pro soubory STL. Podporuje flip_coordinate_system a scale. |
StlSaveOptions | Možnosti ukládání pro výstup STL. Ovládá binary_mode, scale, a flip_coordinate_system. |
StlFormat | Popis formátu pro STL. |
Formát glTF
| Methods | Methods |
|---|
GltfLoadOptions | Možnosti načítání pro soubory glTF 2.0 a GLB. Klíčová vlastnost: flip_tex_coord_v. |
GltfSaveOptions | Možnosti ukládání pro výstup glTF 2.0. Použijte binary_mode=True pro samostatný balíček GLB. |
GltfFormat | Popis formátu pro glTF 2.0 / GLB. Přístupný jako FileFormat.GLTF2(). |
Formát FBX
| Methods | Methods |
|---|
FbxLoadOptions | Možnosti načítání pro soubory FBX. Klíčové vlastnosti: keep_builtin_global_settings, compatible_mode. |
FbxSaveOptions | Možnosti ukládání pro výstup FBX. Export FBX vyvolá NotImplementedError bezpodmínečně; FbxSaveOptions existuje, ale export není implementován. |
FbxFormat | Popis formátu pro FBX. Přístupný jako FileFormat.FBX7400ASCII(). |
Formát COLLADA
| Methods | Methods |
|---|
ColladaLoadOptions | Možnosti načítání pro COLLADA (.dae) soubory. Ovládá přemapování os a měřítko jednotek při importu. |
ColladaSaveOptions | Uložit možnosti pro výstup COLLADA. Ovládací prvky indented, flip_coordinate_system, a export materiálů. |
ColladaFormat | Popis formátu pro COLLADA. Automaticky rozpoznáno z .dae přípony souboru. |
3MF Format
| Methods | Methods |
|---|
ThreeMfLoadOptions | Načíst možnosti pro 3MF (.3mf) soubory. |
ThreeMfSaveOptions | Uložit možnosti pro výstup 3MF. 3MF je preferovaný formát pro workflow 3D tisku. |
ThreeMfFormat | Popis formátu pro 3MF. Přístupný jako FileFormat.MICROSOFT_3MF_FORMAT(). |
Methods
| Methods | Methods |
|---|
TextureMapping | Určuje, jak je textura mapována na geometrii: DIFFUSE, SPECULAR, EMISSIVE, NORMAL, AMBIENT, atd. |
BooleanOperation | Typ Booleovské operace CSG: UNION, DIFFERENCE, INTERSECTION. |
Systém vlastností
| Methods | Methods |
|---|
Property | Jedna pojmenovaná typová vlastnost na A3DObject. Ukládá název vlastnosti, popis typu a aktuální hodnotu. |
PropertyCollection | Iterovatelná kolekce Property objektů připojených k A3DObject. Podporuje vyhledávání podle názvu a iteraci přes všechny definované vlastnosti. |
CustomObject | Lehká A3DObject podtřída, která nese pouze název a libovolný PropertyCollection. Používá se k ukládání uživatelem definovaných metadat na objektech scény. |
Obrázek a renderování
| Methods | Methods |
|---|
ImageRenderOptions | Možnosti softwarové rasterizace při vykreslování scény do obrazového bufferu. Ukládá barvu pozadí, rozměry obrázku a referenci kamery. Scene.render() vyvolává NotImplementedError; vykreslování není v tomto vydání implementováno. |
Viz také