Scripts

Editing Scripts
Work in progress, the page was written by error in Italian, now I'm trying to translate it in English, sorry for the inconvenience

With Scripting we mean create topological objects using FreeCAD Python interpreter. FreeCAD could be used a "very good" replacement of OpenSCAD, manìinly beacause it has a real Python interpreter, that means that it has a real programming language on board, almost everything you could do with the GUI, is doable with a Python Script.

Sadly information about scripting in the documentation, and even in this wiki are scattered around and lacks of "writing" uniformity and most of them are explained in a too technical manner.

Wetting you appetite
The first obstacle in an easy way to scripting is that there is no direct way to access the FreeCAD internal Python editor through a menu item or a icon on the toolbar area, but knowing that FreeCAD opens a file with a extension in the internal Python editor, the most simple trick is create in your favourite text editor and then open it with the usual command File - Open.

To make the things in a polite way, the fila has to be written with some order, FreeCAD Python editor have a good "Syntax HIghlighting" that lacks in many simple editors like Windows Notepad or some basic Linux editors, so it is sufficient to write these few lines:

Save them with a meaningfull name with extension and load the resulting file in FreeCAD, with the said File - Open command.

A minimal example of what is necessary to have in a script is shown in this portion of code that you could be use as a template for almost any future script:

Some tricks are incorporated in the above code:


 * This line import FreeCAD in the FreeCAD Python interpreter, it may seem a redundant thing, but it isn't
 * Base and Vector are widely used in FreeCAD scipting, import them in this manner will save you to invoke them with or  instead of    or, this will save many keystrokes and make codelines much smaller.

Let's start with a small script that does a very small job, but display the power of this approach.

Put these lines after the "template" code and press the green arrow in the Macro toolbar

You will see some magic things, a new document is open named "Pippo" (Italian name of Goofy) and you will see in the 3d view a cube, like the one in the image below.



Something more...
Not too amazing? Yes, but we have to start somewhere, same thing we can do with a Cylinder, add these lines of code after the method and before the line.

Even here nothing too exciting. But please note some peculiarities:


 * The absence of the usual reference to the, present in many Documentation code snippets, is deliberate, this code could be used even invoking FreeCAD as a module in an external Python, the thing is not easily doable with an AppImage, but with some care it could be done. Plus in the standard Python motto that "better explicit than implicit"  is explaining in a very "poor" way where the things are from.
 * note the use of the "constant" name assigned to the active Document in = ; active Document is not a "constant" in a strict sense, but in a "semantical"  way is our "active Document", that for our use is a proper "constant" so the Python convention to use the  "ALL CAPS" name for "constants", not to mention that  is much shorten than.
 * every method returns a geometry, this became clear in the continuation of the page.
 * geometry didn't have the property, when using the simple geometries to make more complex geometry, managing  is a ankward thing.

Now what to do with this geometries?

Let's introduce boolean opearations. As a starter example put these lines after, this create a method for a Fusion also know as Union operation:

Nothing exceptional also here, note however the uniformity of the methd building; This approach is more linear that those seen around other tutorial on scripting, this "linearity" help greatly in readability and also with cut-copy-paste operations.

Modify the line below the method after the section

Lanciamo con il tasto freccia della barra strumenti macro e otteniamo:



Posizionamento
Il concetto è relativamente complesso, vedere il Tutorial aeroplano per una trattazione più sistematica.

Possiamo aver bisogno di posizionare una geometria in una posizione relativa ad un'altra geometria, cosa abbastanza frequente, il modo più comune è usare la proprietà  della geometria.

Ovviamente le possibilità su come specificare questa proprietà sono molte, alcune complesse da capire, questa scrittura della proprietà, soprattutto per quanto riguarda la parte è in linea con quanto spiegato nel Tutorial citato e sembra la più gestibile.

Esiste sempre un punto di criticità, che è il punto di riferimento della costruzione, cioè il punto in base al quale è costruito l'oggetto, come descritto in questa tabella, copiata da Posizionamento:

Queste informazioni sono da tenere ben presente quando volete applicare una rotazione.

Facciamo qualche esempio, cancellate tutte le righe dopo il metodo ed inserite queste righe:

Analizziamo il codice:


 * Abbiamo definito un metodo per creare una sfera, abbiamo usato la definizione più semplice, definendo solo il raggio.
 * Abbiamo introdotto una seconda forma per l'Unione quella multipla, niente di speciale, notate solo che alla proprietà abbiamo passato una tupla
 * Abbiamo definito una forma complessa, in modo "parametrico", cioè definendo alcuni parametri e mettendo delle formule che calcolano in modo automatico molti dei valori da passare alla geometria finale.
 * Abbiamo usato prima di ritornare l'oggetto un posizionamento usando la poprietà e il vettore finale del gruppo che definisce il centro di rotazione, secondo la scrittura Yaw-Pitch-Roll

Potete facilmente notare che l'aereo ruota attorno al suo "baricentro" che ho fissato nel centro delle ali, in modo che la rotazione sia relativamente "naturale".

Notiamo però che se usiamo l'interfaccia grafica e visualizziamo la proprietà abbiamo i dati che abbiamo inserito, questo significa che ogni modifica della proprietà modificherà il posizionamento della geometria, l'osservazione sarà importante nel proseguimento del discorso.

Alla prossima!