Topological data scripting/fr

Introduction
Ici, nous vous expliquerons comment contrôler le Module Part directement à partir de l'interpréteur FreeCAD Python, ou à partir de n'importe quel script externe. Les principes de base des scripts de données topologiques sont décrits dans le Module Part expliquant les concepts. Assurez-vous de parcourir la section Script et les pages les bases si vous avez besoin de plus d'informations sur le fonctionnement des scripts Python dans FreeCAD. Si vous êtes nouveau sur Python, c'est une bonne idée de lire d'abord l'Introduction à Python.

Diagramme de classe
Voici un aperçu du Langage de Modélisation Unifié (UML) de la classe la plus importante du module Part :

En haut

Géométrie
Les objets géométriques sont les éléments constitutifs de tous les objets topologiques :
 * Geom Classe de base des objets géométriques.
 * Ligne Une ligne droite en 3D, définie par le point de départ et le point d'arrivée.
 * Cercle Cercle ou arc de cercle, défini par un centre, un point de départ et d'arrivée.
 * ...... Etc.

En haut

Topologie
Les types de données topologiques suivants sont disponibles :
 * Composé Un groupe de tout type d'objets topologiques.
 * Compsolid Un solide composite est un ensemble de solides reliés par leurs faces. Il étend les notions de FORME FILAIRE et de COQUE aux solides.
 * Solide Une partie de l'espace limité par des coques. C'est en trois dimensions.
 * Coque Un ensemble de faces reliées par leurs arrêtes. Une coque peut être ouverte ou fermée.
 * Face En 2D, elle fait partie d'un plan ; en 3D elle fait partie d'une surface. Sa géométrie est contrainte (rognée) par des contours. C'est bidimensionnel.
 * Forme filaire Un ensemble d'arêtes reliées par leurs sommets. Il peut s'agir d'un contour ouvert ou fermé selon que les bords sont liés ou non.
 * Arête Un élément topologique correspondant à une courbe restreinte. Une arête est généralement limitée par des sommets. Elle a une dimension.
 * Sommet Un élément topologique correspondant à un point. Il a une dimension nulle.
 * Forme Terme générique couvrant tout ce qui précède.

En haut

Exemple rapide : Création topologique simple


Nous allons maintenant créer une topologie, en la construisant à partir d'une géométrie plus simple. Comme étude de cas, nous utiliserons une ensemble comme illustré ci-dessus, qui se compose de quatre sommets, deux arcs et deux lignes.

En haut

Création de la géométrie
Nous créons d'abord les parties géométriques distinctes de ce fil. S'assurer que les éléments qui doivent être connectées ultérieurement partagent les mêmes sommets.

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

En haut

Arc


Pour chaque arc, nous avons besoin d'un point de repère :

En haut

Ligne


Les segments de ligne peuvent être créés à partir de deux points :

En haut

Relier le tout
La dernière étape consiste à assembler les éléments géométriques de base et façonner une forme topologique :

En haut

Construire un prisme
Maintenant, extrudez la forme filaire dans une direction et créez une forme 3D véritable :

En haut

Affichons le tout
En haut

Création de formes basiques
Vous pouvez facilement créer des objets topologiques de base avec les méthodes du module Part (atelier pièce) :

Quelques méthodes disponibles : Voir la page de l'API Part pour une liste complète des méthodes disponibles du module Part.
 * Crée une boîte située en p et pointant dans la direction d avec les dimensions longueur, largeur et hauteur.
 * Dessine un cercle avec un rayon donné.
 * Crée un cône avec rayons1, rayon2 et hauteur donnés.
 * Crée un cylindre avec un rayon et une hauteur donnés.
 * Trace un segment à partir de deux points.
 * Crée un plan avec la longueur et la largeur.
 * Crée un polygone à partir d'une liste de points.
 * Crée une sphère avec un rayon donné.
 * Crée un tore avec les rayons donnés.

En haut

Importer les modules nécessaires
Nous devons d'abord importer le module Part, pour pouvoir utiliser son contenu en Python. Nous importerons également le module Base depuis l'intérieur du module FreeCAD :

