FreeCAD Scripting Basics/fr

Tutoriel sur les scripts Python

Scripts pour Mesh

Index

Python scripting in FreeCAD

FreeCAD a été programmé dès la première ligne de code pour être totalement contrôlé par des scripts écrits en Python. Presque toutes les parties de FreeCAD, telles que l'interface, le contenu des scènes et même la représentation de ce contenu dans les vues 3D, sont accessibles à partir de l'interpréteur Python intégré ou de vos propres scripts. En conséquence, FreeCAD est probablement l'une des applications d'ingénierie les plus personnalisables et évolutives disponibles actuellement.

Si vous n'êtes pas familier avec Python, nous vous recommandons de chercher des tutoriels sur internet et jeter un œil rapide sur sa structure. Python est un langage très facile à apprendre, en particulier parce qu'il peut être exécuté à l'intérieur d'un interpréteur, de la plus simple commande jusqu'à l'élaboration de programmes complexes, il peut être exécuté à la volée sans avoir besoin de compilateur. FreeCAD dispose de son propre interpréteur Python intégré. Si vous ne voyez pas de fenêtre intitulée Console Python comme illustré ci-dessous, vous pouvez l'activer en cliquant dans la barre d'outils Affichage → Panneaux → Console Python.

L'interpréteur Python

Depuis l’interpréteur, vous pouvez accéder à l'ensemble de vos modules Python installés sur le sytème, ainsi qu'aux modules FreeCAD intégrés et à tous les modules FreeCAD supplémentaires que vous avez installés ultérieurement. La capture d'écran ci-dessous montre l'interpréteur Python :

Depuis l'interpréteur, vous pouvez exécuter du code Python et parcourir les classes et fonctions disponibles. FreeCAD fournit un navigateur de classe très pratique pour l'exploration du monde FreeCAD : lorsque vous tapez le nom d'une classe connue suivi d'un point (ce qui signifie que vous voulez ajouter quelque chose après le point, à partir de cette classe), une fenêtre du navigateur de classe s'ouvre, où vous pouvez naviguer entre sous-classes et méthodes disponibles. Lorsque vous sélectionnez quelque chose, un texte d'aide associé (s'il existe) s'affiche :

Alors, commencez ici en tapant App. ou Gui. et voyez ce qui se passe. Une autre façon, plus typique de Python, d'explorer le contenu des modules et des classes consiste à utiliser la commande print(dir()). Par exemple, taper print(dir()) listera tous les modules actuellement chargés dans FreeCAD. print(dir(App)) vous montrera tout ce qu'il y a, à l'intérieur du module App, etc.

Une autre fonctionnalité utile de l'interpréteur est la possibilité de parcourir l'historique des commandes et de récupérer une ligne de code que vous avez déjà tapée précédemment. Pour parcourir l'historique des commandes, utilisez simplement Flèche haut ou Flèche bas.

Si vous cliquez avec le bouton droit de la souris dans la fenêtre de l'interpréteur, vous avez également les options classiques d'un traitement de texte, telles que copier tout l'histoire (utile lorsque vous voulez expérimenter votre code avant de faire votre script final), ou d'insérer un nom de fichier avec le chemin complet.

top

Aide Python

Dans le menu Aide de FreeCAD, vous trouverez une entrée intitulée Documentation automatique des modules python, qui ouvrira une fenêtre de navigateur contenant une documentation complète et générée en temps réel de tous les modules Python disponibles pour l'interpréteur FreeCAD ; y compris les modules intégrés Python et FreeCAD, les modules installés par le système et les modules supplémentaires FreeCAD. La documentation ainsi disponible, dépend de l'effort que chaque développeur de modules, met à documenter son code ; mais les modules Python ont la réputation d'être assez bien documentés. Votre fenêtre FreeCAD doit rester ouverte pour que ce système de documentation fonctionne. L'entrée Documentation de script Python vous donnera un lien rapide vers la section wiki Documentation pour utilisateurs expérimentés.

En haut

Modules intégrés

Étant donné que FreeCAD est conçu pour pouvoir également être exécuté sans interface graphique (GUI), presque toutes ses fonctionnalités sont séparées en deux groupes : la fonctionnalité principale, nommée App et la fonctionnalité GUI, nommée Gui. Ces deux modules sont également accessibles à partir de scripts en dehors de l'interpréteur, respectivement par les noms FreeCAD et FreeCADGui.

• Dans le module App, vous trouverez tout ce qui concerne l'application elle-même, comme les méthodes d'ouverture ou de fermeture des fichiers et pour les documents, comme la définition du document actif ou la liste de son contenu.

• Dans le module Gui, vous trouverez des outils pour accéder et gérer les éléments Gui, comme les établis et leurs barres d'outils et plus intéressant, la représentation graphique de l'ensemble du contenu FreeCAD.

Lister le contenu de ces modules n'est pas très utile, car ces derniers se développent assez rapidement avec la croissance de FreeCAD. Mais les deux outils de navigation fournis (le navigateur de classe et l'aide Python), devraient vous fournir à tout moment, une documentation complète et à jour.

