Topological data scripting/fr

Cette page décrit différentes méthodes pour créer et modifier Part shapes de Python.

Avant de lire cette page, si vous nouveau dans la programmation Python, vous pouvez vous diriger sur cette page d'introduction à Python et scripts de base en Python pour FreeCAD.

Introduction
Nous allons ici vous expliquer comment contrôler la boîte à outils (Part Module) ou de n'importe quel script externe, directement à partir de l'interpréteur Python inclus dans FreeCAD,.

Assurez-vous de parcourir l'article de familiarisation et scripts de base si vous avez besoin de plus amples renseignements sur la façon dont les scripts Python fonctionnent dans FreeCAD.

Class Diagram
Ceci est un Unified Modeling Language (UML) de la classe la plus importante de Part Module:

Figures géométriques
Les objets géométriques sont la base de tous les objets topologiques :


 * Geom La classe de base des objets géométriques
 * Line Une ligne droite en 3D, défini par un point de départ et point d'arrivée
 * Circle Circle or circle segment défini par un point central, un point de départ et un point d'arrivée
 * ...... Et bien plus encore très rapidement

Topology
Sont aussi disponibles des données de type topologique:


 * Compound Groupe de types différents d'objets topologiques.
 * Compsolid Un groupe de solides reliés par leurs faces. C'est un concept des notions de WIRE (filaire,bord..) et SHELL (coquille,enveloppe) des solides.
 * Solid Une portion de l'espace limité par son enveloppe. Il est en 3 dimensions.
 * Shell Un groupe de faces reliés par leurs bords.Un "SHELL" peut être ouvert ou fermé.
 * Face En 2D, c'est une surface plane; en 3D, c'est une seule face du volume. Sa géométrie est coupée par des contours. Il est en deux dimensions.
 * Wire Un ensemble relié par ses VERTEX (sommets). Il peut être de contour ouvert ou fermé suivant si les sommets sont reliés ou non.
 * Edge Elément topologique correspondant à une courbe retenue. Un "Edge" est généralement limité par des sommets. Il a une dimension.
 * Vertex Elément topologiques correspondant à un point. Il n'a pas de dimension.
 * Shape Est le terme générique pour traduire tout ce qui précède.

Exemple rapide : Création topologique simple


Nous allons créer une topologie avec une géométrie toute simple.

Nous devrons veiller à ce que les sommets des pièces géométriques soient à la même position, quatre sommets, deux cercles et deux lignes.

Création de la géométrie
Nous devons d'abord créer les parties distinctes géométriques en filaire.

Nous devons veiller à ce que tous les sommets des pièces géométriques qui vont êtres raccordées soient à la même position.

Sinon, plus tard nous pourrions ne pas être en mesure de relier les pièces géométriques en une topologie!

Donc, nous créons d'abord les points:

Arc


Pour créer un arc de cercle, nous créons un point de repère puis nous créons l'arc de cercle passant par trois points:

Ligne


La ligne peut être créée très simplement en dehors des points :

Tout relier
La dernière étape consiste à relier les éléments géométriquement ensemble, et façonner une forme topologique:

Construire un prisme
Maintenant nous allons extruder notre forme filaire dans une direction, et créer une forme en 3 Dimensions:

Création de formes simples
Vous pouvez créer facilement des formes topologiques avec "make..." qui est une méthode du "Module Part": La combinaison de make... avec d'autres methodes sont disponibles:


 * makeBox(l,w,h): Construit un cube et pointe sur p dans la direction d et de dimensions (longueur,largeur,hauteur).
 * makeCircle(radius): Construit un cercle de rayon (r).
 * makeCone(radius1,radius2,height): Construit un cône de (rayon1,rayon2,hauteur).
 * makeCylinder(radius,height): Construit un cylindre de (rayon,hauteur).
 * makeLine((x1,y1,z1),(x2,y2,z2)): Construit une ligne aux coordonnées (x1,y1,z1),(x2,y2,z2) dans l'espace 3D.
 * makePlane(length,width): Construit un rectangle de (longueur,largeur).
 * makePolygon(list): Construit un polygone (liste de points).
 * makeSphere(radius): Construit une sphère de (rayon).
 * makeTorus(radius1,radius2): Construit un tore de (rayon1,rayon2).

La liste complète des API du module est sur la page Part API.

Importer les modules nécessaires
Nous avons d'abord besoin d'importer le module Part afin que nous puissions utiliser son contenu Python.

Nous allons également importer le module Base à l'intérieur du module de FreeCAD:

