API-Referenz für aspose-3d-foss 26.1.0 (Python 3.7 – 3.12, MIT-Lizenz).
Alle Klassen werden importiert aus dem aspose.threed Paket oder dessen Unterpaketen. Der Basisimport ist:
Kern‑Szenengraph
| Methods | Methods |
|---|
Scene | Container auf höchster Ebene für alle 3D‑Szenendaten. Enthält den Wurzelknoten, Asset-Metadaten und Animationsclips. Stellt bereit from_file(), open(), und save() als die primären I/O-Einstiegspunkte. |
Node | Ein benannter Knoten in der Szenenhierarchie. Besitzt eine Liste von Kindknoten und eine Liste von angehängten Entity Objekten wie Meshes, Kameras und Lichtern. Trägt ein lokales Transform. |
Entity | Abstrakte Basisklasse für alle Objekte, die an ein Node. Liefert Namen und Identität, aber keine eigene Geometrie. |
SceneObject | Basisklasse, die geteilt wird von Node und Entity. Stellt die Schnittstelle für die Eigenschaftssammlung bereit, die für benutzerdefinierte Metadaten verwendet wird. |
A3DObject | Wurzelbasisklasse für alle Aspose.3D verwalteten Objekte. Gibt die Namenseigenschaft und die Properties Sammlung. |
INamedObject | Schnittstelle, die ein name Eigenschaft. Implementiert von Node, Entity, und mehreren format-spezifischen Deskriptortypen. |
Geometrie und Mesh
| Methods | Methods |
|---|
Mesh | Polygonnetz-Entität. Speichert Kontrollpunkte (Scheitelpunktpositionen als Vector4), Polygonflächenlisten (Listen von Kontrollpunktindizes) und Vertex-Elementebenen (Normalen, UVs, Vertex-Farben). |
Geometry | Abstrakte Basisklasse für netzartige Geometrietypen. Definiert das Kontrollpunkt‑Array und die Sammlung von VertexElement Ebenen. Mesh erbt von Geometry. |
VertexElement | Abstrakte Basisklasse für eine Datenschicht, die an Geometrie angehängt ist (Normalen, UVs, Farben usw.). Enthält mapping_mode, reference_mode, und ein data Liste. |
VertexElementNormal | Speichert einen Normalenvektor pro Scheitelpunkt oder pro Polygon‑Ecke, abhängig von mapping_mode. Datenwerte sind FVector4 Instanzen (Einzelpräzision) mit w ungenutzt. |
VertexElementUV | Speichert Texturkoordinatendaten als FVector4 pro Scheitelpunkt oder pro Polygon‑Ecke (nur x und y Komponenten werden für UV verwendet). Ein Mesh kann mehrere UV‑Layer für verschiedene Texturkanäle enthalten. |
VertexElementVertexColor | Speichert pro Scheitelpunkt oder pro Ecke RGBA‑Farbdaten als FVector4 (r, g, b, a im Bereich 0–1). |
VertexElementSmoothingGroup | Speichert pro Polygon Glättungsgruppen‑Integer‑IDs, die vom OBJ‑Importer verwendet werden, um die ursprünglichen Glättungsgruppenzuweisungen aus der Quelldatei wiederzugeben. |
VertexElementType | Aufzählung, die die semantische Rolle einer Vertex‑Element‑Schicht identifiziert: NORMAL, UV, VERTEX_COLOR, SMOOTHING_GROUP, und andere. Werte übergeben an Mesh.get_element(). |
MappingMode | Aufzählung, die steuert, welchem Primitive ein Vertex‑Element‑Wert zugeordnet wird: CONTROL_POINT, POLYGON_VERTEX, POLYGON, EDGE, oder ALL_SAME. |
ReferenceMode | Aufzählung, die steuert, wie Werte indiziert werden: DIRECT (ein Wert pro Mapping-Primitive) oder INDEX_TO_DIRECT (Werte-Array plus ein separates Index-Array). |
PolygonModifier | Statische Hilfsklasse mit Methoden zum Triangulieren Mesh Objekte und gesamte Scene Graphen. |
Transformation und Spatial
| Methods | Methods |
|---|
Transform | Lokale Transformation, die an ein(e) Node. Bietet Translation, Rotation (als Quaternion), und Skalierungs-Komponenten, plus Komfort-Eigenschaften für Euler-Winkel. |
GlobalTransform | Nur-Lese-Ansicht der Welt-Raum-Transformation eines Knotens nach Zusammensetzen aller übergeordneten Transformationen. Zugriff über Node.global_transform. |
AssetInfo | Metadatenblock, der an ein(e) Scene. Speichert den Namen der Erstellungsanwendung, den Einheitennamen, den Einheitenskalierungsfaktor, die Achsendefinitionen des Koordinatensystems sowie Erstellungs-/Änderungszeitstempel. |
Materialien und Shading
| Methods | Methods |
|---|
Material | Abstrakte Basisklasse für alle Materialtypen. Stellt einen Namen und eine Eigenschaftssammlung für numerische und Farbparameter bereit. |
LambertMaterial | Nur-diffuses Materialmodell. Speichert Umgebungsfarbe, Diffusfarbe, Emissionsfarbe und Transparenz. Geladen aus OBJ-Dateien, die grundlegende Ka/Kd/Ke Deklarationen. |
PhongMaterial | Methods LambertMaterial mit Spiegelungsfarbe und Glanz (specular exponent). Geladen aus OBJ-Dateien, die Ks/Ns Deklarationen. |
PbrMaterial | Physically Based Rendering‑Material. Speichert Albedo, Metallfaktor, Rauheitsfaktor und zugehörige Texturen. Wird von glTF 2.0 und anderen PBR‑fähigen Formaten verwendet. |
Kamera und Beleuchtung
| Methods | Methods |
|---|
Camera | Kamera‑Entität. Nur projection_type und name sind in dieser Ausgabe funktionsfähig; alle anderen numerischen Eigenschaften (near_plane, far_plane, field_of_view, aspect_ratio) sind Platzhalter, die Standardwerte zurückgeben. Angehängt an ein Node um Sichtpunkt‑Transformationen zu definieren. |
Light | Lichtquellen-Entität. Erbt von Camera als Stub-Klasse; die Light Klasse selbst stellt in dieser Version keine zusätzlichen Eigenschaften bereit. |
LightType | Aufzählung der unterstützten Lichtkategorien: POINT, DIRECTIONAL, SPOT, AREA, VOLUME. |
ProjectionType | Aufzählung der Kameraprojektionsmodi: PERSPECTIVE und ORTHOGRAPHIC. |
Mathe‑Hilfsprogramme
| Methods | Methods |
|---|
Vector2 | Doppelpräzisions-2-Komponenten-Vektor (x, y). Verwendet für UV-Texturkoordinaten. |
Vector3 | Doppelpräzisions-3-Komponenten-Vektor (x, y, z). Verwendet für Positionen, Richtungen und Skalierung. |
Vector4 | Doppelpräzisions-4-Komponenten-Vektor (x, y, z, w). Verwendet für Kontrollpunkte (homogene Positionen) und Normaldaten. |
FVector2 | Einzelpräzisions‑Vektor mit 2 Komponenten vom Typ float. Intern verwendet für kompakte Speicherung in Vertex‑Element‑Datenarrays. |
FVector3 | Einzelpräzisions‑Vektor mit 3 Komponenten vom Typ float. Erscheint in Vertex‑Element‑Datenarrays für Normalen und Tangenten. |
FVector4 | Einzelpräzisions‑Vektor mit 4 Komponenten vom Typ float. Der Speichertyp von VertexElementFVector.data. |
Quaternion | Einheitsquaternion zur Darstellung von Rotationen (w, x, y, z). Verwendet von Transform.rotation. |
Matrix4 | 4×4 double-precision transformation matrix. Used for world/local transform computations and can be constructed from TRS decompositions. |
BoundingBox | Achsenorientierte Begrenzungsbox definiert durch minimum und maximum Vector3 Ecken. Verwendet für räumliche Abfragen und Frustum‑Culling‑Hilfen. |
Methods
| Methods | Methods |
|---|
AnimationClip | Benannter Container für einen Satz animierter Kanäle, die einen Wiedergabebereich abdecken. Ein Scene kann mehrere Clips enthalten (z. B. „Walk“, „Run“). |
AnimationNode | Bindet ein AnimationClip an einen bestimmten Szenenknoten oder eine Eigenschaft. Dient als Brücke zwischen Clip-Daten und Objekten des Szenengraphen. |
AnimationChannel | Ein einzelner animierter Eigenschaftsstrom innerhalb eines Clips, der eine benannte Eigenschaft eines Objekts anspricht (z. B., Transform.translation.x). |
KeyFrame | Ein einzelnes Zeit‑Wert‑Sample innerhalb eines KeyframeSequence. Speichert die Zeit (in Sekunden) und den Wert zu diesem Zeitpunkt. |
KeyframeSequence | Eine geordnete Liste von KeyFrame Objekten für einen skalaren Kanal, zusammen mit Interpolations‑ und Extrapolationseinstellungen. |
Interpolation | Aufzählung der Interpolationsmodi zwischen Schlüsselbildern: CONSTANT, LINEAR, BEZIER, B_SPLINE, CARDINAL_SPLINE, TCB_SPLINE. |
ExtrapolationType | Aufzählung der Verhaltensweisen jenseits des ersten und letzten Schlüsselbildes: CONSTANT, GRADIENT, CYCLE, CYCLE_RELATIVE, OSCILLATE. |
Format‑E/A
| Methods | Methods |
|---|
Scene.from_file(path) | Statische Methode. Öffnet die Datei bei path, erkennt das Format anhand der Erweiterung und gibt ein ausgefülltes Scene. Wirft bei Datei‑nicht‑gefunden oder nicht unterstütztem Format. |
Scene.open(path, options=None) | Instanzmethode. Öffnet eine Datei in ein bestehendes Scene Instanz, optional unter Verwendung einer format-spezifischen LoadOptions Unterklasse. |
Scene.save(path, options=None) | Instanzmethode. Serialisiert die Szene nach path unter Verwendung des aus der Erweiterung abgeleiteten Formats, optional unter Nutzung einer format-spezifischen SaveOptions Unterklasse. |
FileFormat | Register unterstützter Dateiformate. Enthält Einträge wie FileFormat.WAVEFRONT_OBJ, FileFormat.GLTF, FileFormat.FBX7400ASCII, FileFormat.MICROSOFT_3MF. Format-spezifische Varianten werden über Optionsklassen (z. B., ColladaSaveOptions, GltfSaveOptions). |
IOService | Interne I/O-Abstraktion, die von Format-Importeuren und -Exporteuren verwendet wird. Wird normalerweise nicht direkt vom Anwendungscode genutzt. |
LoadOptions | Basisklasse für alle format-spezifischen Ladeoption-Objekte. Subklassiert von ObjLoadOptions, StlLoadOptions, GltfLoadOptions, FbxLoadOptions, ColladaLoadOptions, ThreeMfLoadOptions. |
SaveOptions | Basisklasse für alle format-spezifischen Speicheroption-Objekte. Subklassiert von ObjSaveOptions, StlSaveOptions, GltfSaveOptions, FbxSaveOptions, ColladaSaveOptions, ThreeMfSaveOptions. |
OBJ-Format
| Methods | Methods |
|---|
ObjImporter | Interne Importerklasse, die Wavefront OBJ- und MTL-Dateien analysiert. Wird automatisch aufgerufen von Scene.from_file() für .obj Erweiterungen. |
ObjLoadOptions | Ladeoptionen für Wavefront OBJ-Dateien. Wichtige Eigenschaften: flip_coordinate_system, scale, enable_materials, normalize_normal. |
ObjSaveOptions | Speicheroptionen für Wavefront OBJ-Ausgabe. Steuert Normalen, UVs, Materialreferenzen und den Punktwolkenmodus. |
ObjFormat | Formatbeschreibung für Wavefront OBJ. Zugänglich als FileFormat.WAVEFRONT_OBJ(). |
STL-Format
| Methods | Methods |
|---|
StlImporter | Interner Importer, der sowohl binäre als auch ASCII STL-Dateien liest. Wird automatisch nach Erweiterung ausgewählt. |
StlExporter | Interner Exporter, der STL schreibt. |
StlLoadOptions | Ladeoptionen für STL-Dateien. Unterstützt flip_coordinate_system und scale. |
StlSaveOptions | Speicheroptionen für STL-Ausgabe. Steuerelemente binary_mode, scale, und flip_coordinate_system. |
StlFormat | Formatbeschreibung für STL. |
glTF-Format
| Methods | Methods |
|---|
GltfLoadOptions | Ladeoptionen für glTF 2.0- und GLB-Dateien. Schlüsseleigenschaft: flip_tex_coord_v. |
GltfSaveOptions | Speicheroptionen für glTF 2.0-Ausgabe. Verwenden Sie binary_mode=True für ein eigenständiges GLB-Paket. |
GltfFormat | Formatbeschreibung für glTF 2.0 / GLB. Zugänglich als FileFormat.GLTF2(). |
FBX-Format
| Methods | Methods |
|---|
FbxLoadOptions | Ladeoptionen für FBX-Dateien. Schlüsseleigenschaften: keep_builtin_global_settings, compatible_mode. |
FbxSaveOptions | Speicheroptionen für FBX-Ausgabe. FBX-Export löst aus NotImplementedError unbedingt; FbxSaveOptions existiert, aber Export ist nicht implementiert. |
FbxFormat | Formatbeschreibung für FBX. Zugänglich als FileFormat.FBX7400ASCII(). |
COLLADA-Format
| Methods | Methods |
|---|
ColladaLoadOptions | Ladeoptionen für COLLADA (.dae) Dateien. Steuert die Achsen‑Neuzuordnung und die Einheitenskala beim Import. |
ColladaSaveOptions | Speicheroptionen für COLLADA-Ausgabe. Steuert indented, flip_coordinate_system, und den Materialexport. |
ColladaFormat | Formatbeschreibung für COLLADA. Wird automatisch ermittelt aus .dae Dateierweiterung. |
3MF Format
| Methods | Methods |
|---|
ThreeMfLoadOptions | Ladeoptionen für 3MF (.3mf) Dateien. |
ThreeMfSaveOptions | Speicheroptionen für 3MF-Ausgabe. 3MF ist das bevorzugte Format für 3D‑Druck‑Workflows. |
ThreeMfFormat | Formatbeschreibung für 3MF. Zugänglich als FileFormat.MICROSOFT_3MF_FORMAT(). |
Methods
| Methods | Methods |
|---|
TextureMapping | Identifiziert, wie eine Textur auf Geometrie abgebildet wird: DIFFUSE, SPECULAR, EMISSIVE, NORMAL, AMBIENT, usw. |
BooleanOperation | CSG-Boolescher Operationstyp: UNION, DIFFERENCE, INTERSECTION. |
Eigenschaftssystem
| Methods | Methods |
|---|
Property | Eine einzelne benannte typisierte Eigenschaft auf einem A3DObject. Speichert den Eigenschaftsnamen, die Typbeschreibung und den aktuellen Wert. |
PropertyCollection | Iterierbare Sammlung von Property Objekte, die an einem A3DObject. Unterstützt das Nachschlagen nach Namen und die Iteration über alle definierten Eigenschaften. |
CustomObject | Ein leichtgewichtiges A3DObject Unterklasse, die nur einen Namen und ein beliebiges PropertyCollection. Wird verwendet, um benutzerdefinierte Metadaten an Szenenobjekten zu speichern. |
Bild und Render
| Methods | Methods |
|---|
ImageRenderOptions | Optionen für die Software‑Rasterisierung beim Rendern einer Szene in einen Bildpuffer. Speichert Hintergrundfarbe, Bildabmessungen und Kamerareferenz. Scene.render() wirft NotImplementedError; Rendering ist in dieser Version nicht implementiert. |
Siehe auch