Pivy/it: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(29 intermediate revisions by 3 users not shown)
Line 2: Line 2:


{{Docnav/it
{{Docnav/it
|[[Scenegraph/it|Scena grafica]]
|[[Scenegraph/it|Grafo della scena]]
|[[PySide|PySide]]
|[[PySide/it|PySide]]
}}
}}


{{TOCright}}
{{TOCright}}


<span id="Introduction"></span>
==Introduzione==
==Introduzione==


[[Pivy/it|Pivy]] è una libreria di associazione [[Python/it|Python]] per [https://github.com/coin3d Coin], la libreria di rendering 3D utilizzata in FreeCAD per visualizzare gli oggetti nella [[3D_view/it|vista 3D]]. Coin è un'implementazione open source della specifica "Open Inventor" per gestire la grafica. Pertanto, in FreeCAD, i termini "Pivy", "Coin" o "Open Inventor" si riferiscono essenzialmente alla stessa cosa.
<div class="mw-translate-fuzzy">
[https://bitbucket.org/Coin3D/pivy/src/default/ Pivy] è una libreria che collega Python con [https://bitbucket.org/Coin3D/coin/wiki/Home Coin3d], ed è la libreria di renderizzazione-3D utilizzata in FreeCAD. Quando viene importata in un interprete Python in esecuzione, permette di dialogare direttamente con qualsiasi [[Scenegraph/it|grafo di scena]] (scenegraph) di Coin3d in esecuzione, come ad esempio le viste 3D di FreeCAD, o addirittura di creare nuovi grafi di scena. Pivy è incluso nell'installazione standard di FreeCAD.
</div>


When imported in a running Python interpreter, Pivy allows us to communicate directly with any running Coin [[Scenegraph|scenegraph]], such as the [[3D_view|3D view]], or even to create new ones. Pivy is not required to compile FreeCAD, but it is required at runtime when running Python-based workbenches that create shapes on screen, like [[Draft_Workbench|Draft]] and [[Arch_Workbench|Arch]]. Because of this, Pivy is normally installed when installing a distribution of FreeCAD.
Pivy, quando importato in un interprete Python in esecuzione, ci consente di comunicare direttamente con qualsiasi [[Scenegraph/it|scena grafica]] Coin in esecuzione, come la [[3D_view/it|vista 3D]], o anche di crearne di nuove. Pivy non è necessario per compilare FreeCAD, ma è richiesto in fase di esecuzione quando si eseguono ambienti di lavoro basati su Python, che creano forme sullo schermo, come [[Draft_Workbench/it|Draft]] e [[Arch_Workbench/it|Arch]]. Per questo motivo, Pivy viene normalmente installato durante l'installazione di una distribuzione di FreeCAD.


La libreria Coin è divisa in vari moduli, Coin stessa, per manipolare grafi di scene e associarli a diversi sistemi GUI, come Windows e Qt. Se presenti nel sistema, tali moduli sono disponibili anche per Pivy. Il modulo Coin è sempre presente, ed è quello che useremo in tutti gli esempi, e non sarà necessario preoccuparsi di associare la nostra visualizzazione 3D ad alcuna interfaccia, perché questo viene già fatto da FreeCAD stesso. Tutto quello che dobbiamo fare è:
<div class="mw-translate-fuzzy">
La libreria Coin è divisa in vari moduli, Coin stessa, per manipolare grafi di scene e associarli a diversi sistemi GUI, come a Windows oppure, come nel nostro caso, a Qt. Tali moduli sono disponibili anche per Pivy, se sono presenti nel sistema. Il modulo Coin è sempre presente, ed è quello che useremo in tutti gli esempi, e non sarà necessario preoccuparsi di associare la nostra visualizzazione 3D ad alcuna interfaccia, perchè questo viene già fatto da FreeCAD stesso. Tutto quello che dobbiamo fare è:
</div>


{{Code|code=
{{Code|code=
Line 24: Line 21:
}}
}}


<span id="Scenegraph"></span>
<div class="mw-translate-fuzzy">
== Accesso e modifica del Grafo della scena (Scenegraph) ==
==Grafo della scena==
</div>


Abbiamo già visto nella pagina [[Scenegraph/it|Grafo della scena]] (Scenegraph) come è organizzata una tipica scena di Coin. Tutto ciò che appare in una [[3D_view/it|vista 3D]] di FreeCAD è un Scenegraph di Coin, organizzato allo stesso modo. Abbiamo un nodo radice (principale), e tutti gli oggetti sullo schermo sono suoi figli.
<div class="mw-translate-fuzzy">
Abbiamo già visto nella pagina [[Scenegraph/it|Grafo della scena]] (Scenegraph) come è organizzata una tipica scena di Coin. Tutto ciò che appare in una vista 3D di FreeCAD è un Scenegraph di Coin, organizzato allo stesso modo. Abbiamo un nodo radice (principale), e tutti gli oggetti sullo schermo sono suoi figli.
</div>


FreeCAD dispone di un modo semplice per accedere al nodo radice (root) di una scena grafica in vista 3D:
FreeCAD dispone di un modo semplice per accedere al nodo radice (root) di una scena grafica in vista 3D:
Line 52: Line 46:
}}
}}