En haut

Les objets App et Gui

Comme nous l'avons déjà mentionné, dans FreeCAD tout est séparé en noyau et représentation graphique. Cela inclut les objets 3D. Vous pouvez accéder à l'édition des propriétés des objets (appelées fonctionnalités dans FreeCAD) via le module App et changer la façon dont ils sont représentés à l'écran via le module Gui. Par exemple, un cube possède des propriétés le définissant (comme la largeur, la longueur et la hauteur) qui sont stockées dans un objet App et des propriétés de représentation (comme la couleur des faces, le mode de dessin) qui sont stockées dans un objet Gui correspondant.

Cette méthode de travail permet une multitude d'utilisations, comme des algorithmes travaillant uniquement sur la partie des caractéristiques, sans avoir à se soucier de la partie visuelle, voire de réorienter le contenu du document à une partie non-graphique de l'application, tels que des listes, des tableurs, ou l'analyse d'éléments.

Pour chaque objet App dans votre document, il existe un objet correspondant Gui.
En fait le document lui-même possède à la fois des objets App et des objets Gui. Bien sûr, ceci n'est valable que lorsque vous exécutez FreeCAD dans son interface graphique. Dans la version en ligne de commande (sans interface graphique), seuls les "objets App" sont accessibles.
Notez que la partie "objet Gui" est réactualisé chaque fois qu'un "objet App" est recalculé (par exemple lorsqu'il y a un changement de paramètres), les changements que vous pourriez avoir fait directement à l'objet Gui peuvent être perdues.

Pour accéder à la partie App d'un objet, vous devez tapez:

myObject = App.ActiveDocument.getObject("ObjectName")

où "ObjectName" est le nom de votre objet.
Le même résultat est obtenu en tapant:

myObject = App.ActiveDocument.ObjectName

Pour accéder à la partie Gui d'un l'objet , vous tapez:

myViewObject = Gui.ActiveDocument.getObject("ObjectName")

où "ObjectName" est le nom de votre objet.
Le même résultat est obtenu en tapant:

myViewObject = App.ActiveDocument.ObjectName.ViewObject

Si vous n'êtes pas dans l'interface graphique (Gui) (par exemple si vous êtes en mode ligne de commande), la dernière ligne retournée sera 'None'.

top

Les objets dans un document

Dans FreeCAD tout votre travail est dans un "Document". Ce document contient vos formes géométriquee et peut être sauvegardé dans un fichier. Dans FreeCAD, plusieurs documents peuvent être ouverts en même temps. Le document, et les formes géométriques contenues , sont des objets App et des objets Gui. Les objets App contiennent les définitions des formes géométriques réelles, tandis que les objets Gui contiennent les différentes vues de votre document.
Vous pouvez ouvrir plusieurs fenêtres, chacune de ces fenêtres peut afficher votre projet avec un facteur de zoom différent ou des vues différentes du projet. Ces vues font toutes partie de l'objet Gui de votre document.

In FreeCAD all your work resides inside documents. A document contains your geometry and can be saved to a file. Several documents can be opened at the same time. The document, like the geometry contained inside, has App and Gui objects. The App object contains your actual geometry definitions, while the Gui object contains the different views of your document. You can open several windows, each one viewing your work with a different zoom factor or from a different direction. These views are all part of your document's Gui object.

Pour accéder à la partie App du document ouvert (actif), tapez:

myDocument = App.ActiveDocument

Pour créer un nouveau document, tapez:

myDocument = App.newDocument("Document Name")

Pour accéder à la partie graphique (Gui) du document ouvert (actif), tapez:

myGuiDocument = Gui.ActiveDocument

Pour accéder à la vue courante, tapez:

myView = Gui.ActiveDocument.ActiveView

top

Modules supplémentaires

Les modules FreeCAD et FreeCADGui sont utilisés uniquement pour créer et gérer des objets dans le document FreeCAD. Ils ne sont pas utilisés pour la création ou la modification des formes géométriques.
Les formes géométriques peuvent être de plusieurs types, elles sont donc construites par des modules supplémentaires, chaque module s'occupe la gestion d'un type de forme géométrique spécifique.
Par exemple, le module "Part utilisé par le noyau OpenCascade, et donc capable de créer et manipuler des formes géométriques de type B-rep, pour lequel OpenCascade est construit.
Le module "Mesh" est capable de construire et modifier des objets Mesh (mailles). De cette façon, FreeCAD est capable de gérer une grande variété de types d'objets, qui peuvent coexister dans le même document, et de nouveaux types d'objets pourront êtres ajoutés facilement et constamment.

