Scripts/fr

Introduction
Avec Scripting, nous entendons créer des objets topologiques à l'aide de l'interpréteur Python de FreeCAD. FreeCAD pourrait être utilisé comme un "très bon" remplacement d'OpenSCAD, principalement parce qu'il a un véritable interpréteur Python, ce qui signifie qu'il a un vrai langage de programmation à bord, presque tout ce que vous pouvez faire avec l'interface graphique est faisable avec un script Python.

Malheureusement, les informations sur les scripts dans la documentation, et même dans ce wiki sont éparpillées et manquent d'uniformité "d'écriture" et la plupart d'entre elles sont expliquées d'une manière trop technique.

Vous ouvrir l'appétit
Le premier obstacle d'une manière simple à la création de scripts est qu'il n'y a pas de moyen direct d'accéder à l'éditeur Python interne de FreeCAD via un élément de menu ou une icône dans la zone de la barre d'outils, mais sachant que FreeCAD ouvre un fichier avec un dans l'éditeur Python interne, l'astuce la plus simple est de créer dans votre éditeur de texte préféré, puis de l'ouvrir avec la commande habituelle.

Pour faire les choses d'une manière polie, le fichier doit être écrit avec un certain ordre, l'éditeur Python FreeCAD a une bonne "Syntaxe HIghlighting" qui manque dans de nombreux éditeurs simples comme le Notepad Windows ou certains éditeurs Linux de base, il suffit donc d'écrire ces quelques lignes:

Enregistrez-les avec un nom significatif avec l'extension et chargez le fichier résultant dans FreeCAD, avec la commande Fichier - Ouvrir.

Un exemple simple de ce qu'il est nécessaire d'avoir dans un script est présenté dans cette partie du code que vous pourriez utiliser comme modèle pour presque tous les futurs scripts:

Certaines astuces sont incorporées dans le code ci-dessus:


 * Cette ligne importe FreeCAD dans l'interpréteur FreeCAD Python, cela peut sembler redondant, mais ce n'est pas le cas.
 * Base et Vector sont largement utilisés dans l'écriture de scripts FreeCAD, les importer de cette manière vous évitera de les appeler avec ou  au lieu de  ou, cela économisera de nombreuses frappes et rendra les lignes de code beaucoup plus petites.

Commençons par un petit script qui fait un très petit travail, mais qui montre la puissance de cette approche.

Mettez ces lignes après le code "modèle" et appuyez sur la flèche verte dans la Barre d'outils Macro

Vous verrez des choses magiques, un nouveau document est ouvert nommé "Pippo" (nom italien pour Toqué) et vous verrez dans la vue 3D un Cube comme ci-dessous.



Quelque chose en plus...
Pas trop étonnant? Oui, mais il faut commencer quelque part, on peut faire la même chose avec un Cylindre, ajouter ces lignes de code après la méthode et avant la ligne.

Même ici, rien de trop excitant. Mais veuillez noter quelques particularités:


 * L'absence de la référence habituelle à l ', présente dans de nombreux extraits de code de documentation est délibérée. Ce code pourrait être utilisé même en invoquant FreeCAD comme module dans un interpréteur Python externe, la chose n'est pas facilement faisable avec une AppImage, mais avec un certain soin, cela pourrait être fait. De plus, dans la devise standard de Python, "mieux explicite qu'implicite", explique de manière très "mal" d'où viennent les choses.
 * Notez l'utilisation du nom "constant" attribué au document actif dans = . activeDocument n'est pas une "constante" au sens strict, mais d'une manière "sémantique" c'est notre "Document actif", qui pour notre utilisation sera une "constante" appropriée. La convention Python d'utiliser le nom "ALL CAPS" pour "constantes", sans oublier que  est beaucoup plus court que.
 * Chaque méthode retourne une géométrie, cela sera clair dans la suite de la page.
 * Une geometrie n'avait pas la propriété, lors de l'utilisation de géométries simples pour créer une géométrie plus complexe, gérer est une chose délicate.

Maintenant, que faire avec ces géométries?

Introduisons les opérations booléennes. Comme exemple pour démmarrer, placez ces lignes après, cela crée une méthode pour une Fusion également connue sous le nom d'opération Union:

Rien d'exceptionnel ici aussi, notez cependant l'uniformité dans le codage des méthodes; Cette approche est plus linéaire que celles vues autour d'autres tutoriels sur les scripts, cette "linéarité" aide grandement à la lisibilité et aussi avec les opérations couper-copier-coller.

Utilisons les géométries, supprimons les lignes sous la section de code commençant par et insérons les lignes suivantes:

Lancez le script avec la flèche verte et nous verrons dans la vue 3D quelque chose comme:



Placement
Le concept de placement est relativement complexe, voir tutoriel avion pour une explication plus approfondie.

We usually are in need of placing geometries respect each other, when building complex object this is a recurring task, the most common way is to use the geometry property.

FreeCAD offer a wide choice of ways to set this property, one is more tailored to another depending the knowledge and the background of the user, but the more plain writing is explained in the cited Tutorial, it use a peculiar definition of the portion of, quite easy to learn.

But over other consideration, one thing is crucial, geometry reference point, in other word the point from which the object is modeled by FreeCAD, as described in this table, copied from Placement:

This information has to be kept in mind especially when we have to apply a rotation.

Some examples may help, delete all the line after method and insert the portion of code below:

Let's explain something in the code:


 * We have used a method to define a spehere, using the most easy definition, using only the radius.
 * We have introduced a second writing for the 'Union or Fusion, using multiple objects, not more distant from the usual Part::Fuse it uses Part:Multifuse and use only one property, we have passed a tuple as arguments, but it accepts also a list.
 * We have defined a complex object aeroplano (italian word for aeroplane), but we have done it in a "parametric" way, defining some parameters and deriving other parameters, through some calculation, based on the main parameters.
 * We have used some Placement poperties around in the method and before returning the final geometries we have used a  property with the Yaw-Pitch-Roll, writing. Note the last, that define a center of rotation of the whole geometry.

It can be easily noted that aeroplano geometry rotate around his "barycenter" or "center of gravity", that I've fixed at wing center, a place that is relatively "natural", but could be placed wherever you want.

The first  is the Translation vector, not used here, but if you substitute  with these lines:

You will see in the Report window this text:

What has happened?

FreeCAD has translated the in other word our  definition that specifies three components, Translation, Rotation and center of rotation in the "internal" values of only two components, Translation and Rotation'.

you can easily visualize the value of using a print statement in the  method and see that it is:

in other word the rotation center of the geometry is at, but this rotation center is not shown in the GUI, it could be entered as a value, it could not be easily retrieved.

This is the meaning of the word "awkward" that I've used to define property.