Code snippets/it

Introduzione
Questa pagina contiene degli esempi di codice Python utilizzabili in FreeCAD, raccolti dalle esperienze degli utenti e dalle discussioni nei forum. Dopo averli letti, è possibile usarli per iniziare a creare degli script personali ...

Snippets


Un tipico file InitGui.py
Ogni modulo deve contenere, oltre al file del modulo principale, un file InitGui.py che ha il compito di inserire il modulo nella finestra grafica principale (GUI).

Questo è un esempio semplice di un file InitGui.py:



Un tipico file del modulo
Il seguente è un esempio di un file del modulo principale. Esso contiene tutto ciò che il modulo deve seguire. È il file Scripts.py richiamato dall'esempio precedente. In esso è possibile inserire tutti i comandi personalizzati.



Importare un nuovo tipo di file
In FreeCAD, è facile creare un importatore per un nuovo tipo di file. FreeCAD non considera che si importano dati in un documento aperto, ma piuttosto che si può semplicemente aprire direttamente il nuovo tipo di file. Quindi, quello che si deve fare è aggiungere la nuova estensione di file alla lista delle estensioni conosciute di FreeCAD, scrivere il codice che legge il file e creare gli oggetti di FreeCAD che si desidera:

Per aggiungere la nuova estensione di file all'elenco si deve aggiungere questa riga al file InitGui.py :

Poi nel file Import_Ext.py:

L'esportazione di un proprio documento in un nuovo tipo di file funziona allo stesso modo, ma si utilizza:

FreeCAD.addExportType("Your new File Type (*.ext)","Export_Ext")



Aggiungere una linea
Una linea ha semplicemente 2 punti.



Aggiungere un poligono
Un poligono è semplicemente un insieme di segmenti di linea collegati tra di loro (una polilinea in AutoCAD). Non è necessario che sia chiuso.



Aggiungere e rimuovere un oggetto in un gruppo
Nota: È anche possibile annidare dei gruppi in altri gruppi e creare dei sottogruppi...



Aggiungere un Mesh


Aggiungere un arco o un cerchio


Accedere alla rappresentazione di un oggetto e modificarla
A ogni oggetto di un documento di FreeCAD è associato un oggetto di rappresentazione della sua vista in cui sono memorizzati tutti i parametri che definiscono il modo in cui l'oggetto deve apparire, come il colore, la larghezza di linea, ecc... Vedere anche lo snippet sottostante Elencare i componenti di un oggetto.

Replace the form of mouse with one image (cross) include
The image is created by Gimp exported in a .XPM file. Copy and use the code between the bracket "{" code to copy  "}"

Observe camera change in the 3D viewer via Python
This can be done adding a Node sensor to the camera.



Controllare gli eventi del mouse nel visualizzatore 3D tramite Python
La struttura di Inventor permette di aggiungere uno o più nodi di richiamo (callback) al grafo di scena (Scenegraph) della vista. In FreeCAD è installato di default un nodo callback per la vista che permette di aggiungere funzioni C++ globali o statiche. In appropriate associazioni Python vengono forniti alcuni metodi per utilizzare questa tecnica all'interno del codice Python.

Ora, cliccate in qualche parte nella zona nella vista 3D e osservate i messaggi nella finestra di output. Per terminare l'osservazione basta chiamare:

Sono supportati i seguenti tipi di eventi:


 * SoEvent -- Tutti i tipi di eventi
 * SoButtonEvent -- Tutti gli eventi del mouse e della tastiera
 * SoLocation2Event -- Eventi di movimento 2D (normalmente i movimenti del mouse)
 * SoMotion3Event -- Eventi di movimento 3D (normalmente di spaceball)
 * SoKeyboardEvent -- Eventi dei tasti alto e basso
 * SoMouseButtonEvent -- Eventi dei pulsanti del mouse verso il basso e verso l'alto
 * SoSpaceballButtonEvent -- Eventi di SpaceBall in basso e in alto

La funzione di Python che può essere registrata con addEventCallback si aspetta una difinizione. Secondo l'evento controllato la definizione può contenere chiavi differenti.

