Python scripting tutorial/it

Python è un linguaggio di programmazione, molto semplice da usare e molto veloce da imparare.

È open-source, multi-piattaforma, e può essere usato da solo per una vasta gamma di cose, sia per semplici script che per programmi molto complessi.

Uno dei suoi usi più frequenti è sicuramente come linguaggio di script poiché è facile da incorporare in altre applicazioni. Questo è esattamente il modo in cui viene utilizzato all'interno di FreeCAD.

Dalla console di Python, o tramite script personali, è possibile pilotare FreeCAD e fargli eseguire azioni molto complesse per le quali non esiste ancora lo strumento per l'interfaccia grafica utente.

Ad esempio, tramite uno script Python, è possibile:
 * creare nuovi oggetti
 * modificare gli oggetti esistenti
 * modificare la rappresentazione 3D degli oggetti
 * modificare l'interfaccia di FreeCAD

Ci sono anche altri modi per utilizzare Python in FreeCAD:
 * Tramite l'Interprete di Python in FreeCAD, dove è possibile inviare semplici comandi come si fa in una interfaccia di tipo "linea di comando"
 * Tramite le macro, che sono un modo pratico per aggiungere rapidamente all'interfaccia di FreeCAD uno strumento mancante
 * Tramite degli script esterni, che possono essere utilizzati per programmare le cose molto complesse, ad esempio, creare completi Ambienti di lavoro.

In questo tutorial, lavoreremo su un paio di esempi semplici per consentire a tutti di iniziare, ma in questo wiki è disponibile anche molta altra documentazione sugli script Python.

Per chi non conosce ancora Python, ma è interessato a capire come funziona, c'è anche una Introduzione a Python per una formazione di base.

Importante! Prima di iniziare gli esercizi di script Python, andare nel menu Modifica → Preferenze → Generali → Finestra di Output e attivare queste due caselle: Poi dal menu principale andare in Visualizza → Pannelli e attivare: Questo vi farà risparmiare molti problemi!
 * Reindirizzare l'output interno di Python nella vista report
 * Reindirizzare gli errori interni di Python alla finestra di report
 * Report

Scrivere un codice Python
In FreeCAD, ci sono due modi semplici per scrivere un codice Python: Tramite la console di Python (disponibile con Visualizza → Pannelli → Console Python) oppure tramite l'editor delle Macro (Strumenti → Macro).

Nella console, si scrivono i comandi Python uno per uno (riga per riga), e questi vengono eseguiti quando si preme Invio, mentre le macro possono contenere uno script più complesso fatto di diverse righe, e i comandi vengono eseguiti solo quando viene eseguita la macro.



In questo tutorial si utilizzeranno entrambi i metodi, sia il copia/incolla di ogni riga, una per una, nella console Python seguito da dopo ogni riga, sia il copia/incolla dell'intero codice in una nuova finestra Macro.

Esplorare FreeCAD
Iniziamo creando un nuovo documento vuoto:

Quando si digita questo nella console Python di FreeCAD si nota che, non appena si digita "FreeCAD", si apre una finestra che consente di auto-completare rapidamente il resto della riga.

In più, ogni voce dell'elenco di completamento automatico possiede un testo di aiuto che la descrive. Questo rende molto facile esplorare le funzionalità disponibili.

Prima di scegliere "newDocument", date un'occhiata alle altre opzioni disponibili.



Ora verrà creato il nostro nuovo documento. Questo equivale alla pressione sul pulsante "nuovo documento" della barra degli strumenti.

In effetti, la maggior parte dei pulsanti di FreeCAD non fa altro che eseguire una o due righe di codice Python.

Meglio ancora, in Modifica → Preferenze → Generale → Macro è possibile attivare l'opzione "mostra lo script dei comandi nella console Python". Questo visualizzerà nella console tutto il codice Python che viene eseguito quando si premono i vari pulsanti. E' molto utile per imparare a riprodurre le azioni in codice Python.

Ora torniamo al nostro documento. Vediamo cosa possiamo fare con esso:

Esploriamo le opzioni disponibili.

Di solito i nomi che iniziano con la lettera maiuscola sono attributi e contengono un valore, mentre i nomi che iniziano con la lettera minuscola sono funzioni (chiamate anche metodi) e "fanno qualcosa".

