Python scripting tutorial/de

Einführung
Python ist eine Programmiersprache, sehr einfach zu bedienen und sehr schnell zu erlernen. Sie ist quelloffen, plattformübergreifend und kann für eine Vielzahl von Aufgaben allein verwendet werden, von der Programmierung einfacher Shell Skripte bis hin zu sehr komplexen Programmen. Aber eine der am weitesten verbreiteten Anwendungen ist die Skriptsprache, da sie leicht in andere Anwendungen integriert werden kann. Genau so wird es in FreeCAD verwendet. Von der Python Konsole oder von deinen benutzerdefinierten Skripten aus kannst du FreeCAD steuern und es sehr komplexe Aktionen ausführen lassen.

Zum Beispiel aus einem Python Skript, kannst Du:
 * neue Objekte erstellen
 * bestehende Objekte ändern
 * die 3D Darstellung dieser Objekte ändern
 * die FreeCAD Oberfläche verändern

Es gibt mehrere Möglichkeiten, Python in FreeCAD zu verwenden:
 * Aus dem FreeCAD Python Interpreter, wo du einfache Befehle wie in einer "Kommandozeile" ähnlichen Oberfläche ausgeben kannst.
 * Aus Makros, die eine bequeme Möglichkeit darstellen, ein fehlendes Werkzeug schnell zur FreeCAD Oberfläche hinzuzufügen.
 * Aus externen Skripten, mit denen man viel komplexere Dinge programmieren kann, wie z.B. ganze Arbeitsbereiche.

In diesem Tutorial werden wir an ein paar einfachen Beispielen arbeiten, um dir den Einstieg zu erleichtern, aber es gibt auch viel mehr Dokumentation über Python Skripten auf diesem Wiki. Wenn du völlig neu in Python bist und verstehen willst, wie es funktioniert, haben wir auch eine grundlegende Einführung in Python.

Bevor Du mit dem Python Skripting fortfährst, gehe zum und hake 2 Kästchen an: Dann gehe zu  und hake an:



Python Code schreiben
Es gibt zwei einfache Wege, Python Code in FreeCAD zu schreiben: Über die Python Konsole (verfügbar im Menü Ansicht → Paneele → Python Konsole) oder über den Makro Editor (Werkzeuge → Makros). In der Konsole schreibst Du nacheinander Python Befehle, die ausgeführt werden, wenn Du die Eingabetaste drückst, während die Makros ein komplexeres Skript aus mehreren Zeilen enthalten können, das erst bei der Ausführung des Makros ausgeführt wird.



In diesem Tutorium kannst Du beide Methoden verwenden. Du kannst Kopieren/Einfügen von einzelnen Zeilen in die Python Konsole und drücken der oder Kopieren/Einfügen des gesamten Codes in ein neues Makro Fenster.



Erkunden von FreeCAD
Wir beginnen damit, ein neues leeres Dokument zu erstellen:

Wenn du dies in der FreeCAD Python Konsole eingibst, wirst du feststellen, dass sobald du eingibst, ein Fenster erscheint, in dem du den Rest deiner Zeile schnell automatisch vervollständigen kannst. Besser noch, jeder Eintrag in der Autovervollständigungsliste hat einen Werkzeugtip, der erklärt, was er tut. Dies macht es einfacher, die verfügbare Funktionalität zu erkunden. Bevor du wählst, wirf einen Blick auf die anderen Optionen.



Nun wird unser neues Dokument erstellt. Dies ist ähnlich wie das Drücken der Schaltfläche in der Werkzeugleiste. Tatsächlich tun die meisten Schaltflächen in FreeCAD nichts anderes, als eine oder mehrere Zeilen Python Code auszuführen. Noch besser, du kannst eine Option in auf  setzen. Dadurch wird in der Konsole der gesamte Python Code ausgegeben, der ausgeführt wird, wenn fu Tasten drückst. Sehr nützlich, um zu lernen, wie man Aktionen in Python reproduziert.

Lass uns nun zu unserem Dokument zurückkehren und sehen, was wir mit ihm machen können:

Erkunde die verfügbaren Optionen. Normalerweise sind Namen, die mit einem Großbuchstaben beginnen, Attribute, sie enthalten einen Wert, während Namen, die mit einem Kleinbuchstaben beginnen, Funktionen (auch Methoden genannt) sind, sie "tun etwas". Namen, die mit einem Unterstrich beginnen, sind normalerweise für die interne Arbeit des Moduls da, und du solltest dich nicht um sie kümmern. Lasse uns eine der Methoden verwenden, um ein neues Objekt zu unserem Dokument hinzuzufügen:

Es geschieht nichts. Warum nicht? Weil FreeCAD für das große Ganze gemacht ist. Eines Tages wird es mit Hunderten von komplexen Objekten arbeiten, die alle voneinander abhängen. Wenn du irgendwo eine kleine Änderung vornimmst, kann das große Auswirkungen haben, und du musst vielleicht das ganze Dokument neu berechnen, was sehr lange dauern kann. Aus diesem Grund aktualisiert fast kein Befehl die Szene automatisch. Du musst es manuell durchführen:

Nun erschien unser Würfel. Viele der Schaltflächen, mit denen in FreeCAD Objekte hinzugefügt werden können, tun eigentlich zwei Dinge: das Objekt hinzufügen und neu berechnen. Wenn du die obige Option eingeschaltet hast, versuche, mit der GUI Schaltfläche eine Kugel hinzuzufügen. Du wirst sehen, wie die beiden Zeilen des Python Codes nacheinander ausgeführt werden.

Lass uns nun den Inhalt unseres Würfels erkunden:

Du wirst sofort einige sehr interessante Dinge sehen, wie zum Beispiel:

Dadurch wird die aktuelle Höhe unseres Würfels ausgegeben. Lass uns nun versuchen das zu ändern:

Wenn du dein Feld mit der Maus auswählst, siehst du, dass im Eigenschaftseditor auf dem Reiter unsere Eigenschaft  erscheint. Alle Eigenschaften eines FreeCAD Objekts, die dort (und auch auf dem Reiter erscheinen, dazu später mehr), sind auch von Python direkt zugänglich, und zwar über ihren Namen, wie wir es mit der  Eigenschaft getan haben. Versuche, die anderen Dimensionen des Würfels zu ändern.



Vektoren und Platzierungen
Vektoren sind ein fester Bestandteil jeder 3D-Anwendung. Ein Vektor ist dabei eine Liste von Zahlen (x,y,z), die einen Ort im dreidimensionalen Raum beschreiben. Mit Vektoren sind verschiedene mathematische Operationen möglich, wie z.B. Addition, Subtraktion, Projektion (Skalarprodukt) und vieles mehr. In FreeCAD funktionieren Vektoren wie folgt:

Ein weiteres gemeinsames Merkmal von FreeCAD Objekten ist ihre Placement. Jedes Objekt hat eine s Eigenschaft, die die enthält. (Position) und (Orientierung) des Objekts. Es ist leicht zu bearbeiten, zum Beispiel um unser Objekt zu bewegen:

Nun musst du einige wichtige Konzepte verstehen, bevor wir weiter kommen.



App und GUI
FreeCAD wurde von Anfang an als Kommandozeilen-Anwendung konzipiert, d.h. ohne notwendige Benutzeroberfläche. Als Folge davon ist fast alles zwischen einer "geometrischen" Komponente und einer "visuellen" Komponente aufgeteilt. Wenn man im Kommandozeilenmodus arbeitet, dann ist der geometrische Teil vorhanden, aber der visuelle Teil deaktiviert. Fast jedes Objekt in FreeCAD besteht deshalb aus zwei Teilen, einem Object und einem ViewObject (Objektansicht).

Um das Konzept zu veranschaulichen, schauen wir uns unser Würfel Objekt an. Die geometrischen Eigenschaften des Würfels wie Abmessungen, Position usw. sind im gespeichert. Während seine visuellen Eigenschaften wie Farbe, Linienstärke usw. im gespeichert sind, werden seine visuellen Eigenschaften wie Farbe, Linienstärke usw. im gespeichert. Dies entspricht den Daten und Ansicht Reitern im Eigenschaftseditor. Auf das Ansicht Objekt eines Objekts wird wie folgt zugegriffen:

Jetzt kannst du auch die Eigenschaften auf dem Ansicht Reiter ändern:

Wenn du FreeCAD startest, lädt die Python Konsole bereits zwei Basismodule: und  (die auch über ihre Kürzel  und  erreicht werden können). Sie enthalten alle Arten von generischer Funktionalität für die Arbeit mit Dokumenten und ihren Objekten. Um unser Konzept zu veranschaulichen, siehe, dass sowohl als auch  ein  Attribut enthalten, das das aktuell geöffnete Dokument ist. und sind jedoch nicht dasselbe Objekt. Sie sind die beiden Komponenten eines FreeCAD Dokuments, und sie enthalten unterschiedliche Attribute und Methoden. So enthält z.B., welches die aktuell geöffnete 3D Ansicht ist.

