Topological data scripting/de

Hier erklären wir Dir, wie Du das Part Module/de direkt aus dem FreeCAD Python Interpreter oder von einem externen Skript aus steuern kannst. Die Grundlagen des Topologischen Datenskripts sind unter Part Arbeitsbereich Erläuterung des Konzepts beschrieben. Achte darauf, den Abschnitt Scripting/de und die Seiten FreeCAD Scripting Basics/de zu durchsuchen, wenn Du weitere Informationen darüber benötigst, wie Python Skripten in FreeCAD funktioniert.

Here we will explain to you how to control the Part Module directly from the FreeCAD Python interpreter, or from any external script. The basics about Topological data scripting are described in Part Module Explaining the concepts. Be sure to browse the Scripting section and the FreeCAD_Scripting_Basics pages if you need more information about how Python scripting works in FreeCAD. If you are new to Python, it is a good idea to first read the Introduction to Python.

Klassen Diagramm
Dies ist ein Unified Modeling Language (UML) Überblick über die wesentlichen Klassen des Part Arbweitsbereichs:

This is a Unified Modeling Language (UML) overview of the most important classes of the Part module:

top

Geometrie
Die geometrischen Objekte sind die Bausteine aller topologischen Objekte:
 * Geom Basisklasse der geometrischen Objekte
 * Line Eine gerade Linie im Raum, definiert durch den Start- und Endpunkt
 * Circle Kreis oder Kreissegment definiert durch einen Mittelpunkt und einen Start- und Endpunkt
 * ...... Und demnächst mehr davon

The geometric objects are the building blocks of all topological objects:
 * Geom Base class of the geometric objects.
 * Line A straight line in 3D, defined by starting point and end point.
 * Circle Circle or circle segment defined by a center point and start and end point.
 * ...... Etc.

top

Topologie
The folgenden topologischen Datentypen stehen zur Verfügung:
 * Compound Eine Gruppe von beliebigen topologischen Objekten.
 * Compsolid Ein zusammengesetzter Körper (solid) ist ein Set von Körpern, die durch ihre Seiten verbunden sind. Dies erweitert das Konzept von WIRE and SHELL auf Körpern (solids).
 * Solid Ein Teil des Raumes, der durch eine geschlossene dreidimensionale Hülle begrenzt ist.
 * Shell Hülle = Ein Satz von über ihre Kanten verbundenen Flächen. Eine Hülle kann offen oder geschlossen sein.
 * Face Im zweidimensionalen ist es ein Teil einer Ebene; im dreidimensionalen ist es ein Teil einer Oberfläche. Die Form ist durch Konturen begrenzt (getrimmt). Auch im 3D gekrümmte Flächen haben sind Inneren zweidimensional parametriert.
 * Wire Ein Satz von über ihre Endpunkten verknüpften Kanten. Ein "Wire" kann eine offene oder geschlossene Form haben, je nach dem ob nicht verknüpfte Endpunkte vorhanden sind oder nicht.
 * Edge Ein topologisches Element (Kante) das mit einer beschränkten Kurve korrespondiert. Eine Kante ist generell durch Vertexe begrenzt. Eine Kante ist eindimensional.
 * Vertex Ein topologisches Element das mit einem Punkt korrespondiert. Es ist nulldimensional.
 * Shape Ein generischer Term für all die zuvor aufgezählten Elemente.

The following topological data types are available:
 * Compound A group of any type of topological objects.
 * Compsolid A composite solid is a set of solids connected by their faces. It expands the notions of WIRE and SHELL to solids.
 * Solid A part of space limited by shells. It is three dimensional.
 * Shell A set of faces connected by their edges. A shell can be open or closed.
 * Face In 2D it is part of a plane; in 3D it is part of a surface. Its geometry is constrained (trimmed) by contours. It is two dimensional.
 * Wire A set of edges connected by their vertices. It can be an open or closed contour depending on whether the edges are linked or not.
 * Edge A topological element corresponding to a restrained curve. An edge is generally limited by vertices. It has one dimension.
 * Vertex A topological element corresponding to a point. It has zero dimension.
 * Shape A generic term covering all of the above.

top

Kurzes Beispiel: Erstellung einer einfachen Topologie


Wir werden nun eine Topologie erstellen, indem wir sie aus einer einfacheren Geometrie konstruieren. Als Fallstudie verwenden wir ein Teil, wie im Bild zu sehen, das aus vier Knoten, zwei Kreise und zwei Linien besteht.

top