I nomi che iniziano con un carattere di sottolineatura di solito sono lì per il funzionamento interno del modulo e non dobbiamo preoccuparci di loro.

Usiamo ora uno dei metodi per aggiungere un nuovo oggetto al nostro documento:

Non succede nulla. Perché? Perché FreeCAD è pensato per realizzare lavori molto complessi.

In futuro, lavorerà con centinaia di oggetti complessi, tutti dipendenti l'uno dall'altro.

Apportare una piccola modifica da qualche parte potrebbe avere un grande impatto, potrebbe essere necessario ricalcolare l'intero documento, operazione che potrebbe richiedere molto tempo ... Per questo motivo, quasi nessun comando aggiorna la scena automaticamente. È necessario farlo manualmente:

Visto? Ora il box è apparso! Molti dei pulsanti che aggiungono oggetti in FreeCAD in realtà fanno 2 cose: aggiungere l'oggetto, e ricalcolare.

Se l'opzione "mostra lo script dei comandi nella console Python" di cui sopra è attivata, provate ad aggiungere una sfera con il pulsante della GUI e vedrete le due righe di codice python che vengono eseguite una dopo l'altra.

E oltre a "Part :: Box"? Come posso sapere quali altri tipi di oggetti possono essere aggiunti? Sono tutti qui:

Ora esploriamo le caratteristiche del nostro box:

Si possono vedere subito un paio di cose molto interessanti quali:

Questo comando stampa l'altezza corrente del nostro box. Ora proviamo a cambiarla:

Se selezionamo il box con il mouse, nella scheda "Dati", del pannello delle proprietà, ora appare il valore della nostra proprietà "Altezza".

Tutte le proprietà di un oggetto di FreeCAD che appaiono qui (e anche nella scheda "Vista", di cui parleremo più avanti), sono anche accessibili direttamente tramite Python, tramite i loro nomi, come abbiamo fatto con la proprietà "Altezza".

Provate a cambiare le altre dimensioni del box.

Vettori e posizionamenti
I vettori sono un concetto fondamentale in qualsiasi applicazione 3D. Si tratta di un elenco di 3 numeri (x, y, z) che descrivono un punto o una posizione nello spazio 3D.

Con i vettori si possono eseguire diverse operazioni, ad esempio, sommarli, sottrarli, proiettarli e molto altro.

In FreeCAD, con i vettori si lavora in questo modo:

Un'altra caratteristica comune degli oggetti FreeCAD è la loro collocazione nello spazio, (accessibile dalla scheda Vista combinata → Proprietà → Dati → Placement,, oppure tramite il menu  Modifica → Posizionamento...).

Ogni oggetto possiede alcuni attributi di posizionamento, che contengono la posizione (Base) e l'orientamento (Rotation) dell'oggetto. Questi attributi si manipolano facilmente, ad esempio, per spostare il nostro oggetto:

Prima di continuare, si devono vedere un paio di concetti importanti.

App e Gui
FreeCAD è stato inizialmente creato per lavorare come applicazione a riga di comando, senza la sua attuale interfaccia utente. Di conseguenza, quasi tutto viene separato in una componente "geometria" e una componente "vista".

Quando si lavora in modalità riga di comando, la parte geometria è presente, ma tutta la parte di visualizzazione è semplicemente disabilitata. Quindi, in FreeCAD, quasi tutti gli oggetti si compongono di due parti, una parte Object e una parte ViewObject.

Per illustrare il concetto, consideriamo il nostro oggetto cubo, le proprietà geometriche del cubo, come ad esempio le sue dimensioni, posizione, ecc .. sono memorizzate in Object, mentre le sue proprietà di visualizzazione, come il suo colore, spessore della linea, ecc .. sono memorizzati in ViewObject. Ciò corrisponde alle schede "Dati" e "Vista" nella finestra delle proprietà.

Alla parte ViewObject di un oggetto si accede in questo modo:

Ora è anche possibile modificare le proprietà della scheda "Vista":

Quando si avvia FreeCAD, la console python carica 2 moduli base: FreeCAD e FreeCADGui (a cui si può accedere anche dai collegamenti App e Gui). Essi contengono tutti i tipi di funzionalità generiche per lavorare con i documenti ed i loro oggetti.