En haut

Création d'un Vecteur
Les Vecteurs constituent l'une des informations les plus importantes, lors de la construction des formes géométriques. Ils contiennent généralement trois nombres (mais pas systématiquement) : les coordonnées cartésiennes X, Y et Z. Vous créer un vecteur comme ceci :

Nous venons de créer un vecteur aux coordonnées X=3, Y=2, Z=0. Dans le module Part, les vecteurs sont utilisés partout. Part shape utilise également un autre type de représentation ponctuelle appelée sommet, qui est simplement un conteneur pour un vecteur. Vous accédez au vecteur d'un sommet comme ceci :

En haut

Création d'une arête
Une arête n'est rien d'autre qu'un segment avec deux sommets :

Remarque : Vous pouvez également créer une arête en passant deux vecteurs :

Vous pouvez trouver la longueur et le centre d'une arête comme ceci :

En haut

Mise en forme à l'écran
Jusqu'à présent, nous avons créé un objet filaire, mais il n'apparaît nulle part à l'écran. En effet, la scène FreeCAD 3D affiche uniquement ce que vous lui demandez d'afficher. Pour ce faire, nous utilisons cette simple méthode :

La fonction show crée un objet dans notre document FreeCAD et lui assigne notre forme "filaire". Utilisez-la chaque fois qu'il est temps d'afficher votre création à l'écran.

En haut

Création d'un contour (ou forme filaire)
Un contour est une ligne brisée, à arêtes multiples et peut être créé à partir d'une liste d'arêtes ou même une liste de contours (ou de formes filaires) :

affichera les 4 bords qui composent notre forme filaire. D'autres informations utiles peuvent être facilement récupérées :

En haut

Création d'une face
Seules les faces créées à partir de formes filaires fermées seront valides. Dans cet exemple, wire3 est un contour fermé, mais wire2 ne l'est pas (voir ci-dessus) :

Seules les faces auront une superficie, mais pas les contours et les arêtes.

En haut

Création d'un cercle
Un cercle peut être créé comme ceci :

Si vous voulez le créer à une certaine position et avec une certaine direction :

ccircle sera créé à une distance de 10 de l'origine X et sera orienté vers l'extérieur le long de l'axe X. Remarque : accepte uniquement  pour la position et les paramètres habituels et pas les tuples (n-uplet). Vous pouvez également créer des parties du cercle, en donnant un angle de départ et de fin :

Les angles doivent être renseignés en degrés. Si vous avez des radians, convertissez-les simplement en utilisant la formule : ou en utilisant le module  de Python :

En haut

Création d'un arc avec des points (repères)
Malheureusement, il n'y a pas de fonction, mais nous avons la fonction pour créer un arc de cercle passant par trois points. Il crée un objet arc, joignant le point de départ au point d'arrivée, en passant par le point médian. La fonction de l'objet arc, doit être appelée pour obtenir un objet filaire, comme lorsque vous utilisez  au lieu de.

accepte uniquement pour les points et pas les tuples. Vous pouvez également obtenir un arc, en utilisant une partie d'un cercle :

Les arcs sont des arêtes valides comme les segments, ils peuvent donc également être utilisés dans les contours (ou forme filaire).

En haut

Création de polygones
Un polygone est simplement une forme filaire, avec plusieurs bords droits. La fonction prend une liste de points et crée un contour, passant à travers ces points :

En haut

Création de courbes de Bézier
Les courbes de Bézier sont utilisées, pour modéliser des courbes lisses à l'aide d'une série de pôles (points) et de poids facultatifs. La fonction ci-dessous crée un, à partir d'une série de points. Remarque : lors de "l'obtention" et du "réglage" d'un seul pôle ou poids, les indices commencent à 1, pas à 0.

En haut

Création d'un plan
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 est un rectangle qui possède une diagonale commençant sur le plan (3,0,0) et se terminant à (5,0,2).

L'épaisseur de la boîte (Box) dans l'axe y est égal à zéro, car notre forme est totalement plane.

PS: makePlane accepte uniquement Base.Vector pour start_pnt et dir_normal mais pas les tuples.

