Python scripting tutorial/fr

Introduction
Python est un langage de programmation qui est relativement facile à apprendre et à comprendre. Il est open-source et multi-plateforme et peut être utilisé à de nombreuses fins : des scripts shell simples aux programmes très complexes. Mais son utilisation la plus répandue se trouve dans le langage de script intégré dans d'autres applications. C'est ainsi qu'il est utilisé dans FreeCAD. Depuis la console Python, ou depuis des scripts personnalisés, vous pouvez contrôler FreeCAD et lui faire effectuer des opérations très complexes.

Par exemple, à partir d'un script Python, vous pouvez :
 * Créer de nouveaux objets.
 * Modifier les objets existants.
 * Modifier la représentation 3D de ces objets.
 * Modifier l'interface de FreeCAD.

Il existe plusieurs façons d'utiliser Python dans FreeCAD :
 * Depuis l'interpréteur Python de FreeCAD, où vous pouvez exécuter du code dans une interface du style " ligne de commande ".
 * Depuis les macros, qui sont un moyen pratique d'ajouter rapidement un outil manquant à l'interface FreeCAD.
 * A partir de scripts externes, qui peuvent être utilisés pour créer des solutions assez complexes, même des Ateliers entiers.

Dans ce tutoriel, nous allons travailler sur quelques exemples de base pour vous aider à démarrer, mais il y a beaucoup plus de documentations sur les scripts Python disponibles sur ce wiki. Si vous êtes totalement nouveau sur Python et que vous voulez comprendre comment cela fonctionne, nous avons également une Introduction à Python.

Avant de continuer avec les scripts Python, allez dans la fenêtre et cochez les deux cases : Accédez ensuite à et vérifiez :
 * coché.

Ecrire du code Python
Il existe deux façons d'écrire du code Python dans FreeCAD. Dans la Console Python (sélectionnez le menu) ou dans l'éditeur de Macro (sélectionnez dans le menu). Dans la console vous écrivez les commandes Python une par une, en les exécutant en appuyant sur, tandis que les macros peuvent contenir du code plus complexe composé de plusieurs lignes, exécuté uniquement lorsque la macro est démarrée.



Dans ce tutoriel vous pouvez utiliser les deux méthodes. Vous pouvez copier-coller chaque ligne dans la console Python puis appuyer sur, ou copier-coller le code entier dans une nouvelle fenêtre Macro.

En haut

Exploration de FreeCAD
Commençons par créer un nouveau document vierge :

Si vous écrivez dans la console Python FreeCAD, vous remarquerez que dès que vous tapez une fenêtre apparaît, permettant de compléter rapidement le reste de votre ligne. Encore mieux, chaque entrée de la liste de saisie semi-automatique a une info-bulle expliquant ce qu'elle fait. Cela facilite l'exploration des fonctionnalités disponibles. Avant de choisir, jetez un œil aux autres options.



Maintenant notre nouveau document sera créé. Cela revient à appuyer sur le bouton dans la barre d'outils. En fait, la plupart des boutons de FreeCAD ne font rien d'autre que d'exécuter une ou plusieurs lignes de code Python. Encore mieux, vous pouvez définir une option dans avec. Cela affichera dans la console tout le code Python exécuté lorsque vous pressez les boutons. Très utile pour apprendre à reproduire des actions dans Python.

Maintenant revenons à notre document et voyons ce que nous pouvons faire avec lui :

Explorez les options disponibles. Habituellement, les noms qui commencent par une majuscule sont des attributs, ils contiennent une valeur, tandis que les noms qui commencent par une minuscule sont des fonctions (également appelées méthodes) ; ils "font quelque chose". Les noms commençant par un trait de soulignement sont généralement là pour le fonctionnement interne du module et vous ne devriez pas vous en soucier. Utilisons l'une des méthodes pour ajouter un nouvel objet à notre document :

Rien ne se passe. Pourquoi ? Parce que FreeCAD est conçu pour de gros projets. Un jour, il fonctionnera avec des centaines d'objets complexes, tous dépendants les uns des autres. Faire un petit changement quelque part pourrait avoir un grand impact, vous devrez peut-être recalculer tout le document, ce qui pourrait prendre du temps. Pour cette raison, presque aucune commande ne met automatiquement à jour la scène. Vous devez le faire manuellement :

Maintenant notre boîte est apparue. De nombreux boutons qui ajoutent des objets dans FreeCAD font en fait deux choses : ajouter l'objet et recalculer. Si vous avez activé l'option ci-dessus, essayez d'ajouter une sphère avec le bouton GUI, vous verrez les deux lignes de code Python s'exécuter l'une après l'autre.

Explorons maintenant le contenu de notre boîte :

Vous verrez immédiatement un certain nombre de choses très intéressantes telles que :

Cela affichera la hauteur actuelle de notre boîte. Maintenant, essayons de changer cela :