Per illustrare questo concetto: notare che FreeCAD e FreeCADGui contengono entrambi un attributo ActiveDocument, che è il documento attualmente aperto.

FreeCAD.ActiveDocument e FreeCADGui.ActiveDocument non sono la stessa cosa. Essi sono i due componenti di un documento FreeCAD, e contengono attributi e metodi diversi. Ad esempio, FreeCADGui.ActiveDocument contiene ActiveView che è la vista 3D attualmente attiva.

Moduli
Ora vi starete sicuramente chiedendo che cosa si possa ancora fare con "Part:: Box".

L'applicazione di base di FreeCAD è più o meno un contenitore vuoto. Senza i suoi moduli, può fare poco più che creare nuovi documenti vuoti. La vera potenza di FreeCAD è nei suoi affidabili moduli.

Ogni modulo non solo aggiunge all'interfaccia nuovi ambienti di lavoro, ma aggiunge anche nuovi comandi Python e nuovi tipi di oggetti. Di conseguenza, nello stesso documento possono coesistere diversi tipi di oggetti, compresi anche oggetti totalmente incompatibili.

I moduli principali di FreeCAD, che vederemo in questo tutorial, sono Parte, Mesh, Schizzo e Draft.

I moduli Schizzo e Draft utilizzano entrambi il modulo Parte per creare e gestire le loro geometrie, che sono geometrie B-Rep, mentre il modulo Mesh è totalmente indipendente, e gestisce autonomamente i propri oggetti. In seguito saranno fornite ulteriori informazioni.

È possibile sapere quali tipi di oggetti di base sono disponibili per il documento corrente in questo modo:

I diversi moduli di FreeCAD, anche se hanno aggiunto a FreeCAD i loro tipi di oggetti, non sono caricati automaticamente nella console Python. Questo per evitare di avere un avvio molto lento. I moduli vengono caricati solo quando servono. Quindi, per esempio, per esplorare l'interno del modulo Parte:

Ma parleremo più avanti del modulo Parte.

Ora, si conosce qualcosa in più sui diversi moduli di FreeCAD: I moduli principali (FreeCAD, FreeCADGui) e i moduli degli ambienti di lavoro (Parte, Mesh, Schizzo). Gli altri moduli importanti sono il modulo della scena 3D (pivy) e il modulo dell'interfaccia (PySide), in seguito parleremo anche di loro.

Ora è il momento di esplorare un po' in profondità i moduli più importanti, cioè quelli degli ambienti di lavoro.

Mesh
I Mesh sono un tipo molto semplice di oggetti 3D, utilizzati ad esempio da Sketchup, Blender o 3D studio Max. Essi sono composti da 3 elementi: i punti (chiamati anche vertici), le linee (chiamate anche bordi) e le facce. In molte applicazioni, inclusa FreeCAD, le facce possono avere solo tre vertici. Naturalmente nulla impedisce di avere una faccia piana più grande composta da diverse facce triangolari complanari.

Gli oggetti mesh (grigliati) sono semplici, questa può essere una cosa negativa, ma per molte applicazioni, ad esempio quelle indicate prima, risulta invece essere un vantaggio, perché sono così semplici che si può facilmente averne milioni in un unico documento.

In FreeCAD sono poco usati, e lo sono per lo più per importare oggetti in formato mesh (.Stl, .Obj) da altre applicazioni. Comunque sono stati ampiamente utilizzati come principale modulo di test nel primo mese di vita di FreeCAD.

Gli oggetti mesh e gli oggetti FreeCAD sono cose diverse. Si può pensare l'oggetto FreeCAD come un contenitore per un oggetto Mesh (e, come vedremo più avanti, anche per gli oggetti Parte). Quindi, per aggiungere un oggetto mesh in FreeCAD, dobbiamo prima creare un oggetto FreeCAD e un oggetto Mesh, poi aggiungere l'oggetto Mesh all'oggetto FreeCAD:

Questo è un esempio standard, che utilizza il metodo createSphere per creare automaticamente una sfera, ma si può benissimo creare propri oggetti mesh da uno schizzo, definendo i loro vertici e facce.

Per ulteriori informazioni leggere Script per Mesh...

Parte
Il Modulo Parte è il modulo più potente di tutto FreeCAD. Permette di creare e manipolare oggetti BRep. Gli oggetti di questo tipo, a differenza dei mesh, possono avere un'ampia varietà di componenti.