Module
Die wahre Stärke von FreeCAD liegt in seinen treuen Modulen mit ihren jeweiligen Arbeitsbereichen. Die FreeCAD Basisanwendung ist mehr oder weniger ein leerer Behälter. Ohne seine Module kann es kaum mehr tun, als neue, leere Dokumente zu erstellen. Jedes Modul fügt der Oberfläche nicht nur neue Arbeitsbereiche hinzu, sondern auch neue Python Befehle und neue Objekttypen. So können mehrere verschiedene, sogar völlig inkompatible Objekttypen in einem Dokument koexistieren. Die wichtigsten Module in FreeCAD, die wir uns in diesem Tutorium ansehen werden, sind: Part, Netz, Skizzierer und Entwurf.

Skizzierer und Entwurf verwenden beide das Part Modul, um ihre Geometrie zu erzeugen und handzuhaben. Während Netz völlig unabhängig ist und seine eigenen Objekte handhabt. Mehr dazu weiter unten.

Du kannst alle verfügbaren Basisobjekttypen für das aktuelle Dokument folgendermaßen prüfen:

Die verschiedenen FreeCAD Module werden nicht automatisch in die Python Konsole geladen. Damit soll ein sehr langsamer Start vermieden werden. Die Module werden nur geladen, wenn du sie benötigst. So kannst du z.B. untersuchen, was sich innerhalb des Part Moduls befindet:

Aber wir werden weiter unten mehr über das Part Modul sprechen.



Modul Mesh
Polygonnetze (engl.: Meshes) sind eine sehr einfache Art von 3D Objekten, die z.B. von Sketchup, Blender und 3D Studio Max verwendet werden. Sie werden aus 3 Elementen gebildet: Punkte (auch Knoten genannt), Linien (auch Kanten genannt) und Flächen. In vielen Anwendungen, einschließlich FreeCAD, können Flächen nur 3 Knoten haben. Natürlich hindert Dich nichts daran, eine größere ebene Fläche aus mehreren nebeneinander liegenden Dreiecken zu haben.

Polygonnetze sind einfach, aber weil sie einfach sind, kannst Du leicht Millionen von ihnen in einem einzigen Dokument haben. Allerdings sind sie in FreeCAD weniger nützlich und meist vorhanden, so dass Du Objekte in Netzformaten  aus anderen Anwendungen importieren kannst. Das Netzmodul wurde auch im ersten Monat des FreeCAD Lebens ausgiebig als Haupttestmodul verwendet.

Netzobjekte und FreeCAD Objekte sind unterschiedliche Dinge. Du kannst das FreeCAD Objekt als einen Behälter für ein Netzobjekt betrachten (und wie wir unten sehen werden, auch für Part Objekte). Um also ein Netz Objekt zu FreeCAD hinzuzufügen, müssen wir zuerst ein FreeCAD Objekt und ein Mesh Objekt erstellen und dann das Netz Objekt zum FreeCAD Objekt hinzufügen:

Dies ist ein Standardbeispiel, das die Methode verwendet, um eine Kugel zu erstellen, aber Du kannst auch benutzerdefinierte Netze von Grund auf neu erstellen, indem Du ihre Knoten und Flächen definierst.

Lies mehr über Netz Skripten...



Modul Part
Das Part Modul ist das leistungsfähigste Modul im gesamten FreeCAD. Es erlaubt Dir BREP Objekte zu erstellen und zu verändern. Diese Art von Objekten kann, im Gegensatz zu Netzen, eine Vielzahl von Komponenten haben. BREP steht für Begrenzungsflächenmodell (engl.: Boundary Representation), was bedeutet, dass BREP Objekte durch ihre Oberflächen definiert werden; diese Oberflächen umschließen und definieren ein Innenvolumen. Eine Oberfläche kann eine Vielzahl von Dingen sein, wie z.B. ebene Flächen oder sehr komplexe NURBS Oberflächen.

Das Part Modul basiert auf der leistungsstarken OpenCasCade Bibliothek, die es ermöglicht, eine Vielzahl von komplexen Operationen auf diesen Objekten einfach durchzuführen, wie z.B. boolesche Operationen, Verrundungung, Ausformungen, usw.