Si vous sélectionnez votre boîte avec la souris, vous verrez que dans l'Éditeur de propriétés, sous l'onglet, notre propriété apparaît. Toutes les propriétés d'un objet FreeCAD qui y apparaissent (et également sur l'onglet, nous développerons plus tard), sont également directement accessibles par Python, par leur nom, comme nous l'avons fait avec notre propriété. Essayez de changer les autres dimensions de la boîte.

En haut

Vecteurs et placements
Les vecteurs sont un concept tout à fait fondamental dans toute application 3D. Un vecteur est une liste de 3 nombres (x, y et z), décrivant un point ou une position dans l'espace 3D. Beaucoup de choses peuvent être faites avec des vecteurs, tels que des additions, des soustractions, des projections et beaucoup plus. Dans FreeCAD, les vecteurs fonctionnent comme ceci :

Une autre caractéristique commune des objets FreeCAD est leur placement. Chaque objet possède une propriété, qui contient les (position) et les  (orientation) de l'objet. Elle est facile à manipuler, par exemple pour déplacer notre objet :

Avant d'aller plus loin, vous devez comprendre quelques concepts importants.

En haut

Application et Interface Utilisateur
FreeCAD a été conçu pour pouvoir également être utilisé sans son interface utilisateur, en tant qu'application en ligne de commande. Presque chaque objet dans FreeCAD se compose donc de deux parties : un (objet), sa composante "géométrie" et un  (Vue de l'objet), sa composante "visuelle". Lorsque vous travaillez en mode ligne de commande, la partie géométrique est présente, mais la partie visuelle est désactivée.

Pour illustrer le concept, observons notre objet cube. Les propriétés géométriques du cube, telles que ses dimensions, sa position, etc. sont stockées dans. Alors que ses propriétés visuelles, telles que sa couleur, son épaisseur de ligne, etc. sont stockées dans. Cela correspond aux onglets Données et Vue dans l'Éditeur de propriétés. La partie ViewObject d'un objet est accessible comme ceci :

Vous pouvez également modifier les propriétés de l'onglet Vue :

Lorsque vous démarrez FreeCAD, la console Python charge déjà deux modules de base : et  (qui sont également accessibles par leurs raccourcis  et ). Ils contiennent toutes sortes de fonctionnalités génériques pour travailler avec des documents et leurs objets. Pour illustrer notre concept, voyez que et  contiennent à la fois un attribut, qui est le document actuellement ouvert. et ne sont cependant pas le même objet. Ce sont les deux composants d'un document FreeCAD et ils contiennent différents attributs et méthodes. Par exemple, contient, qui est la Vue 3D actuellement ouverte.

En haut

Les modules
La véritable puissance de FreeCAD réside dans ses précieux modules. L'application de base FreeCAD est plus ou moins un conteneur vide. Sans ses modules, elle ne peut guère faire plus que créer de nouveaux documents vides. Chaque module ajoute non seulement de nouveaux ateliers à l'interface, mais également de nouvelles commandes Python et de nouveaux types d'objets. Par conséquent, plusieurs types d'objets différents, voire totalement incompatibles, peuvent coexister dans le même document. Les modules les plus importants de FreeCAD que nous verrons dans ce tutoriel sont : Part (Pièce), Mesh (Maillage), Sketcher (Esquisseur) et Draft (Planche à dessin).

Sketcher (Atelier Esquisse) et Draft (Atelier Planche à dessin) utilisent tous deux le module Part (Atelier Pièce) pour créer et gérer leur géométrie. Tandis que Mesh (Atelier Maillage) est totalement indépendant et gère ses propres objets. Plus d'informations à ce sujet ci-dessous.

Vous pouvez vérifier tous les types d'objets de base disponibles pour le document actuel comme ceci :

Les différents modules FreeCAD ne sont pas automatiquement chargés dans la console Python. C'est pour éviter d'avoir un démarrage très lent. Les modules sont chargés uniquement lorsque vous en avez besoin. Ainsi, par exemple, pour explorer ce qui se trouve à l'intérieur du module Part :

Mais nous parlerons plus en détail du module Part ci-dessous.

En haut

Mesh (Maillage)
Un Maillage est un type d'objet 3D très simple, utilisé par exemple par Sketchup, Blender et 3D Studio Max. Ils sont composés de 3 éléments : des points (également appelés sommets), des lignes (également appelées arêtes) et des faces. Dans de nombreuses applications, FreeCAD inclus, les faces peuvent n'avoir que 3 sommets. Bien sûr, rien ne vous empêche d'avoir une face plus grande composée de plusieurs triangles coplanaires.

Les maillages sont simples, mais comme ils sont simples, vous pouvez facilement en avoir des millions dans un seul document. Cependant, dans FreeCAD, ils sont moins utilisés et sont principalement là pour que vous puissiez importer des objets dans des formats de maillage à partir d'autres applications. Le module Mesh a également été largement utilisé comme module de test principal au cours du premier mois de la vie de FreeCAD.