Création d'un Vecteur
Les Vecteurs sont l'une des informations les plus importantes lors de la construction des formes géométriques.

Ils contiennent habituellement 3 nombres (mais pas toujours) les coordonnées cartésiennes x, y et z.

Vous pouvez créez un vecteur comme ceci: Nous venons de créer un vecteur de coordonnées x = 3, y = 2, z = 0.

Dans le module Part, les vecteurs sont utilisés partout.

Le module Part utilise aussi une autre façon de représenter un point, appelé Vertex, qui n'est actuellement rien d'autre qu'un conteneur pour un vecteur.

Vous pouvez accéder aux vecteurs d'un sommet comme ceci:

Création d'une arête (edge)
Une arête (bord) n'est rien d'autre qu'une ligne avec deux Vertex (sommets): PS: Vous pouvez aussi créer un arête en donnant deux Vecteurs: Vous pouvez trouver la longueur et le centre d'une arête comme ceci:

Mise en forme à l'écran
Jusqu'à présent, nous avons créé un objet a arêtes vives (bords), mais il n'est pas visible à l'écran.

C'est parce que nous n'avons manipulé que des objets en Python.

L'écran FreeCAD n'affiche uniquement que les vues 3D que vous lui demandez d'afficher.

Pour cela, nous utilisons une méthode simple: Un Objet 3D sera affiché dans notre document FreeCAD, et notre dessin sera affiché sous forme filaire.

Utilisez cette commande chaque fois que vous voudrez afficher votre forme géométrique à l'écran.

Création d'un contour (Wire)
Un contour est une ligne multi-arêtes, et peut être créé dans une liste d'arêtes ou même une liste de lignes (fils): Part.show (wire3) permet d'afficher les 4 bords qui composent notre contour filaire.

D'autres informations utiles, peuvent être facilement récupérées:

Création d'une face
Seul les faces à contour fermés seront valides.

Dans cet exemple, wire3 est un contour fermé, et Wire2 est un contour ouvert (voir ci-dessus) Seul les faces auront une superficie, mais les lignes et les bords (arêtes) n'en possède pas.

Création d'un cercle
Un cercle est créé simplement comme ceci: Si vous voulez le créer à une coordonnée précise, faites comme ceci: ccircle sera créé à une distance de 10 à partir de l'axe d'origine x et sera orienté dans la direction de l'axe x.

Remarque: makeCircle accepte uniquement Base.Vector pour la position mais pas les tuples normaux.

Vous pouvez également créer un arc de cercle en donnant l'angle de départ et l'angle de la fin comme suit: Si nous joignions les deux arcs arc1 et arc2 nous obtiendrons un cercle.

L'angle fourni doit être exprimé en degrés, s'il sont en radians, vous devez les convertir en degrès avec la formule: degrés = radians * 180/PI ou en utilisant le module mathématiques Python (après avoir fait import math, bien sûr):

Création d'un arc sur des points (repères)
Malheureusement, il n'existe pas de fonction makeArc mais nous avons la fonction Part.Arc pour créer un arc sur trois points de référence.

Fondamentalement, nous pouvons supposer un arc attaché sur un point de départ, passant sur un point central et se termine sur un point final en.

Part.Arc crée un objet arc pour lequel .ToShape doit être appelée pour obtenir un objet ligne (edge), de cette manière nous utiliserons Part.Line lieu de Part.makeLine. Arc travaille uniquement avec Base.Vector pour les points mais pas pour les tuples.

arc_edge est ce qui sera affiché à l'aide Part.show (arc_edge).

Vous pouvez également obtenir un arc de cercle en utilisant une partie de cercle: Arcs are valid edges, like lines. So they can be used in wires too.

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

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

Creating a Plane
A Plane is simply a flat rectangular surface. The method used to create one is this: makePlane(length,width,[start_pnt,dir_normal]). 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 z axis, while dir_normal = Vector(1,0,0) will create the plane facing x axis: BoundBox is a cuboid enclosing the plane with a diagonal starting at (3,0,0) and ending at (5,0,2). Here the BoundBox thickness in y axis is zero, since our shape is totally flat.

Note: makePlane only accepts Base.Vector for start_pnt and dir_normal but not tuples

Creating an ellipse
To create an ellipse there are several ways: Creates an ellipse with major radius 2 and minor radius 1 with the center in (0,0,0) Create a copy of the given ellipse Creates an ellipse centered on the point Center, where the plane of the ellipse is defined by Center, S1 and S2, its major axis is defined by Center and S1, its major radius is the distance between Center and S1, and its minor radius is the distance between S2 and the major axis. Creates an ellipse with major and minor radii MajorRadius and MinorRadius, and located in the plane defined by Center and the normal (0,0,1) In the above code we have passed S1, S2 and center. Similarly to Arc, Ellipse also creates an ellipse object but not edge, so we need to convert it into edge using toShape to display.

