Scripts/it

Work in progress -- need some revision

Introduzione
Per Scripting si intende l'uso dell'interprete Python interno di FreeCAD per generare oggetti. FreeCAD può essere usato come "ottimo" sostituto di OpenSCAD, perché possiede un vero e proprio interprete Python, con il pieno supporto per tutti i costrutti di un linguaggio di programmazione, quasi tutto quello che si può realizzare con l'interfaccia grafica è possibile realizzarlo anche attraverso uno script Python.

Le informazioni sullo scripting sono però sparse nella documentazione di FreeCAD, non c'è una uniformità di "scritture" e alcune cose sono spiegate in maniera complicata per chi comincia.

Primo assaggio
Purtroppo non esiste un modo per attivare direttamente con un comando di menu od un'icona nella barra degli strumenti, l'editor Python interno a FreeCAD, sapendo però che FreeCAD apre un file con estensione nell'editor Python interno, il trucco più semplice è quello di creare un file usando il proprio editor di testo preferito, poi aprirlo in FreeCAD con.

Per fare le cose con un minimo di stile, lo script deve essere scritto con un certo ordine. L'editor di FreeCAD possiede una decente "evidenziazione di sintassi" che manca a molti editor come Windows Notepad o altri editor di Linux di base, per cominciare basta scrivere queste poche righe:

Salvatele con un nome significativo e con estensione e caricate il file prodotto in FreeCAD, con il comando.

Un esempio minimale ma che contiene tutto quanto necessario per uno script è mostrato in questa porzione di codice, che potete tranquillamente usare come modello per quasi ogni vostro futuro script:

Nel code qui sopra sono presenti alcuni trucchi:


 * Questa linea serve per importare FreeCAD all'interno dell'interprete Python, può sembrare superfluo, ma non lo è.
 * Base e Vector sono molto usati negli script in FreeCAD, importando questi due metodi in questo modo vi evita di scrivere oppure  al posto di   oppure, vi risparmiano quindi molto lavoro di battitura e rendono il codice più compatto.

Cominciamo con un piccolo script che un piccolo lavoro, ma dimostra la potenza di questo approccio.

Mettetelo dopo il codice di esempio e premete la freccia verde della Barra di strumenti Macro

Accadranno alcune magie, si apre un nuovo documento chiamato "Pippo" e si visualizza un cubo nella Vista 3D, che dovrebbe assomigliare all'immagine qui sotto.



Qualcosa di più...
Niente di eccezionale? Vero, ma da qualcosa dobbiamo pure incominciare, possiamo fare la stessa cosa con un cilindro, aggiungete queste linee dopo il metodo e prima della riga.

Anche qui nulla di eccezionale, notiamo alcune nella costruzione del codice:


 * L'assenza degli usuali riferimenti ad, presenti in molta documentazione che parla di scripting, è pienamente voluto, in futuro si potrà riusare il codice per accedere a FreeCAD come un modula da un interprete Python esterno, la cosa non è proprio facilissima da AppImage, ma con qualche accortezza è possibile. Di più facendo riferimento al motto di Python "esplicito è meglio che implicito",  non indica molto bene da dove arrivano i metodi che si usano.
 * Notate l'uso della "costante" DOC assegnata al documento attivo in = ;  ovviamente non è una "costante", ma dal punto di vista semantico è il nostro "documento attivo", da qui l'uso della convenzione di Pyhton del nome "TUTTO MAIUSCOLO" per le "costanti", senza considerare che  è molto pià corto che.
 * ogni metodo ritorna un geometria, questo diventerà importante fra poco.
 * la geometria viene creata senza definire una la proprietà, questo è voluto perché se utilizzando geometrie semplici per creare geometrie più complesse, la gestione della proprietà è una cosa "delicata".

Ora dobbiamo pur farci qualcosa con questi oggetti,