The FreeCAD and FreeCADGui modules are only responsible for creating and managing objects in the FreeCAD document. They don't actually do anything more such as creating or modifying geometry. This is because that geometry can be of several types, and therefore requires additional modules, each responsible for managing a certain geometry type. For example, the Part Module, using the OpenCascade kernel, is able to create and manipulate BRep type geometry. Whereas the Mesh Module is able to build and modify mesh objects. In this manner FreeCAD is able to handle a wide variety of object types, that can all coexist in the same document, and new types can easily be added in the future.

top

Création d'objets

Chaque module a sa propre manière de gérer sa forme géométrique, mais il y a une chose qu'ils peuvent tous faire, c'est de créer des objets dans le document.
Mais, le document FreeCAD connaît tous les types d'objets disponibles fournis par les modules,
tapez:

Each module has its own way of dealing with geometry, but one thing they usually all can do is create objects in the document. But the FreeCAD document is also aware of the available object types provided by the modules:

FreeCAD.ActiveDocument.supportedTypes()

FreeCAD listera tous les objets possibles que vous pouvez créer.
Par exemple, nous allons créer un objet maillage (traité par le module "Mesh") et une objet Part (traité par le module le "Part"):

myMesh = FreeCAD.ActiveDocument.addObject("Mesh::Feature", "myMeshName")
myPart = FreeCAD.ActiveDocument.addObject("Part::Feature", "myPartName")

Le premier argument est le type d'objet "Mesh::", le second est le nom de l'objet "myMeshName". Nos deux objets semblent identiques: Ils ne contiennent pas encore de forme géométrique, et la plupart de leurs propriétés sont les mêmes lorsque vous les inspecter avec dir(myMesh) et dir(myPart).
Sauf que, myMesh a une propriété "Mesh" (maille) et myPart a une propriété "Part" (forme géométrique).
C'est de cette manière que les données de "Mesh" (maillage) et "Part" (forme géométrique) sont stockées.
Par exemple, nous allons créer un cube (Part) et le stocker dans notre objet myPart:

import Part
cube = Part.makeBox(2, 2, 2)
myPart.Shape = cube

Si vous essayez de stocker le cube avec la propriété objet Mesh "myMesh", il retournera une erreur de type. Car ces propriétés sont conçues uniquement pour stocker un type d'objet bien défini.
Dans la propriété objet Mesh "myMesh", vous ne pouvez enregistrer que des objets créé avec le module Mesh.
Notez que la plupart des modules disposent également d'un raccourci pour ajouter leur formes géométriques au document:

import Part
cube = Part.makeBox(2, 2, 2)
Part.show(cube)

top

Modification d'objets

La modification d'un objet est faite de la même manière:

Modifying an object is done in the same way:

import Part
cube = Part.makeBox(2, 2, 2)
myPart.Shape = cube

Maintenant, nous allons construire un cube plus gros:

biggercube = Part.makeBox(5, 5, 5)
myPart.Shape = biggercube

top

Questionner les objets

Vous pouvez toujours connaître de quel type est un objet.
Faites ceci:

You can always look at the type of an object like this:

myObj = FreeCAD.ActiveDocument.getObject("myObjectName")
print(myObj.TypeId)

ou de savoir si un objet fait partie d'un modèle de base (Part Feature, Mesh Feature, etc):

print(myObj.isDerivedFrom("Part::Feature"))

Maintenant vous pouvez commencer à travailler avec FreeCAD! Pour savoir ce que vous pouvez faire avec le Part Module, lisez la page Part scripting, ou la page Script Mesh pour travailler avec le module Mesh .
Notez que, bien que les modules Part et Mesh sont les plus complets et les plus largement utilisés, les autres modules tels que le Draft Module (Projet) ont également leurs API scripts qui peuvent vous être utiles.
Pour une liste complète de chaque module et de leurs outils disponibles, visitez la section :Category:API (en).

top

Python script tutoriel

Scripts pour Mesh

Index

Hub utilisateurs expérimentés

• Scripts FreeCAD : Python, Introduction à Python, Tutoriel sur les scripts Python, Débuter avec les scripts

---

• Modules : Modules intégrés, Unités, Quantity
• Ateliers : Création d'atelier, Commands Gui, Les commandes, Installer des ateliers supplémentaires
• Maillages et objets Parts : Scripts Mesh, Script de données topologiques, Conversion objet Mesh en Part, PythonOCC

---

• Objets paramétriques : Objets créés par script, Viewproviders (Icône personnalisée dans l'arborescence)
• Scénographie : Graphe de scène Coin (Inventor), Pivy
• Interface graphique : Création d'interface, Création d'une boite de dialogue (1, 2, 3, 4, 5), PySide, Exemples PySide débutant, intermédiaire, expérimenté
• Macros : Macros, Comment installer des macros
• Intégration : Intégrer FreeCAD, Intégration de FreeCADGui

---

• Autre : Expressions, Extraits de codes, Fonction - tracer une ligne, Bibliothèque mathématique vectorielle de FreeCAD (déprécié)

---

• Hubs : Hub utilisateurs, Hub utilisateurs expérimentés, Hub développeurs