Les objets Mesh et les objets FreeCAD sont des choses différentes. Vous pouvez voir l'objet FreeCAD comme un conteneur pour un objet Mesh (et comme nous le verrons ci-dessous, pour les objets Part également). Donc pour ajouter un objet Mesh à FreeCAD, nous devons d'abord créer un objet FreeCAD et un objet Mesh, puis ajouter l'objet Mesh à l'objet FreeCAD :

Il s'agit d'un exemple standard qui utilise la méthode pour créer une sphère, mais vous pouvez également créer des maillages personnalisés à partir de zéro en définissant leurs sommets et faces.

Plus de renseignements sur les scripts Mesh...

En haut

Part (Atelier Pièce)
Le Module Part est le module le plus puissant de FreeCAD. Il vous permet de créer et de manipuler des objets BRep. BRep signifie Boundary Representation ou « Représentation par les Bords ». Un objet BRep est défini par des surfaces qui entourent et définissent un volume intérieur. Contrairement aux maillages, les objets BRep peuvent avoir une grande variété de composants, des faces planes aux surfaces NURBS très complexes.

Le module Part est basé sur la puissante bibliothèque OpenCasCade, qui permet d'effectuer un large éventail d'opérations complexes sur ces objets, telles que les opérations booléennes, le filetage, les balayages, etc.

Le module Part fonctionne de la même manière que le module Mesh : vous créez un objet FreeCAD, un objet Part, puis ajoutez l'objet Part à l'objet FreeCAD :

Le module Part (comme le module Mesh) a également un raccourci qui crée automatiquement un objet FreeCAD et lui ajoute une forme, vous pouvez donc raccourcir les trois dernières lignes avec :

En explorant le contenu de myshape, vous remarquerez de nombreux sous-composants intéressants tels que, , , et  et un large éventail d'opérations de géométrie telles que  (soustraction),  (intersection) ou  (union). La page Script pour création topologique explique tout cela en détail.

Ici plus de renseignements sur les scripts Part

En haut

Draft (Planche à dessin)
FreeCAD propose de nombreux autres modules, tels que Sketcher (Esquisseur) et Draft (Planche à dessin), qui créent également des objets Part (Pièce). Ces modules ajoutent des paramètres supplémentaires aux objets créés, voire implémentent une toute nouvelle façon de gérer la géométrie de la pièce qu'ils contiennent. Notre exemple de boîte ci-dessus est un exemple parfait d'un objet paramétrique. Tout ce dont vous avez besoin pour définir la boîte est de spécifier les paramètres hauteur, largeur et longueur. Sur la base de ceux-ci, l'objet calculera automatiquement sa forme " de pièce ". FreeCAD vous permet de créer de tels objets en Python.

Le Module Draft ajoute des types d'objets paramétriques 2D (qui sont tous des objets Part) tels que des lignes et des cercles et fournit également des fonctions génériques qui fonctionnent non seulement sur les objets Draft, mais sur tout objet Part. Pour explorer ce qui est disponible, faites simplement :

En haut

Interface
The FreeCAD user interface is made with Qt, a powerful graphical interface system, responsible for drawing and handling all the controls, menus, toolbars and buttons around the 3D view. Qt provides a module, PySide, which allows Python to access and modify Qt interfaces such as FreeCAD's. Let's try to fiddle with the Qt interface and produce a simple dialog:

Une boîte de dialogue apparaît et nous voyons aussi l'icone de FreeCAD, ce qui signifie que Qt sait que l'ordre d'affichage de la fenêtre a été fait à l'intérieur de l'application FreeCAD. Nous pouvons donc facilement et partiellement modifier l'interface de FreeCAD.

Qt est un système de construction d'interface très puissant qui vous permet de faire des choses très complexes. Qt possède aussi une panoplie d'outils tel que Qt Designer avec lequel vous pouvez concevoir vos boîtes de dialogue graphique et de les ajouter à l'interface de FreeCAD avec quelques lignes de code Python.

Plus de renseignements sur PyQt ici et ici PyQt

top

Macros
Maintenant que vous avez une bonne connaissance des notions de base, où allons-nous placer nos scripts Python ? Comment allons-nous les lancer à partir de FreeCAD?

Il y a pour cela un mécanisme appelé Macros. Une macro est tout simplement un script en Python qui peut être ensuite ajouté à la barre d'outils et lancé à partir d'un simple clic de souris.

FreeCAD est fournit avec un petit éditeur de texte (Macro → Macros → Créer) où vous pouvez écrire ou coller des scripts. Une fois le script terminé, allez dans Outils → Personnaliser → Macros où vous pouvez définir un bouton pour votre macro puis ajouter ce bouton à la barre d'outils.

Now that you have a good understanding of the basics, where are we going to keep our Python scripts, and how are we going to launch them inside FreeCAD? There is an easy mechanism for that, called Macros. A macro is a Python script that can be added to a toolbar and launched via a mouse click. FreeCAD provides you with a simple text editor where you can write or paste scripts. Once the script is done, use to define a button for it that can be added to toolbars.

Vous êtes maintenant prêt pour un script FreeCAD plus approfondi. Rendez-vous sur la Documentation pour utilisateurs avancés!

top