Alcuni di questi nodi, ad esempio {{incode|SoSeparator}} o {{incode|SoGroup}}, possono avere dei propri figli. L'elenco completo degli oggetti Coin disponibili si può trovare nella documentazione ufficiale di Coin.
<div class="mw-translate-fuzzy">
Alcuni di questi nodi, ad esempio SoSeparators o SoGroups, possono avere dei propri figli. L'elenco completo degli oggetti Coin disponibili si può trovare nella [https://coin3d.bitbucket.io/Coin/annotated.html documentazione ufficiale di Coin].
</div>


Ora proviamo ad aggiungere qualcosa al nostro Scenegraph. Aggiungiamo un bel cubo rosso:
Ora proviamo ad aggiungere qualcosa al nostro Scenegraph. Aggiungiamo un bel cubo rosso:
Line 68: Line 60:
}}
}}


Ora, proviamo questo:
<div class="mw-translate-fuzzy">
e questo è il nostro (bel) cubo rosso. Ora, proviamo questo:
</div>


{{Code|code=
{{Code|code=
Line 76: Line 66:
}}
}}


Come si può notare tutto è sempre accessibile e modificabile al volo. Non c'è bisogno di ricalcolare o ridisegnare nulla, Coin si prende cura di tutto. È possibile aggiungere elementi al grafo di scena, modificare le proprietà, nascondere delle cose, mostrare oggetti temporanei, qualsiasi cosa. Naturalmente, questo riguarda solo la visualizzazione nella vista 3D. Questa visualizzazione viene determinata da FreeCAD all'apertura del file attivo e quando un oggetto ha bisogno di essere ricalcolato. Quindi, se si modifica l'aspetto di un oggetto di FreeCAD esistente, tali modifiche andranno perse se l'oggetto viene ricalcolato o quando si riapre il file.
<div class="mw-translate-fuzzy">
Visto? Tutto è sempre accessibile e modificabile al volo. Non c'è bisogno di ricalcolare o ridisegnare nulla, Coin si prende cura di tutto. È possibile aggiungere elementi al grafo di scena, modificare le proprietà, nascondere delle cose, mostrare oggetti temporanei, qualsiasi cosa. Naturalmente, questo riguarda solo la visualizzazione nella vista 3D. Questa visualizzazione viene determinata da FreeCAD all'apertura del file attivo e quando un oggetto ha bisogno di essere ricalcolato. Quindi, se si modifica l'aspetto di un oggetto di FreeCAD esistente, tali modifiche andranno perse se l'oggetto viene ricalcolato o quando si riapre il file.
</div>


Come già accennato, in uno scenegraph di openInventor l'ordine è importante. Un nodo influisce su ciò che viene dopo. Ad esempio, se vogliamo avere la possibilità di spostare il nostro cubo, dovremo aggiungere un nodo {{incode|SoTranslation}} {{Emphasis|prima}} del cubo:
<div class="mw-translate-fuzzy">
Per lavorare con i grafi di scena nei nostri script è fondamentale saper accedere a specifiche proprietà dei nodi aggiunti quando questo è necessario. Per esempio, se avessimo voluto spostare il nostro cubo, avremmo aggiunto un nodo SoTranslation al nostro nodo personalizzato, e lo script apparirebbe così:
</div>


