Scripts/de: Difference between revisions

From FreeCAD Documentation
(Created page with "Normalerweise ist es notwendig, dass sich die Geometrien gegenseitig respektieren. Beim Bau komplexer Objekte ist dies eine wiederkehrende Aufgabe, am häufigsten wird die Geo...")
(Created page with "FreeCAD bietet eine große Auswahl an Möglichkeiten, diese Eigenschaft zu setzen, eine ist mehr auf eine andere zugeschnitten, abhängig vom Wissen und dem Hintergrund des Be...")
Line 182: Line 182:
Normalerweise ist es notwendig, dass sich die Geometrien gegenseitig respektieren. Beim Bau komplexer Objekte ist dies eine wiederkehrende Aufgabe, am häufigsten wird die Geometrie {{incode|Placement}} Eigenschaft verwendet.
Normalerweise ist es notwendig, dass sich die Geometrien gegenseitig respektieren. Beim Bau komplexer Objekte ist dies eine wiederkehrende Aufgabe, am häufigsten wird die Geometrie {{incode|Placement}} Eigenschaft verwendet.


FreeCAD offer a wide choice of ways to set this property, one is more tailored to another depending the knowledge and the background of the user, but the more plain writing is explained in the cited Tutorial, it use a peculiar definition of the {{incode|Rotation}} portion of {{incode|Placement}}, quite easy to learn.
FreeCAD bietet eine große Auswahl an Möglichkeiten, diese Eigenschaft zu setzen, eine ist mehr auf eine andere zugeschnitten, abhängig vom Wissen und dem Hintergrund des Benutzers, aber je klarer das Schreiben im zitierten Tutoriumerklärt wird, verwendet es eine eigentümliche Definition des {{incode|Rotation}} Anteils von {{incode|Placement}}, recht einfach zu erlernen.