In breve, BRep significa Boundary Representation. Questo significa che essi sono definiti dalle loro superfici, che racchiudono e definiscono un volume interno. Queste superfici possono essere varie cose, come facce piane o superfici NURBS molto complesse. Essi inoltre incorporano il concetto di volume.

Il modulo Parte si basa sulla potente libreria OpenCasCade, che permette di eseguire facilmente sugli oggetti una vasta gamma di operazioni complesse, come le operazioni booleane, gli arrotondamenti, loft, ecc ..

Il modulo Parte funziona allo stesso modo del modulo Mesh: Si crea un oggetto FreeCAD, un oggetto Parte, quindi si aggiunge l'oggetto Parte all'oggetto FreeCAD:

Il modulo Parte (come il modulo Mesh) ha anche un comando veloce che crea automaticamente un oggetto FreeCAD e gli attribuisce una forma, in questo modo è possibile evitare le 3 ultime righe dell'esempio precedente:

Esplorando il contenuto di myShape, noterete che sono disponibili vari sotto-componenti interessanti quali Facce, Bordi, Vertici, Solidi o Superfici, e una vasta gamma di operazioni geometriche come taglio (sottrazione), comune (intersezione) o fusione (unione). La pagina Script di dati topologici spiega tutto questo in modo dettagliato.

Approfondimento sugli script in Parte...

Draft
FreeCAD offre altri moduli, quali Schizzo o Draft, che creano anche loro degli oggetti Parte, ma vi aggiungono dei parametri, o usano un modo diverso per gestire la geometria della Parte.

Il box del nostro precedente esempio è un esempio di perfetto oggetto parametrico.

Per definire il box, basta specificare solo pochi parametri, quali altezza, larghezza e lunghezza. Sulla base di questi dati, l'oggetto calcolerà automaticamente la sua forma Parte. FreeCAD consente di creare questi oggetti con Python.

Il Modulo Draft aggiunge un paio di tipi di oggetti 2D parametrici (che sono tutti oggetti di Parte) quali linee e cerchi, e fornisce anche alcune funzioni generiche che funzionano non solo sugli oggetti creati con Draft, ma su qualsiasi oggetto Parte. Per esplorare ciò che è disponibile, fare semplicemente:

Interfaccia
L'interfaccia utente di FreeCAD è realizzata con Qt, un potente sistema di interfaccia grafica, responsabile del disegno e della gestione di tutti i comandi, dei menu, delle barre degli strumenti e dei pulsanti per la vista 3D.

Qt offre un modulo, chiamato PySide, che consente a Python di accedere e modificare le interfacce Qt, come quella di FreeCAD.

Proviamo a giocherellare con l'interfaccia Qt e produrre una semplice finestra di dialogo:

Notate che la finestra di dialogo che appare contiene l'icona di FreeCAD nella sua barra degli strumenti, questo significa che Qt sa che l'ordine è stato emesso all'interno dell'applicazione FreeCAD. Quindi si può con facilità e manipolare direttamente qualsiasi parte dell'interfaccia di FreeCAD.

Qt è un sistema di interfaccia molto potente, che permette di fare cose molto complesse, inoltre dispone anche di vari strumenti molto facili da usare, come il Qt Designer con il quale è possibile progettare graficamente le finestre di dialogo e poi aggiungerle all'interfaccia di FreeCAD con poche righe di codice Python.

Quì si trovano altre informazioni su PySide...

Macro
Ora che avete una buona conoscenza delle nozioni di base, dove conserviamo i nostri script Python, e come facciamo per eseguirli facilmente in FreeCAD? Per questo vi è un sistema semplice, chiamato Macro.

Una macro è semplicemente uno script Python, che può essere aggiunto a una barra degli strumenti e poi essere lanciato con un semplice clic del mouse.

FreeCAD fornisce un semplice editor di testo (Macro → Macro → Crea) in cui è possibile scrivere o incollare degli script. Terminata la scrittura, il menu Strumenti → Personalizza → Macro permette di definire un pulsante per questo script che può anche essere aggiunto alle barre degli strumenti.

Ora siete pronti per approfondire le conoscenze sull'uso degli script in FreeCAD.

Dirigetevi al Centro degli utenti esperti!