top

Création d'une ellipse
Pour créer une ellipse, il existe plusieurs façons:

There are several ways to create an ellipse:

Créez une ellipse avec un grand rayon = 2 et un petit rayon = 1 et un centre = (0,0,0).

Créez une copie des données de l'ellipse

Crée une ellipse positionnée au point "Center", le plan de l'ellipse est défini par Center, S1 et S2,

le grand axe est définit par Center et S1,

son grand rayon est la distance entre Center et S1,

son petit rayon est la distance entre S2 et le grand axe.

Crée une ellipse avec un grand rayon MajorRadius et un petit rayon MinorRadius et situé dans le plan défini par (0,0,1)

Dans le code ci-dessus, nous avons passé S1 (Grand rayon), S2 (Petit rayon) et le centre (les coordonnées centrales).

De même que l'Arc, l'Ellipse crée également un objet Ellipse mais pas d'arête (bords), nous avons donc besoin de le convertir en arête à l'aide toShape pour l'afficher.

PS: Arc accepte uniquement Base.Vector pour les points mais pas les tuples.

pour construire l'Ellipse ci-dessus, nous avons entré les coordonnées centrales, le Grand rayon et le Petit rayon.

top

Création d'un Tore
Nous créons un Tore en utilisant la méthode makeTorus( rayon1, rayon2 , [ pnt , dir , angle1 , angle2 , angle ] ).

Par défaut,

Rayon1 = est le rayon du grande cercle

Rayon2 = est le rayon du petit cercle,

pnt = Vecteur(0,0,0),pnt est le centre de tore

dir = Vecteur(0,0,1), dir est la direction normale

angle1 = 0, est l'angle de début pour le petit cercle exprimé en radians

angle2 = 360 est l'angle de fin pour le petit cercle exprimé en radians

angle = 360 le dernier paramètre est la section du tore

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:

Le code ci-dessus créera un tore avec un diamètre de 20 (rayon de 10) et une épaisseur de 4 (rayon du petite cercle 2)

Le code ci-dessus créera une portion du tore.

Le code ci-dessus créera un demi tore; seul le dernier paramètre change à savoir l'angle et les angles restants sont prédéfinis.

En donnant un angle de 180 degrés, créez un tore de 0 à 180 degrés, c'est à dire un demi tore.

top

Création d'un cube ou d'un parallélépipède
Utilisez makeBox(length,width,height,[pnt,dir]).

Par défaut pnt=Vector(0,0,0) and dir=Vector(0,0,1).

Using. By default pnt = Vector(0, 0, 0) and dir = Vector(0, 0, 1).

top

Création d'une Sphère
Nous utiliserons makeSphere ( rayon, [ pnt , dir , angle1 , angle2 , angle3 ] ).

rayon = rayon de la sphère par défaut,

pnt = Vecteur (0,0,0),

dir = Vecteur (0,0,1),

angle1 = -90, verticale minimale de la sphère

angle2 = 90, verticale maximale de la sphère

angle3 = 360, le diamètre de la sphère.

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

Création d'un Cylindre
Nous utiliserons makeCylinder(radius,height,[pnt,dir,angle]).

Par défaut,

pnt=Vector(0,0,0), dir=Vector(0,0,1) et angle=360.

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

top

Création d'un Cône
Nous utiliserons makeCone(radius1,radius2,height,[pnt,dir,angle]).

Par défaut,

pnt=Vector(0,0,0), dir=Vector(0,0,1) et angle=360.

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

top

Modification d'une forme
Il y a plusieurs manières de modifier des formes. Certaines sont de simples opérations de transformation telles que le déplacement ou la rotation de formes, d'autres sont plus complexes telles que fusion et soustraction d'une forme à une autre.

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

Transformer une forme
La transformation est l'action de déplacer une forme d'un endroit à un autre.

Toute forme (arête, face, cube, etc ..) peut être transformé de la même manière:

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:

Cette commande va déplacer notre forme "myShape" de 2 unités dans la direction x.

top

Rotation d'une forme
Pour faire pivoter une forme, vous devez spécifier le centre de rotation, l'axe, et l'angle de rotation:

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