Erstellen der Geometrie
Zuerst müssen wir die verschiedenen geometrischen Teile dieses Drahtes erstellen. Und wir müssen darauf achten, dass die Scheitelpunkte der geometrischen Teile an der gleichen Stelle sind. Sonst wären wir später vielleicht nicht mehr in der Lage, die geometrischen Teile zu einer Topologie zu verbinden!

First we create the distinct geometric parts of this wire. Making sure that parts that have to be connected later share the same vertices.

Also erstellen wir zuerst die Punkte:

top

Bogen


Um einen Kreisbogen zu erzeugen, machen wir einen Hilfspunkt und erzeugen den Kreisbogen durch drei Punkte:

top

Linie


Das Liniensegment kann sehr einfach aus den Punkten erstellt werden:

top

Alles zusammensetzen
Der letzte Schritt besteht darin, die geometrischen Basiselemente zusammenzusetzen und eine topologische Form backen:

The last step is to put the geometric base elements together and bake a topological shape:

top

Ein Prisma herstellen
Extrudiere nun den Draht in eine Richtung und erstelle eine echte 3D Form:

Now extrude the wire in a direction and make an actual 3D shape:

top

Alles anzeigen
top

Erstellen von Grundformen
Du kannst ganz einfach topologische Grundobjekte mit den "make...." Methoden aus dem Arbeitsbereich Part erstellen:

You can easily create basic topological objects with the methods from the Part Module:

Andere verfügbare make.... Methoden: Siehe die Part API Seite für eine vollständige Liste der verfügbaren Methoden des Part Arbeitsbereichs.
 * makeBox(l,w,h): Erstellt einen Quader, der sich in p befindet und in die Richtung d mit den Abmessungen (l,w,h) zeigt.
 * makeCircle(radius): Erstellt einen Kreis mit einem gegebenen Radius.
 * makeCone(radius1,radius2,height): Erstellt einen Kegel mit den gegebenen Radien und Höhen.
 * makeCylinder(radius,height): Erstellt einen Zylinder mit einem gegebenen Radius und Höhe.
 * makeLine((x1,y1,z1),(x2,y2,z2))): Erstellt eine Linie aus zwei Punkten.
 * makePlane(length,width): Erstellt eine Ebene mit Länge und Breite.
 * makePolygon(list): Erstellt ein Polygon aus einer Liste von Punkten.
 * makeSphere(radius): Erstellt eine Kugel mit einem bestimmten Radius.
 * makeTorus(radius1,radius2): Erstellt einen Torus mit den gegebenen Radien.

top

Import der notwendigen Module
Zuerst müssen wir den Part Arbeitsbereich importieren, damit wir seinen Inhalt in Python verwenden können. Wir werden auch das Basismodul aus dem FreeCAD Modul importieren:

First we need to import the Part module so we can use its contents in Python. We'll also import the Base module from inside the FreeCAD module:

top

Erstellen eines Vektors
Vektoren sind einer der am häufigsten verwendeten wichtigen Informationsteile beim Bau von Formen. Sie enthalten in der Regel drei Zahlen (aber nicht notwendigerweise immer): die kartesischen Koordinaten x, y und z. Du erstelltst einen Vektor wie diesen:

Vectors are one of the most important pieces of information when building shapes. They usually contain three numbers (but not necessarily always): the X, Y and Z cartesian coordinates. You create a vector like this:

Wir haben gerade einen Vektor mit den Koordinaten x=3, y=2, z=0 erstellt. Im Part Arbeitsbereich, werden Vektoren überall verwendet. Teileformen verwenden auch eine andere Art von Punkt Darstellung namens Vertex, die lediglich ein Behälter für einen Vektor ist. Du greifst auf den Vektor eines Knoten wie folgt zu:

top

Erstellen einer Kante
Eine Kante ist nichts anderes als eine Linie mit zwei Knoten:

An edge is nothing but a line with two vertices:

Hinweis: Du kannst auch eine Kante erzeugen, indem du zwei Vektoren übergibst:

Du kannst die Länge und den Mittelpunkt einer Kante wie diese finden:

top

Die Form auf den Bildschirm bringen
Bisher haben wir ein Kantenobjekt erstellt, das aber nirgendwo auf dem Bildschirm erscheint. Das liegt daran, dass die FreeCAD 3D Szene nur das anzeigt, was du ihm sagst, dass er anzeigen soll. Um das zu tun, verwenden wir folgende einfache Methode:

So far we created an edge object, but it doesn't appear anywhere on the screen. This is because the FreeCAD 3D scene only displays what you tell it to display. To do that, we use this simple method:

Die Anzeigefunktion erzeugt ein Objekt in unserem FreeCAD Dokument und weist unsere "Kantenform" ihm zu. Verwende dies, wenn es an der Zeit ist, deine Erstellung auf dem Bildschirm anzuzeigen.

top

Erstellen eines Drahts
Ein Draht ist eine Mehrkantenlinie und kann aus einer Liste von Kanten oder sogar einer Liste von Drähten erstellt werden:

A wire is a multi-edge line and can be created from a list of edges or even a list of wires:

Part.show(Draht3) zeigt die 4 Kanten, die unseren Draht bilden. Sonstige nützliche Informationen können leicht abgerufen werden:

top

Erstellen einer Fläche
Nur Flächen, die aus geschlossenen Drähten erstellt wurden, sind gültig. In diesem Beispiel ist Draht3 ein geschlossener Draht, aber Draht2 ist kein geschlossener Draht (siehe oben).

Only faces created from closed wires will be valid. In this example, wire3 is a closed wire but wire2 is not (see above):

Nur Flächen haben eine Grundfläche, keine Drähte oder Kanten.

top

Erstellen eines Kreises
So einfach kann ein Kreis erstellt werden:

A circle can be created like this:

Wenn Du ihn an einer bestimmten Stelle und mit einer bestimmten Richtung erzeugen möchtest:

Der Kreis wird im Abstand 10 vom x Ursprung erstellt und ist nach außen entlang der x Achse gerichtet. Hinweis: erzeugeKreis akzeptiert nur Base.Vector für die Position und normale Parameter, nicht Tupel. Du kannst auch einen Teil des Kreises durch Angabe eines Anfangs- und eines Endwinkels erstellen:

Sowohl arc1 als auch arc2 bilden gemeinsam einen Kreis. Winkel sollten angegeben werden in Grad; wenn Du Bogenmaß hast, wandelst Du sie einfach mit der Formel um: Grad = Bogenmaß * 180/PI oder mit dem Mathematikmodul von python (nach dem ausführen von import math, natürlich):

top

Erstellen eines Bogens entlang von Punkten
Leider gibt es keine makeArc-Funktion, aber wir haben die Part.Arc Funktion um einen Bogen durch drei Punkte zu erzeugen. Es erzeugt ein Bogenobjekt das den Startpunktes mit dem Endpunkt durch den Mittelpunkt verbindet. Die .toShape Funktion des Bogenobjekts muss aufgerufen werden, um ein Kantenobjekt zu erhalten, wie bei der Verwendung von Part.LineSegment anstelle von Part.makeLine.

Unfortunately there is no function, but we have the  function to create an arc through three points. It creates an arc object joining the start point to the end point through the middle point. The arc object's function must be called to get an edge object, the same as when using instead of.

Arc akzeptiert nur Base.Vector für Punkte, aber nicht für Tupel. arc_edge ist das, was wir wollen, was wir durch Verwendung von Part.show(arc_edge) anzeigen können. Du kannst einen Bogen auch unter Verwendung eines Kreisabschnitts erhalten:

Bögen sind gültige Kanten wie Linien, so dass sie auch in Drähten verwendet werden können.

top

Erstellen eines Polygons
Ein Polygon ist einfach ein Draht mit mehreren geraden Kanten. Die makePolygon Funktion nimmt eine Liste von Punkten und erstellt einen Draht durch diese Punkte:

A polygon is simply a wire with multiple straight edges. The function takes a list of points and creates a wire through those points:

top

Erstellen einer Bézier Kurve
Bézier Kurven werden verwendet, um sanfte Kurven mit einer Reihe von Polen (Punkten) und optionalen Gewichten zu modellieren. Die folgende Funktion erstellt eine Part.BezierCurve aus einer Reihe von FreeCAD.Vector Punkten. (Hinweis: Wenn du einen einzelnen Pol oder ein Gewicht "erhältst" und "einstellst", beginnen die Indizes bei 1, nicht bei 0.)

Bézier curves are used to model smooth curves using a series of poles (points) and optional weights. The function below makes a from a series of  points. Note: when "getting" and "setting" a single pole or weight, indices start at 1, not 0.

top

Erstellen einer Ebene
Eine Ebene ist einfach eine flache rechteckige Fläche. Die Methode, mit der eine solche erstellt wird, ist makePlane(length,width,[start_pnt,dir_normal])'. Standardmäßig start_pnt = Vektor(0,0,0,0) und dir_normal = Vektor(0,0,1). Verwendung von dir_normal = Vector(0,0,0,1) erzeugt die Ebene, die in Richtung der positiven z-Achse zeigt, während dir_normal = Vector(1,0,0,0) die Ebene erzeugt. Ebene, die in Richtung der positiven x-Achse zeigt:

A Plane is a flat rectangular surface. The method used to create one is. By default start_pnt = Vector(0, 0, 0) and dir_normal = Vector(0, 0, 1). Using dir_normal = Vector(0, 0, 1) will create the plane facing in the positive Z axis direction, while dir_normal = Vector(1, 0, 0) will create the plane facing in the positive X axis direction:

BoundBox ist ein Quader, der die Ebene mit einer Diagonale beginnend bei (3,0,0,0) und endet bei (5,0,2) einschliesst. Hier ist die BoundBox Dicke entlang der y-Achse Null, zumal unsere Form völlig flach ist.

Hinweis: makePlane akzeptiert nur Base.Vector für start_pnt und dir_normal, nicht aber Tupel.

top

Erstellen einer Ellipse
Es gibt mehrere Möglichkeiten, eine Ellipse zu erstellen:

There are several ways to create an ellipse:

Erzeugt eine Ellipse mit Hauptradius 2 und Nebenradius 1 mit dem Mittelpunkt bei (0,0,0).

Erstellt eine Kopie der angegebenen Ellipse.

Erzeugt eine Ellipse, die auf den Punkt Mitte zentriert ist, an dem die Ebene der Ellipse definiert ist durch Mittelpunkt, S1 und S2, ihre Hauptachse definiert ist durch Mittelpunkt und S1, sein Hauptradius ist der Abstand zwischen Mittelpunkt und S1, und sein kleiner Radius ist der Abstand zwischen S2 und der Hauptachse.

Erstellt eine Ellipse mit Haupt- und Nebenradien Hauptradius und Nebenradius, die sich in der durch den Mittelpunkt definierten Ebene und der Normalen (0,0,1) befinden.

Im obigen Code haben wir S1, S2 und Mitte überschritten. Ähnlich wie Arc, erzeugt Ellipse ein Ellipsenobjekt, aber keine Kante, also müssen wir es in eine Kante mit toShape zur Anzeige konvertieren.

Hinweis: Arc akzeptiert nur Base.Vector für Punkte, nicht aber für Tupel.

für den obigen Ellipsenkonstruktor haben wir Mitte, MajorRadius und MinorRadius überschritten.

top

Create a torus
Using. By default pnt = Vector(0, 0, 0), dir = Vector(0, 0, 1), angle1 = 0, angle2 = 360 and angle = 360. Consider a torus as small circle sweeping along a big circle. Radius1 is the radius of the big circle, radius2 is the radius of the small circle, pnt is the center of the torus and dir is the normal direction. angle1 and angle2 are angles in degrees for the small circle; the last angle parameter is to make a section of the torus:

The above code will create a torus with diameter 20 (radius 10) and thickness 4 (small circle radius 2)

The above code will create a slice of the torus.

The above code will create a semi torus; only the last parameter is changed. i.e the remaining angles are defaults. Giving the angle 180 will create the torus from 0 to 180, that is, a half torus.

top

Create a box or cuboid
Using. By default pnt = Vector(0, 0, 0) and dir = Vector(0, 0, 1).

top

Create a sphere
Using. By default pnt = Vector(0, 0, 0), dir = Vector(0, 0, 1), angle1 = -90, angle2 = 90 and angle3 = 360. Angle1 and angle2 are the vertical minimum and maximum of the sphere, angle3 is the sphere diameter.

top

Create a cylinder
Using. By default pnt = Vector(0, 0, 0), dir = Vector(0, 0, 1) and angle = 360.

top

Create a cone
Using. By default pnt = Vector(0, 0, 0), dir = Vector(0, 0, 1) and angle = 360.

top

Modify shapes
There are several ways to modify shapes. Some are simple transformation operations such as moving or rotating shapes, others are more complex, such as unioning and subtracting one shape from another.

top

Translate a shape
Translating is the act of moving a shape from one place to another. Any shape (edge, face, cube, etc...) can be translated the same way:

This will move our shape "myShape" 2 units in the X direction.

top

Rotate a shape
To rotate a shape, you need to specify the rotation center, the axis, and the rotation angle:

The above code will rotate the shape 180 degrees around the Z Axis.

top

Matrix transformations
A matrix is a very convenient way to store transformations in the 3D world. In a single matrix, you can set translation, rotation and scaling values to be applied to an object. For example:

Note: FreeCAD matrixes work in radians. Also, almost all matrix operations that take a vector can also take three numbers, so these two lines do the same thing:

Once our matrix is set, we can apply it to our shape. FreeCAD provides two methods for doing that: and. The difference is that with the first one, you are sure that no deformations will occur (see Scaling a shape below). We can apply our transformation like this:

or

top

Scale a shape
Scaling a shape is a more dangerous operation because, unlike translation or rotation, scaling non-uniformly (with different values for X, Y and Z) can modify the structure of the shape. For example, scaling a circle with a higher value horizontally than vertically will transform it into an ellipse, which behaves mathematically very differently. For scaling, we cannot use the, we must use :

top

Subtraction
Subtracting a shape from another one is called "cut" in FreeCAD and is done like this:

top

Intersection
The same way, the intersection between two shapes is called "common" and is done this way:

top

Union
Union is called "fuse" and works the same way:

top

Section
A "section" is the intersection between a solid shape and a plane shape. It will return an intersection curve, a compound curve composed of edges.

top

Extrusion
Extrusion is the act of "pushing" a flat shape in a certain direction, resulting in a solid body. Think of a circle becoming a tube by "pushing it out":

If your circle is hollow, you will obtain a hollow tube. If your circle is actually a disc with a filled face, you will obtain a solid cylinder:

top

Explore shapes
You can easily explore the topological data structure:

By typing the lines above in the Python interpreter, you will gain a good understanding of the structure of Part objects. Here, our command created a solid shape. This solid, like all Part solids, contains faces. Faces always contain wires, which are lists of edges that border the face. Each face has at least one closed wire (it can have more if the face has a hole). In the wire, we can look at each edge separately, and inside each edge, we can see the vertices. Straight edges have only two vertices, obviously.

top

Edge analysis
In case of an edge, which is an arbitrary curve, it's most likely you want to do a discretization. In FreeCAD the edges are parametrized by their lengths. That means you can walk an edge/curve by its length:

Now you can access a lot of properties of the edge by using the length as a position. That means if the edge is 100mm long the start position is 0 and the end position 100.

top

Use a selection
Here we see now how we can use a selection the user did in the viewer. First of all we create a box and show it in the viewer.

Now select some faces or edges. With this script you can iterate over all selected objects and their sub elements:

Select some edges and this script will calculate the length:

top

Example: The OCC bottle
A typical example found on the OpenCasCade Technology website is how to build a bottle. This is a good exercise for FreeCAD too. In fact, if you follow our example below and the OCC page simultaneously, you will see how well OCC structures are implemented in FreeCAD. The script is included in the FreeCAD installation (inside the folder) and can be called from the Python interpreter by typing:

top

The script
For the purpose of this tutorial we will consider a reduced version of the script. In this version the bottle will not be hollowed out, and the neck of the bottle will not be threaded.

top

Detailed explanation
We will need, of course, the module, but also the  module, which contains basic FreeCAD structures like vectors and matrices.

Here we define our function. This function can be called without arguments, like we did above, in which case default values for width, height, and thickness will be used. Then, we define a couple of points that will be used for building our base profile.

Here we define the geometry: an arc, made of three points, and two line segments, made of two points.

Remember the difference between geometry and shapes? Here we build shapes out of our construction geometry. Three edges (edges can be straight or curved), then a wire made of those three edges.

So far we have built only a half profile. Instead of building the whole profile the same way, we can just mirror what we did and glue both halves together. We first create a matrix. A matrix is a very common way to apply transformations to objects in the 3D world, since it can contain in one structure all basic transformations that 3D objects can undergo (move, rotate and scale). After we create the matrix we mirror it, then we create a copy of our wire and apply the transformation matrix to it. We now have two wires, and we can make a third wire out of them, since wires are actually lists of edges.

Now that we have a closed wire, it can be turned into a face. Once we have a face, we can extrude it. In doing so, we make a solid. Then we apply a nice little fillet to our object because we care about good design, don't we?

At this point, the body of our bottle is made, but we still need to create a neck. So we make a new solid, with a cylinder.

The fuse operation is very powerful. It will take care of gluing what needs to be glued and remove parts that need to be removed.

Then, we return our Part solid as the result of our function.

Finally, we call the function to actually create the part, then make it visible.

top

Example: Pierced box
Here is a complete example of building a pierced box.

The construction is done one side at a time. When the cube is finished, it is hollowed out by cutting a cylinder through it.

top

Loading and saving
There are several ways to save your work. You can of course save your FreeCAD document, but you can also save Part objects directly to common CAD formats, such as BREP, IGS, STEP and STL.

Saving a shape to a file is easy. There are, , and  methods available for all shape objects. So, doing:

will save our box into a STEP file. To load a BREP, IGES or STEP file:

To convert a STEP file to an IGS file:

top