Per tutti gli eventi esistono le seguenti chiavi:


 * Type -- Il nome del tipo di evento, ad esempio SoMouseEvent, SoLocation2Event, ...
 * Time -- L'ora corrente come stringa
 * Position -- Una tupla di due interi, dipendenti dalla posizione del mouse
 * ShiftDown -- un valore booleano, vero (true) se Shift è stato premuto altrimenti false
 * CtrlDown -- un valore booleano, true se è stato premuto Ctrl altrimenti false
 * AltDown -- un valore booleano, true se è stato premuto Alt altrimenti false

Per tutti gli eventi dei pulsanti, ad esempio eventi di tastiera, mouse o spaceball:

Per gli eventi da tastiera:
 * State -- Una stringa 'UP' se il pulsante è verso l'alto, 'DOWN' se è verso il basso o 'UNKNOWN' per tutti gli altri casi

Per gli eventi del pulsante del mouse
 * Key -- Un carattere del tasto premuto

Per gli eventi di Spaceball:
 * Button -- Il pulsante premuto, potrebbe essere BUTTON1, ..., BUTTON5 o ANY

E infine eventi di movimento:
 * Button -- Il pulsante premuto, potrebbe essere BUTTON1, ..., BUTTON7 o ANY


 * Translation -- Una tupla di tre numeri in virgola mobile
 * Rotation -- Un quaternione per la rotazione, cioè una tupla di quattro numeri in virgola mobile



Visualizzare i tasti premuti e gli eventi dei comandi
Questa macro visualizza nel report i tasti premuti e tutti gli eventi dei comandi



Manipolare il grafo della scena in Python
È anche possibile ottenere il Scenegraph (grafo della scena) in Python e modificarlo, con il modulo 'Pivy' - una associazione di Python per Coin.

L'API in Python di Pivy viene creato utilizzando lo strumento SWIG. In FreeCAD si usano alcuni nodi auto-scritti che non è possibile creare direttamente in Python. Tuttavia, è possibile creare un nodo dal suo nome interno. Si può creare una istanza di tipo 'SoFCSelection' con:



Aggiungere e rimuovere oggetti nel grafo della scena
Questo è un modo per aggiungere dei nuovi nodi al Scenegraph. Accertarsi di aggiungere sempre un SoSeparator per contenere la geometria, le coordinate e le informazioni sui materiale di uno stesso oggetto. L'esempio seguente aggiunge una linea rossa da (0,0,0) a (10,0,0):

Per rimuoverla, è sufficiente scrivere:



Salvare il grafo della scena in 3 serie di 36 file
View the code snippet by expanding this section



Aggiungere dei widget personalizzati all'interfaccia
È possibile creare widget personalizzati con Qt designer, trasformarli in uno script Python e poi caricarli nell'interfaccia di FreeCAD con PySide.

Il codice Python prodotto dal compilatore Ui di Python (lo strumento che converte i file .ui di Qt-designer nel codice Python) appare in genere come questo (è semplice, si può anche codificare direttamente in Python):

Dopo, basta creare un riferimento alla finestra Qt di FreeCAD, inserire un widget personalizzato in essa, e "trasformare" questo widget nel proprio con il codice Ui che abbiamo appena creato:



Aggiungere una scheda alla Combo View
Il seguente codice consente di aggiungere una nuova scheda nel pannello Vista combinata di FreeCAD, oltre le schede standard "Modello" e "Azioni". Questo codice utilizza anche il modulo per caricare un file UI direttamente nella nuova scheda.

<span id="Enable_or_disable_a_window">

Abilitare o disabilitare una finestra
This script give the ability to manipulate the UI from the Python console to show/hide different components in the FreeCAD interface such as:
 * Report view
 * Tree view
 * Property view
 * Selection view
 * Combo view
 * Python console
 * draftToolbar

<span id="Open_a_custom_webpage">

Aprire una pagina web personalizzata
<span id="Get_the_HTML_contents_of_an_opened_webpage">

Ottenere il contenuto HTML di una pagina web aperta
<span id="Retrieve_the_coordinates_of_3_selected_points_or_objects">

Reperire le coordinate di 3 punti o oggetti selezionati
<span id="List_all_objects">