{{Code|code=
{{Code|code=
Line 97: Line 83:
}}
}}


Per muovere il nostro cubo ora possiamo fare:
<div class="mw-translate-fuzzy">
Ricordate che, in un Scenegraph di OpenInventor, l'ordine è importante. Un nodo riguarda ciò che viene dopo, quindi permette di definire qualcosa come: colore rosso, cubo, colore giallo, sfera, e di ottenere un cubo rosso e una sfera gialla. Se aggiungiamo ora la traslazione al nostro nodo personalizzato esistente, essa viene dopo il cubo, e non lo condiziona. Se lo avessimo inserito durante la creazione, come qui sopra, ora si potrebbe fare:
</div>


{{Code|code=
{{Code|code=
Line 105: Line 89:
}}
}}


Infine, la rimozione di qualcosa viene eseguita con:
<div class="mw-translate-fuzzy">
E il nostro cubo si sposterebbe di 2 unità a destra.

Infine, la rimozione di qualcosa si con:
</div>


{{Code|code=
{{Code|code=
Line 115: Line 95:
}}
}}
{{Top}}
{{Top}}
<span id="Callbacks"></span>
<div class="mw-translate-fuzzy">
==Il Callback==
== Utilizzo dei meccanismi di richiamo (callback) ==
</div>


Un [https://it.wikipedia.org/wiki/Callback meccanismo di callback] è un sistema che permette a una libreria, che si sta utilizzando, come la nostra libreria Coin, di richiamare, cioè, di chiamare una determinata funzione dell'oggetto Python attualmente in esecuzione. In questo modo Coin può avvisarci se nella scena si verifica qualche evento specifico. Coin può controllare cose molto diverse, come la posizione del mouse, i clic di un pulsante del mouse, i tasti della tastiera che vengono premuti e tante altre cose.
<div class="mw-translate-fuzzy">
Un [http://en.wikipedia.org/wiki/Callback_%28computer_science%29 callback mechanism] (meccanismo di richiamo) è un sistema che permette a una libreria che si sta utilizzando, come la nostra libreria Coin, di richiamare, cioè, di chiamare una determinata funzione dell'oggetto Python attualmente in esecuzione. Ciò è estremamente utile, perché in questo modo Coin può avvisarci se nella scena si verifica qualche evento specifico. Coin può controllare cose molto diverse, come la posizione del mouse, i clic di un pulsante del mouse, i tasti della tastiera che vengono premuti e tante altre cose.
</div>


FreeCAD fornisce un modo semplice per utilizzare tali callback:
FreeCAD fornisce un modo semplice per utilizzare tali callback:
Line 142: Line 119:
}}
}}


Il callback deve essere iniziato da un oggetto, perché questo oggetto deve essere ancora in esecuzione quando il callback si verifica.
<div class="mw-translate-fuzzy">
Il richiamo deve essere iniziato da un oggetto, perché questo oggetto deve essere ancora in esecuzione quando il callback si verifica. Vedere anche la [[Code_snippets/it#Observación_de_Eventos_del_ratón_en_el_visor_3D_ a_través_de_Python|lista completa]] degli eventi possibili e dei loro parametri, o la [https://coin3d.bitbucket.io/Coin/index.html documentazione ufficiale di Coin].
Vedere anche la [[Code_snippets/it#Controllare gli eventi del mouse nel visualizzatore 3D tramite Python|lista completa]] di possibili eventi e dei loro parametri, o la documentazione ufficiale di Coin.
</div>
{{Top}}
{{Top}}
<span id="Documentation"></span>
<div class="mw-translate-fuzzy">
== Documentazione ==
==Documentazione==
</div>


<div class="mw-translate-fuzzy">
Purtroppo, Pivy non ha ancora una propria documentazione adeguata, ma dato che è una traduzione esatta di Coin, si può tranquillamente utilizzare la documentazione di Coin come riferimento, e utilizzare lo stile Python al posto dello stile C++.
Purtroppo, Pivy non ha ancora una propria documentazione adeguata, ma dato che è una traduzione esatta di Coin, si può tranquillamente utilizzare la documentazione di Coin come riferimento, e utilizzare lo stile Python al posto dello stile C++.
</div>


In C++:
In C++:
Line 160: Line 133:
}}
}}