Note: Arc only accepts Base.Vector for points but not tuples for the above Ellipse constructor we have passed center, MajorRadius and MinorRadius

Creating a Torus
Using the method makeTorus(radius1,radius2,[pnt,dir,angle1,angle2,angle]). 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 big cirlce, radius2 is the radius of small circle, pnt is the center of torus and dir is the normal direction. angle1 and angle2 are angles in radians for the small circle, the last parameter angle is to make a section of the torus: The above code will create a torus with diameter 20(radius 10) and thickness 4 (small cirlce 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 angle and remaining angles are defaults. Giving the angle 180 will create the torus from 0 to 180, that is, a half torus.

Creating a box or cuboid
Using makeBox(length,width,height,[pnt,dir]). By default pnt=Vector(0,0,0) and dir=Vector(0,0,1)

Creating a Sphere
Using makeSphere(radius,[pnt, dir, angle1,angle2,angle3]). 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 itself.

Creating a Cylinder
Using makeCylinder(radius,height,[pnt,dir,angle]). By default pnt=Vector(0,0,0),dir=Vector(0,0,1) and angle=360

Creating a Cone
Using makeCone(radius1,radius2,height,[pnt,dir,angle]). By default pnt=Vector(0,0,0), dir=Vector(0,0,1) and angle=360

Modifying shapes
There are several ways to modify shapes. Some are simple transformation operations such as moving or rotating shapes, other are more complex, such as unioning and subtracting one shape from another. Be aware that

Translating 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.

Rotating 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.

Generic transformations with matrixes
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 3 numbers, so those 2 lines do the same thing: When our matrix is set, we can apply it to our shape. FreeCAD provides 2 methods to do that: transformShape and transformGeometry. The difference is that with the first one, you are sure that no deformations will occur (see "scaling a shape" below). So we can apply our transformation like this: or

Scaling 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 differenty. For scaling, we can't use the transformShape, we must use transformGeometry:

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

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

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

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

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:

Exploring 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 makeBox 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 vertexes. Straight edges have only two vertexes, obviously.

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.

Using the selection
Here we see now how we can use the selection the user did in the viewer. First of all we create a box and shows it in the viewer Select now some faces or edges. With this script you can iterate all selected objects and their sub elements: Select some edges and this script will calculate the length:

Complete example: The OCC bottle
A typical example found on the OpenCasCade Getting Started Page is how to build a bottle. This is a good exercise for FreeCAD too. In fact, you can follow our example below and the OCC page simultaneously, you will understand well how OCC structures are implemented in FreeCAD. The complete script below is also included in FreeCAD installation (inside the Mod/Part folder) and can be called from the python interpreter by typing:

The complete script
Here is the complete MakeBottle script:

Detailed explanation
We will need,of course, the Part module, but also the FreeCAD.Base module, which contains basic FreeCAD structures like vectors and matrixes. Here we define our makeBottle 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 actually define the geometry: an arc, made of 3 points, and two line segments, made of 2 points. Remember the difference between geometry and shapes? Here we build shapes out of our construction geometry. 3 edges (edges can be straight or curved), then a wire made of those three edges. Until now we built only a half profile. Easier than building the whole profile the same way, we can just mirror what we did, and glue both halfs together. So 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 suffer (move, rotate and scale). Here, after we create the matrix, we mirror it, and we create a copy of our wire with that transformation matrix applied 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. Doing so, we actually made a solid. Then we apply a nice little fillet to our object because we care about good design, don't we? Then, the body of our bottle is made, we still need to create a neck. So we make a new solid, with a cylinder. The fuse operation, which in other apps is sometimes called union, 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. That Part solid, like any other Part shape, can be attributed to an object in a FreeCAD document, with: or, more simple:

Box pierced
Here a complete example of building a box pierced.

The construction is done side by side and when the cube is finished, it is hollowed out of a cylinder through.

Loading and Saving
There are several ways to save your work in the Part module. 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 exportBrep, exportIges, exportStl and exportStep methods availables for all shape objects. So, doing: this will save our box into a STEP file. To load a BREP, IGES or STEP file, simply do the contrary: To convert an .stp in .igs file simply : Note that importing or opening BREP, IGES or STEP files can also be done directly from the File -> Open or File -> Import menu, while exporting is with File -> Export