Introduciamo ora le operazioni booleane. Un esempio per cominciare, mettendo queste linee dopo, si crea un metodo che esegue una operazione di "Fusione" conosciuta anche come "Unione":

Anche qui nulla di eccezionale, notate comunque l'uniformità nel metodo di scrittura; Questo approccio è molto più lineare di quello usato in molti altri Tutorial, aiuta molto ad incrementare la leggibilità del codice e anche quando si vuole fare copia e incolla

Usiamo ora queste geometrie, cancellate le linee di codice dopo e inserite queste linee:

Lanciate lo script con la freccia verde e vedrete nella vista 3D, qualcosa che assomiglia all'immagine qui sotto:



Posizionamento
Il concetto di Posizionamento è relativamente complesso, potete vedere Tutorial Aeroplano per una spiegazione più approfondita.

In genere abbiamo bisogno di posizionare una geometria rispetto ad un'altra geometria, cosa abbastanza frequente quando si creano geometrie complesse, il modo più comodo è quello di usare la proprietà della geometria.

FreeCAD offre un'ampia scelta di modi con cui specificare questa proprietà, molto dipende anche dalle conoscenze di fondo dell'utente, quella più facile da comprendere è quella spiegata nel Tutorial citato, usa una particolare definizione della porzione all'interno della definizione di.

Comunque al di sopra di ogni ulteriore considerazione, una cosa è cruciale, il concetto di "punto di riferimento" della geometria. In altri termini, il punto dal quale l'oggetto viene costruito da parte di FreeCAD, riportiamo in questa tabella, copiata direttamente da Placement:

Questa informazione va tenuta ben presente specie quando si applica una rotazione.

Qulche esempio ci aiuterà a capire meglio il concetto, cancellate le linee di codice dopo il metodo ed inserite la porzione di codice qui sotto:

Illustriamo meglio alcuni punti del codice:


 * Abbiamo definito un metodo per creare una sfera, abbiamo usado la definizione più semplice, definendo solo il raggio.
 * Abbiamo introdotto una seconda forma per l'Unione o la Fusione come dir si voglia, quella che permette di fondere più oggetti, niente di speciale rispetto a Part::Fuse viene definita come Part:Multifuse, notate che possiede solo una proprietà dove abbiamo messo una tupla contenente gli oggetti da fondere, avremmo potuto se necessario passare una lista.
 * Abbiamo definito una geometria complessa aeroplano, e lo abbiamo fatto in modo "parametrico", cioè definendo alcuni parametri e calcolando in modo automatico, attraverso la definizione di alcune formule, molti dei valori che definiscono la geometria finale.
 * Abbiamo definito qualche proprietà per i vari componenti base della geometria e abbiamo definito la parte  della proprietà  usando la scrittura Yaw-Pitch-Roll. Notate l'ultimo componente, questo definisce il "centro di rotazione" della geometria finale.

Potete facilmente notare che l'aereo ruota attorno al suo "baricentro" detto anche "centro di gravità", che ho fissato nel centro delle ali, una posizione abbastanza "naturale", potete comunque piazzarlo dove più vi aggrada o vi serve.

Il primo della definizione di  è il vettore di Traslazione (o di posizionamento), che qui non abbiamo usato, se però sostituite  la riga  con le linee seguenti:

Potete leggere nella finestra Report questo testo:

Cosa è successo?

FreeCAD ha "tradotto" il posizionamento passato con, che specificava tre componenti Translazione, Rotazione e centro di rotazione nel suo valore "interno" che possiede solo due componenti, Translazione e Rotazione'.

Potete facilmente inserire nel codice del metodo una istruzione che stampi, e vedrete che vale:

In parole povere, il 'centro di rotazione della geometria è posizionato a, ma non è mostrato attraverso l'interfaccia grafica nella vista Dati, può essere specificato come valore nella proprietà , ma non può essere facilmente recuperato.

Questo è il significato dell'aggettivo "delicato" che ho usato precedentemente nel testo per definire la proprietà.