In Pivy:
<div class="mw-translate-fuzzy">
In Pivy
</div>


{{Code|code=
{{Code|code=
Line 168: Line 139:
}}
}}


* [https://github.com/coin3d Coin3D] homepage.
<div class="mw-translate-fuzzy">
* [https://grey.colorado.edu/coin3d/index.html Coin Documentation], at University of Colorado
* [https://github.com/coin3d/pivy Pivy] homepage.
* [https://coin3d.bitbucket.io/Coin/index.html Coin Documentation], at BitBucket
* [https://github.com/coin3d/coin/wiki Coin3D wiki], su GitHub.
* [https://github.com/coin3d/coin/wiki/Documentation Coin3D wiki documentation], su GitHub.
</div>
* [https://coin3d.github.io/Coin/html/ Coin3D documentation], ultima documentazione Doxygen generata automaticamente.
* [https://webdocs.cs.ualberta.ca/~graphics/books/mentor.pdf (Open)Inventor Mentor] - raccomandato.


=== Older ===
<span id="Older"></span>
=== Meno recente ===


Questi collegamenti forniscono documentazione di riferimento per Coin v3.x. Le differenze con v4.x sono minime, quindi potrebbero essere comunque utili.
Questi collegamenti forniscono documentazione di riferimento per Coin v3.x. Le differenze con v4.x sono minime, quindi potrebbero essere comunque utili.
Line 183: Line 157:


{{Docnav/it
{{Docnav/it
|[[Scenegraph/it|Scena grafica]]
|[[Scenegraph/it|Grafo della scena]]
|[[PySide|PySide]]
|[[PySide/it|PySide]]
}}
}}



Latest revision as of 17:08, 3 February 2023

Introduzione

Pivy è una libreria di associazione Python per Coin, la libreria di rendering 3D utilizzata in FreeCAD per visualizzare gli oggetti nella vista 3D. Coin è un'implementazione open source della specifica "Open Inventor" per gestire la grafica. Pertanto, in FreeCAD, i termini "Pivy", "Coin" o "Open Inventor" si riferiscono essenzialmente alla stessa cosa.

Pivy, quando importato in un interprete Python in esecuzione, ci consente di comunicare direttamente con qualsiasi scena grafica Coin in esecuzione, come la vista 3D, o anche di crearne di nuove. Pivy non è necessario per compilare FreeCAD, ma è richiesto in fase di esecuzione quando si eseguono ambienti di lavoro basati su Python, che creano forme sullo schermo, come Draft e Arch. Per questo motivo, Pivy viene normalmente installato durante l'installazione di una distribuzione di FreeCAD.

La libreria Coin è divisa in vari moduli, Coin stessa, per manipolare grafi di scene e associarli a diversi sistemi GUI, come Windows e Qt. Se presenti nel sistema, tali moduli sono disponibili anche per Pivy. Il modulo Coin è sempre presente, ed è quello che useremo in tutti gli esempi, e non sarà necessario preoccuparsi di associare la nostra visualizzazione 3D ad alcuna interfaccia, perché questo viene già fatto da FreeCAD stesso. Tutto quello che dobbiamo fare è:

from pivy import coin

Grafo della scena

Abbiamo già visto nella pagina Grafo della scena (Scenegraph) come è organizzata una tipica scena di Coin. Tutto ciò che appare in una vista 3D di FreeCAD è un Scenegraph di Coin, organizzato allo stesso modo. Abbiamo un nodo radice (principale), e tutti gli oggetti sullo schermo sono suoi figli.

FreeCAD dispone di un modo semplice per accedere al nodo radice (root) di una scena grafica in vista 3D:

sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
print(sg)

Ciò restituisce il nodo principale (root):

<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >

Siamo in grado di ispezionare i figli immediati della nostra scena:

for node in sg.getChildren():
    print(node)

Alcuni di questi nodi, ad esempio SoSeparator o SoGroup, possono avere dei propri figli. L'elenco completo degli oggetti Coin disponibili si può trovare nella documentazione ufficiale di Coin.

Ora proviamo ad aggiungere qualcosa al nostro Scenegraph. Aggiungiamo un bel cubo rosso:

col = coin.SoBaseColor()
col.rgb = (1, 0, 0)
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode.addChild(col)
myCustomNode.addChild(cub)
sg.addChild(myCustomNode)

Ora, proviamo questo:

col.rgb = (1, 1, 0)

Come si può notare tutto è sempre accessibile e modificabile al volo. Non c'è bisogno di ricalcolare o ridisegnare nulla, Coin si prende cura di tutto. È possibile aggiungere elementi al grafo di scena, modificare le proprietà, nascondere delle cose, mostrare oggetti temporanei, qualsiasi cosa. Naturalmente, questo riguarda solo la visualizzazione nella vista 3D. Questa visualizzazione viene determinata da FreeCAD all'apertura del file attivo e quando un oggetto ha bisogno di essere ricalcolato. Quindi, se si modifica l'aspetto di un oggetto di FreeCAD esistente, tali modifiche andranno perse se l'oggetto viene ricalcolato o quando si riapre il file.

Come già accennato, in uno scenegraph di openInventor l'ordine è importante. Un nodo influisce su ciò che viene dopo. Ad esempio, se vogliamo avere la possibilità di spostare il nostro cubo, dovremo aggiungere un nodo SoTranslation prima del cubo:

col = coin.SoBaseColor()
col.rgb = (1, 0, 0)
trans = coin.SoTranslation()
trans.translation.setValue([0, 0, 0])
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode.addChild(col)
myCustomNode.addChild(trans)
myCustomNode.addChild(cub)
sg.addChild(myCustomNode)

Per muovere il nostro cubo ora possiamo fare:

trans.translation.setValue([2, 0, 0])

Infine, la rimozione di qualcosa viene eseguita con:

sg.removeChild(myCustomNode)

Inizio

Il Callback

Un meccanismo di callback è un sistema che permette a una libreria, che si sta utilizzando, come la nostra libreria Coin, di richiamare, cioè, di chiamare una determinata funzione dell'oggetto Python attualmente in esecuzione. In questo modo Coin può avvisarci se nella scena si verifica qualche evento specifico. Coin può controllare cose molto diverse, come la posizione del mouse, i clic di un pulsante del mouse, i tasti della tastiera che vengono premuti e tante altre cose.

FreeCAD fornisce un modo semplice per utilizzare tali callback:

from pivy import coin

class ButtonTest:
    def __init__(self):
        self.view = FreeCADGui.ActiveDocument.ActiveView
        self.callback = self.view.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.getMouseClick) 

    def getMouseClick(self, event_cb):
        event = event_cb.getEvent()
        if event.getState() == coin.SoMouseButtonEvent.DOWN:
            print("Alert!!! A mouse button has been improperly clicked!!!")
            self.view.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.callback)

ButtonTest()

Il callback deve essere iniziato da un oggetto, perché questo oggetto deve essere ancora in esecuzione quando il callback si verifica. Vedere anche la lista completa di possibili eventi e dei loro parametri, o la documentazione ufficiale di Coin.

Inizio

Documentazione

Purtroppo, Pivy non ha ancora una propria documentazione adeguata, ma dato che è una traduzione esatta di Coin, si può tranquillamente utilizzare la documentazione di Coin come riferimento, e utilizzare lo stile Python al posto dello stile C++.

In C++:

SoFile::getClassTypeId()

In Pivy:

SoFile.getClassId()

Meno recente

Questi collegamenti forniscono documentazione di riferimento per Coin v3.x. Le differenze con v4.x sono minime, quindi potrebbero essere comunque utili.

Inizio