Das Part-Modul arbeitet auf dieselbe Weise wie das Netz Modul: Man erzeugt ein FreeCAD Objekt, ein Part Objekt, danach fügt man das Part Objekt zum FreeCAD Objekt hinzu:

Das Part Modul (wie das Netz Modul) hat auch ein Tastaturkürzel, das automatisch ein FreeCAD Objekt erstellt und eine Form hinzufügt, so dass du die letzten drei Zeilen verkürzen kannst auf:

Beim erforschen der Inhalt von myshape, wirst Du viele interessante Unterkomponenten wie, , , und , und eine weite Bandbreite von Geometrieoperationen wie  (Subtraktion),  (Schnittpunkt) oder  (Vereinigung) bemerken. Die Topologisches Daten Skripten Seite erklärt all das im Detail.

Lies mehr über Part Skripten...



Modul Draft
FreeCAD bietet noch viele weitere Module, wie Skizzierer und Entwurf, die ebenfalls Teilobjekte erzeugen. Diese Module fügen zusätzliche Parameter zu den erzeugten Objekten hinzu oder implementieren sogar eine völlig neue Art und Weise, die Teilegeometrie in ihnen zu handhaben. Unser obiges Box Beispiel ist ein perfektes Beispiel für ein parametrisches Objekt. Alles was Du zur Definition der Box benötigst, ist die Angabe der Parameter Höhe, Breite und Länge. Basierend auf diesen Parametern berechnet das Objekt automatisch seine Teileform. FreeCAD erlaubt es Dir Erzeuge solche Objekte in Python.

Das Entwurf Modul fügt parametrische 2D Objekttypen (die alle Part Objekte sind) wie Linien und Kreise hinzu und bietet auch einige grundlegende Funktionen, die nicht nur auf Entwurfsobjekte, sondern auf jedes Part Objekt wirken. Um zu erkunden, was verfügbar ist, mache einfach:

Benutzeroberfläche
Die Benutzeroberfläche von FreeCAD ist mit Qt, einer leistungsstarken grafischen Schnittstellensystem, erstellt worden, das für das Zeichnen und die Handhabung aller Bedienelemente, Menüs, Werkzeugleisten und Schaltflächen rund um die 3D Ansicht verantwortlich ist. Qt stellt ein Modul, PySide, zur Verfügung, welches Python erlaubt, auf die Qt Schnittstellen wie FreeCAD zuzugreifen und zu verändern. Lass uns versuchen, mit der Qt Schnittstelle zu tüfteln und einen einfachen Dialog zu erzeugen:

Beachte, dass der erscheinende Dialog das FreeCAD Symbol in seiner Werkzeugleiste hat, was bedeutet, dass Qt weiß, dass der Auftrag aus der FreeCAD Anwendung heraus erteilt wurde. Es ist möglich, jeden Teil der FreeCAD Oberfläche zu verändern.

Qt ist ein sehr mächtiges Schnittstellensystem, das es dir erlaubt, sehr komplexe Dinge zu tun. Es hat auch einige einfach zu benutzende Werkzeuge wie den Qt Designer, mit dem du Dialoge grafisch entwerfen kannst und sie dann mit ein paar Zeilen Python Code zur FreeCAD Oberfläche hinzufügen kannst.

Erfahre hier mehr über PySide...

Makros
Nun, da Du ein gutes Verständnis der Grundlagen hast, wo werden wir unsere Python Skripte aufbewahren und wie werden wir sie einfach von FreeCAD aus starten? Dafür gibt es einen einfachen Mechanismus, genannt Makros. Ein Makro ist einfach ein Python Skript, das zu einer Werkzeugleiste hinzugefügt und per Mausklick gestartet werden kann. FreeCAD bietet dir einen einfachen Texteditor, in dem du Skripte schreiben oder einfügen kannst. Sobald das Skript fertig ist, verwende, um eine Schaltfläche dafür zu definieren, die zu den Werkzeugleisten hinzugefügt werden kann.

External scripts
An alternative method for creating, saving, and running your own Python scripts is to create them outside FreeCAD, using an editor of your choice (for example, Vim). To run your Python script inside FreeCAD, be sure to save it with the extension.

Then use to open your script. It will load into a new tab in the Main view area. You can run your script by clicking the button. Any errors or script output will be shown in the Report view.

When you make and save any modifications to your already-loaded script, a dialog box will appear asking whether you want to reload the modified script into FreeCAD.

Jetzt bist Du bereit für eine vertieftere FreeCAD Skripterstellung. Gehe weiter zum Verteiler für Erfahrene Anwender!