Cette opération va faire pivoter notre forme de 180 degrés sur l'axe z.

top

Transformations génériques avec matrices
Une matrice est un moyen très simple de mémoriser les transformations dans le mode 3D. Dans une seule matrice, vous pouvez définir les valeurs de transformation, rotation et mise à l'échelle à appliquer à un objet.

Par exemple:

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:

PS: les matrices de FreeCAD travaillent en radians. En outre presque toutes les opérations matricielles qui travaillent avec un vecteur peut aussi avoir 3 nombres de sorte que ces 2 lignes effectuent le même travail:

Lorsque notre matrice est paramétrée, nous pouvons l'appliquer à notre forme. FreeCAD fournit nous fournit 2 méthodes: transformShape et transformGeometry().

La différence est que, avec la première, vous ne verez pas de différence (voir "mise à l'échelle d'une forme" ci-dessous).

Donc, nous pouvons opérer notre transformation comme ceci:

ou

top

Echelle du dessin (forme)
Changer l'échelle d'une forme est une opération plus dangereuse, car, contrairement à la translation ou à la rotation, le changement d'échelle non uniforme (avec des valeurs différentes pour x, y et z) peut modifier la structure de la forme!

Par exemple, le redimensionnement d'un cercle avec une valeur plus élevée horizontalement que verticalement le transformera en une ellipse, qui mathématiquement très différent.

Pour modifier l'échelle, nous ne pouvons pas utiliser le transformShape, nous devons utiliser transformGeometry:

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

Soustraction
Soustraire une forme d'une autre est appelé, dans le jargon OCC/FreeCAD "cut" (coupe) et,

se fait de cette manière:

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

top

Intersection
De la même manière, l'intersection entre 2 formes est appelé "common" et se fait de cette manière:

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

top

Fusion
La fusion "fuse", fonctionne de la même manière:

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

top

Section
Une section, est l'intersection entre une forme solide et une forme plane.

Elle retournera une courbe d'intersection et sera composée de bords (edges, arêtes).

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
L'extrusion est une action de "pousser" une forme plane dans une certaine direction et résultant en un corps solide.

Par exemple, pousser sur un cercle pour le transformer en tube:

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":

Si votre cercle est vide, vous obtiendrez un tube vide.

Mais si votre cercle est un disque avec une face pleine, vous obtiendrez un cylindre solide:

top

Exploration de la forme (shape)
Vous pouvez facilement explorer la structure de ses données topologique:

You can easily explore the topological data structure:

En tapant ce code dans l'interpréteur Python, vous aurez une bonne compréhension de la structure de Part objets.

Ici, notre commande makebox créé une forme solide. Ce solide, comme tous les solides Part, contiennent des faces. Une face est constituée de lignes, qui sont un ensemble de bords, arêtes qui délimitent la face. Chaque face a au moins un contour fermé (il peut en avoir plus si la face comporte un ou plusieurs trou). Dans une ligne, nous pouvons voir chaque côté séparément, et nous pouvons voir les sommets (Vertex) de chaque bord ou arête. Lignes et arêtes n'ont que deux sommets, évidemment.

top

Analyse des arêtes (Edge)
Dans le cas d'un bord (ou arête), qui est une courbe arbitraire, il est fort probable que vous voulez faire une discrétisation. Dans FreeCAD, les bords sont paramétrés par leurs longueurs.

Cela signifie, que vous pouvez suivre une arête/courbe par sa longueur:

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:

Maintenant, vous pouvez accéder à un grand nombre de propriétés de l'arête en utilisant sa longueur comme une position.

C'est à dire que, si l'arête(ou bord) a une longueur de 100 mm la position de départ est 0 et sa position extrème est 100.

top

Utilisation de la sélection
Ici, nous allons voir comment nous pouvons utiliser la fonction de sélection, quand l'utilisateur a fait une sélection dans la visionneuse.

Tout d'abord, nous créons une boîte (box) et nous l'affichons dans la fen^etre de vue.

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.

Sélectionnez maintenant des faces ou arêtes.