Lista di oggetti
<span id="List_the_dimensions_of_an_object,_given_its_name">

Ottenere la dimensione di un oggetto, dato il suo nome
<span id="Function_resident_with_the_mouse_click_action">

Funzione residente per una azione con un clic del mouse
Qui con SelObserver sopra uno obietto selezionato

Altro esempio con ViewObserver sopra uno obbietto selezionato

<span id="Find/select_all_elements_below_the_cursor">

Trovare o selezionare tutti gli elementi sotto il cursore
<span id="List_the_components_of_an_object">

Elencare i componenti di un oggetto
Questa funzione elenca i componenti ed estrae le coordinate XYZ di un oggetto, i bordi (edge) e le loro lunghezze, le sue facce e la loro superficie.

This function list the components of an object and extracts:
 * this object its XYZ coordinates,
 * its edges and their lengths center of mass and coordinates
 * its faces and their center of mass
 * its faces and their surfaces and coordinates

List the PropertiesList
<span id="Add_a_single_Property_Comment">

Aggiungere una singola Proprietà Comment
<span id="Search_and_data_extraction">

Ricerca e estrazione di dati
Esempi di ricerca e decodifica di informazioni su un oggetto.

Ogni sezione separata da "############" è indipendente e può essere copiata direttamente nella console Python, o in una macro o usata come macro a sè stante. La descrizione della macro si trova nel commento.

Le informazioni ricercate in questo modo sono visualizzate nella finestra dei rapporti attivabile con Visualizza -> Viste -> Report

<span id="Manual_search_of_an_element_with_label">

Ricerca manuale di un elemento dall'etichetta
Note: Di solito gli angoli sono espressi in radianti da convertire con:


 * 1) da gradi a radianti :
 * 2) *angolo in radianti = pi * (angolo in gradi) / 180
 * 3) *angolo in radianti = math.radians(angolo in gradi)
 * 4) da radianti a gradi :
 * 5) *angolo in gradi = 180 * (angolo in radianti) / pi
 * 6) *angolo in gradi = math.degrees(angolo in radianti)

<span id="Cartesian_coordinates">

Coordinate cartesiane
Questo codice visualizza le coordinate cartesiane dell'elemento selezionato.

Modificare il valore di "numberOfPoints" se si desidera un diverso numero di punti (modificare la precisione)

Altro metodo per visualizzare "Int" e "Float" (interi e valori in virgola mobile)

<span id="Select_all_objects_in_the_document">

Selezionare tutti gli oggetti nel documento
<span id="Select_a_face_of_an_object_by_Name_object_and_Face_number">

Selezionare una faccia di un oggetto in base a Nome oggetto e Numero faccia
<span id="Get_the_normal_vector_of_a_face_of_an_object_by_Name_object_and_number_Face_(r.Q)">

Get the normal vector of an object selected and number of Face
<span id="Get_the_normal_vector_on_the_surface">

Ottenere il vettore normale alla superficie
Questo esempio mostra come trovare vettore normale alla superficie trovando prima i parametri u, v di un punto sulla superficie e utilizzando poi i parametri u, v per trovare il vettore normale

Get the normal vector of the face and create a line at the point mouse clicked
<span id="Get_the_normal_vector_of_a_surface_from_a_STL_file">

Ottieni il vettore normale di una superficie da un file STL
hai finito quindi fai questo per uscire:

<span id="Create_one_object_to_the_position_of_the_Camera">

Creare un oggetto della posizione della fotocamera
stesso codice semplificato

<span id="Read_And_write_one_Expression">

Create a Sketch on a Surface in PartDesign
This snippet can be useful, if you want to create a sketch on a surface in PartDesign from inside a macro. Note, that body might be None, if no active body is selected and that the Selection might be empty.

How to Simulate a Mouse Click at a given Coordinate
The position is relative to the GL widget. See forum thread.

If you have a 3d point and want to get the 2d point on the opengl widget then use this:

How to create a face with holes using Python API
This snippet demonstrates how to create a face with internal holes through the Python API. See forum thread.

Coin3D
See Coin3d snippets

Correlazioni

 * Oggetti da script
 * Macro