{{Code|code=
{{Code|code=

Revision as of 10:42, 14 September 2020

Tutorium
Thema
Skripten
Niveau
Basis
Zeit zum Abschluss
Autoren
onekk Carlo
FreeCAD-Version
0.19
Beispieldateien
Siehe auch
None

Einführung

Unter Skripten verstehen wir die Erstellung topologischer Objekte mit dem Python Interpreter von FreeCAD. FreeCAD könnte ein "sehr guter" Ersatz für OpenSCAD sein, vor allem, weil es einen echten Python Interpreter hat, das heißt, es hat eine echte Programmiersprache an Bord, fast alles, was man mit der GUI machen kann, ist mit einem Python Skript machbar.

Bedauerlicherweise sind die Informationen über das Skripten in der Dokumentation und sogar in diesem Wiki verstreut und es mangelt an Einheitlichkeit beim "Schreiben", und die meisten von ihnen werden zu technisch erklärt.


Befeuchte deinen Appetit

Das erste Hindernis auf einem einfachen Weg zur Skripterstellung ist, dass es keine direkte Möglichkeit gibt, den FreeCAD internen Python Editor über einen Menüeintrag oder ein Symbol im Werkzeugleistenbereich aufzurufen, aber wenn man weiß, dass FreeCAD eine Datei mit der Erweiterung .py im internen Python Editor öffnet, ist der einfachste Trick, sie in Ihrem bevorzugten Texteditor zu erstellen und sie dann mit dem üblichen Befehl Datei → Öffnen zu öffnen.

Um die Dinge in einer höflichen Art und Weise zu machen, muss die Datei mit einer gewissen Ordnung geschrieben werden, FreeCAD Python Editor haben eine gute "Syntax Hervorhebung", die in vielen einfachen Editoren wie Windows Notepad oder einige grundlegende Linux Editoren fehlt, so ist es ausreichend, diese wenigen Zeilen zu schreiben:

"""script.py

   Primo script per FreeCAD

"""


Speichere sie mit einem aussagekräftigen Namen mit der Erweiterung .py und lade die resultierende Datei in FreeCAD, mit dem besagten Datei - Öffnen Befehl.


Ein Minimalbeispiel dafür, was in einem Skript enthalten sein muss, wird in diesem Teil des Codes gezeigt, den du als Vorlage für fast jedes zukünftige Skript verwenden könntest:

"""filename.py

   Here a short but significant description of what the script do 

"""


import FreeCAD
from FreeCAD import Base, Vector
import Part
from math import pi, sin, cos

DOC = FreeCAD.activeDocument()
DOC_NAME = "Pippo"

def clear_doc():
    """
    Clear the active document deleting all the objects
    """
    for obj in DOC.Objects:
        DOC.removeObject(obj.Name)

def setview():
    """Rearrange View"""
    FreeCAD.Gui.SendMsgToActiveView("ViewFit")
    FreeCAD.Gui.activeDocument().activeView().viewAxometric()


if DOC is None:
    FreeCAD.newDocument(DOC_NAME)
    FreeCAD.setActiveDocument(DOC_NAME)
    DOC = FreeCAD.activeDocument()

else:

    clear_doc()

# EPS= tolerance to use to cut the parts
EPS = 0.10
EPS_C = EPS * -0.5

Der obige Code enthält einige Tricks:


  • import FreeCAD Diese Zeile importiert FreeCAD in den FreeCAD Python Interpreter, es mag überflüssig erscheinen, ist es aber nicht
  • von der FreeCAD Importbasis, Vektor Basis und Vektor sind in FreeCAD Skipten weit verbreitet. Wenn du sie auf diese Weise importierst, ersparst du dir den Aufruf mit FreeCAD.Vector oder FreeCAD.Base anstelle von Basis oder Vektor, dies erspart viele Tastatureingaben und macht Codezeilen viel kleiner.


Lasse uns mit einem kleinen Skript anfangen, das eine sehr kleine Arbeit leistet, aber die Kraft dieses Ansatzes zeigt.

def cubo(nome, lung, larg, alt):
    obj_b = DOC.addObject("Part::Box", nome)
    obj_b.Length = lung
    obj_b.Width = larg
    obj_b.Height = alt

    DOC.recompute()

    return obj_b

# objects definition

obj = cubo("test_cube", 5, 5, 5)

setview()

Setze diese Zeilen nach dem "Vorlage" Code und drücke den grünen Pfeil in der Makro Werkzeugleiste

Du wirst einige magische Dinge sehen, ein neues Dokument mit dem Namen "Pippo" (italienischer Name von Goofy') ist geöffnet, und du wirst in der 3D Ansicht einen Würfel sehen, wie in der Abbildung unten.

Test Cube

Etwas mehr...

Nicht allzu erstaunlich? Ja, aber irgendwo müssen wir anfangen, wir können das Gleiche mit einem Zylinder tun, diese Codezeilen nach der cubo( Methode und vor der Zeile # objects definition hinzufügen.

def base_cyl(nome, ang, rad, alt ):
    obj = DOC.addObject("Part::Cylinder", nome)
    obj.Angle = ang
    obj.Radius = rad
    obj.Height = alt
    
    DOC.recompute()

    return obj

Auch hier nichts allzu Aufregendes. Aber bitte beachte einige Besonderheiten:

  • The absence of the usual reference to the App., present in many Documentation code snippets, is deliberate, this code could be used even invoking FreeCAD as a module in an external Python interpreter, the thing is not easily doable with an AppImage, but with some care it could be done. Plus in the standard Python motto that "better explicit than implicit" App. is explaining in a very "poor" way where the things are from.
  • note the use of the "constant" name assigned to the active Document in DOC = FreeCAD.activeDocument(); active Document is not a "constant" in a strict sense, but in a "semantical" way is our "active Document", that for our use is a proper "constant" so the Python convention to use the "ALL CAPS" name for "constants", not to mention that DOC is much shorten than FreeCAD.activeDocument().
  • every method returns a geometry, this became clear in the continuation of the page.
  • geometry didn't have the Placement property, when using the simple geometries to make more complex geometry, managing Placement is a ankward thing.

Was ist nun mit diesen Geometrien zu tun?

Lasse uns boolesche Operationen einführen. Als Einstiegsbeispiel setze diese Zeilen nach base_cyl(..., dies erzeugt eine Methode für eine Verschmelzung, auch als Vereinigung Operation bekannt:

def fuse_obj(nome, obj_0, obj_1):
    obj = DOC.addObject("Part::Fuse", nome)
    obj.Base = obj_0
    obj.Tool = obj_1
    obj.Refine = True
    DOC.recompute()

    return obj

Nichts Außergewöhnliches auch hier, beachte jedoch die Einheitlichkeit in der Methodencodierung; Dieser Ansatz ist linearer als derjenige, den man in anderen Tutorien zur Skripterstellung sieht, diese "Linearität" hilft sehr bei der Lesbarkeit und auch bei Ausschneiden-Kopieren-Einfügen Operationen.

Verwenden wir die Geometrien, löschen wir Zeilen unterhalb des Codeabschnitts, die mit # objects definition beginnen, und fügen wir die folgenden Zeilen ein:

# objects definition

obj = cubo("cubo_di_prova", 5, 5, 5)

obj1 = base_cyl('primo cilindro', 360,2,10)

fuse_obj("Fusione", obj, obj1)

setview()

Starte das Skript mit dem grünen Pfeil und wir sehen in der 3D Ansicht so etwas wie:

cube and cylinder

Platzierung

Das Platzierungskonzept ist relativ komplex, siehe Aeroplane Tutorium für eine ausführlichere Erklärung.

Normalerweise ist es notwendig, dass sich die Geometrien gegenseitig respektieren. Beim Bau komplexer Objekte ist dies eine wiederkehrende Aufgabe, am häufigsten wird die Geometrie Placement Eigenschaft verwendet.

FreeCAD bietet eine große Auswahl an Möglichkeiten, diese Eigenschaft zu setzen, eine ist mehr auf eine andere zugeschnitten, abhängig vom Wissen und dem Hintergrund des Benutzers, aber je klarer das Schreiben im zitierten Tutoriumerklärt wird, verwendet es eine eigentümliche Definition des Rotation Anteils von Placement, recht einfach zu erlernen.

FreeCAD.Placement(Vector(0,0,0), FreeCAD.Rotation(10,20,30), Vector(0,0,0))

But over other consideration, one thing is crucial, geometry reference point, in other word the point from which the object is modeled by FreeCAD, as described in this table, copied from Placement:


Object Reference Point
Part.Box left (minx), front (miny), bottom (minz) vertex
Part.Sphere center of the sphere (ie centre of bounding box)
Part.Cylinder center of the bottom face
Part.Cone center of bottom face (or apex if bottom radius is 0)
Part.Torus center of the torus
Features derived from Sketches the Feature inherits the Position of the underlying Sketch. Sketches always start with Position = (0,0,0). This position corresponds to the origin in the sketch.


Diese Informationen müssen wir vor allem dann im Auge behalten, wenn wir eine Rotation anwenden müssen.

Einige Beispiele mögen helfen, lösche die gesamte Zeile nach der base_cyl Methode und füge den Teil des Codes darunter ein:

def sfera(nome, rad):
    obj = DOC.addObject("Part::Sphere", nome)
    obj.Radius = rad
    
    DOC.recompute()

    return obj   


def mfuse_obj(nome, objs):
    obj = DOC.addObject("Part::MultiFuse", nome)
    obj.Shapes = objs
    obj.Refine = True
    DOC.recompute()

    return obj


def aeroplano():

    lung_fus = 30
    diam_fus = 5
    ap_alare = lung_fus * 1.75
    larg_ali = 7.5
    spess_ali = 1.5   
    alt_imp = diam_fus * 3.0  
    pos_ali = (lung_fus*0.70)
    off_ali = (pos_ali - (larg_ali * 0.5))

    obj1 = base_cyl('primo cilindro', 360, diam_fus, lung_fus)

    obj2 = cubo('ali', ap_alare, spess_ali, larg_ali, True, off_ali)

    obj3 = sfera("naso", diam_fus)
    obj3.Placement = FreeCAD.Placement(Vector(0,0,lung_fus), FreeCAD.Rotation(0,0,0), Vector(0,0,0))

    obj4 = cubo('impennaggio', spess_ali, alt_imp, larg_ali, False, 0)
    obj4.Placement = FreeCAD.Placement(Vector(0,alt_imp * -1,0), FreeCAD.Rotation(0,0,0), Vector(0,0,0))

    objs = (obj1, obj2, obj3, obj4)

    obj = mfuse_obj("Forma esempio", objs)
    obj.Placement = FreeCAD.Placement(Vector(0,0,0), FreeCAD.Rotation(0,0,-90), Vector(0,0,pos_ali))

    DOC.recompute()

    return obj

# objects definition

aeroplano()

setview()

Lasse uns etwas im Code erklären:

  • We have used a method to define a spehere, using the most easy definition, using only the radius.
  • We have introduced a second writing for the 'Union or Fusion, using multiple objects, not more distant from the usual Part::Fuse it uses Part:Multifuse and use only one property Shapes, we have passed a tuple as arguments, but it accepts also a list.
  • We have defined a complex object aeroplano (italian word for aeroplane), but we have done it in a "parametric" way, defining some parameters and deriving other parameters, through some calculation, based on the main parameters.
  • We have used some Placement Placement poperties around in the method and before returning the final geometries we have used a Rotation property with the Yaw-Pitch-Roll, writing. Note the last Vector(0,0, pos_ali), that define a center of rotation of the whole geometry.
aeroplane example
aereo rotated
Prop Placement

It can be easily noted that aeroplano geometry rotate around his "barycenter" or "center of gravity", that I've fixed at wing center, a place that is relatively "natural", but could be placed wherever you want.

Der erste Vector(0,0,0) ist der Übersetzungsvektor, der hier nicht verwendet wird, aber wenn du aeroplano() durch diese Zeilen ersetzt:

obj_f = aeroplano()

print(obj_F.Placement)

Du wirst diesen Text im Berichtsfenster sehen:

Placement [Pos=(0,-21,21), Yaw-Pitch-Roll=(0,0,-90)]

Was ist geschehen?

FreeCAD hat die Vector(0,0,0), FreeCAD.Rotation(0,0,-90), Vector(0,0,pos_ali) mit anderen Worten unsere Placement Definition übersetzt, die drei Komponenten, Translation', Rotation und Rotationszentrum in den "internen" Werten von nur zwei Komponenten, Translation und Rotation, spezifiziert.

du kannst leicht den Wert von pos_ali mit einer print Anweisung in der aeroplano(... Methode visualisieren und sehen das es ist:

pos ali =  21.0

mit anderen Worten, das Rotationszentrum der Geometrie liegt bei Vector(0,0,21), aber dieses Rotationszentrum wird in der GUI nicht angezeigt, es könnte als Placement Wert eingegeben werden, es könnte nicht leicht abgerufen werden.

Dies ist die Bedeutung des Wortes "ankward", das ich zur Definition der Placement Eigenschaft verwendet habe.