Avec ce script, vous pouvez parcourir tous les objets sélectionnés et visionner leurs sous-éléments:

Sélectionnez quelques bords et ce script va calculer la longueur:

top

Exemple Complet: "The OCC bottle"
L'exemple OpenCasCade Technology Tutorial vous montre comment faire une bouteille.

C’est un bon exercice pour FreeCAD. Si vous suivez notre exemple ci-dessous et la page OCC simultanément, vous verre comment les structures OCC sont implémentées dans FreeCAD. Le script complet ci-dessous est également inclus dans l’installation de FreeCAD (dans le dossier Mod / Part) et peut être appelé à partir de l'interpréteur Python en tapant:

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

Le script complet
Ici, le script complet de MakeBottle.py (extension .py):

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

Détail et déroulement MakeBottle.py
Nous aurons bien sûr besoin du module Part, mais aussi du module FreeCAD.Base, qui contient des structures FreeCAD de base comme des vecteurs et des matrices.

Ici, nous définissons notre fonction MakeBottle.

Cette fonction peut être appelée sans argument, comme nous l'avons fait ci-dessus, les valeurs par défaut, de largeur, hauteur et épaisseur seront utilisés.

Ensuite, nous définissons une paire de points qui seront utilisés pour la construction de notre profil de base.

C'est ici que nous définissons les formes géométriques: un arc composé de 3 points et deux segments de ligne de 2 points chacun.

Vous vous souvenez de la différence entre la géométrie et les formes? Nous allons construire les formes de notre forme géométrique. Trois bords (bords ou arêtes peuvent être des segments de droites ou des courbes) puis nous raccordons tous les sommets.

Jusqu'à présent, nous n'avons construit qu'un demi profil. Au lieu de construire le profil entier de la même manière, nous pouvons simplement reproduire ce que nous avons fait et coller les deux moitiés ensemble. Nous créons d'abord une matrice. Une matrice est un moyen très courant d'appliquer des transformations à des objets du monde 3D car elle peut contenir dans une structure toutes les transformations de base que peuvent subir les objets 3D (déplacement, rotation et mise à l'échelle). Après avoir créé la matrice, nous en faisons une symétrie puis nous créons une copie de notre fil avec cette matrice de transformation qui lui est appliquée. Nous avons maintenant deux fils et nous pouvons en faire un troisième, les fils étant en réalité des listes de bords.

Maintenant, nous avons un contour fermé, il peut être transformé en une face. Une fois que nous avons une face, nous pouvons l'extruder.

Une fois fait, nous avons un solide. Puis, nous appliquons un filet à notre objet car nous voulons lui donner un aspect "design", n'est-ce pas?

À ce stade, le corps de notre bouteille est fabriqué mais nous devons encore créer un goulot. On fait un nouveau solide avec un cylindre.

L'opération de fusion, qui dans d'autres applications est parfois appelé union, est très puissante.

Cette opération prendra soin de coller ce qui doit être collé et enlever ce qui doit être enlevé.

Puis, nous revenons à notre bouteille (Part solid), qui est le résultat de notre fonction.

Enfin, nous appelons la fonction pour créer la pièce puis la rendons visible.

top

Cube percé
Ici un exemple complet de construction d'un cube percé.

Here is a complete example of building a pierced box.

La construction se fait face par face et quand le cube est terminé, il est évidé d'un cylindre traversant.

top

Chargement et sauvegarde
Il ya plusieurs façons de sauver votre travail dans le Part Module. Vous pouvez bien sûr sauvegarder votre document au format FreeCAD, mais vous pouvez également enregistrer les objets directement dans un format courant de CAO, tels que BREP, IGS, STEP et STL.

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.

L'enregistrement d'une forme (un projet) dans un fichier est facile, il y a les fonctions exportBrep, exportIges, exportStl et exportStep qui sont des méthodes disponibles pour toutes les formes d'objets.

Donc, en faisant:

Ceci sauve votre box (cube) dans le format .STP. Pour charger un fichier BREP, IGES ou STEP:

Pour convertir un fichier STEP en fichier IGS:

En haut