Pivy/it: Difference between revisions

From FreeCAD Documentation
(Created page with "[http://pivy.coin3d.org/ Pivy] è una libreria che collega Python con [http://www.coin3d.org Coin3d], ed è la libreria di renderizzazione-3D utilizzata da FreeCAD. Quando vie...")
No edit summary
 
(85 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
[http://pivy.coin3d.org/ Pivy] è una libreria che collega Python con [http://www.coin3d.org Coin3d], ed è la libreria di renderizzazione-3D utilizzata da 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.


{{Docnav/it
The coin library is divided into several pieces, coin itself, for manipulating scenegraphs and bindings for several GUI systems, such as windows or, like in our case, qt. Those modules are available to pivy too, depending if they are present on the system. The coin module is always present, and it is what we will use anyway, since we won't need to care about anchoring our 3D display in any interface, it is already done by FreeCAD itself. All we need to do is this:
|[[Scenegraph/it|Grafo della scena]]
<syntaxhighlight>
|[[PySide/it|PySide]]
from pivy import coin
}}
</syntaxhighlight>
==Accessing and modifying the scenegraph==


{{TOCright}}
We saw in the [[Scenegraph]] page how a typical Coin scene is organized. Everything that appears in a FreeCAD 3D view is a coin scenegraph, organized the same way. We have one root node, and all objects on the screen are its children.


<span id="Introduction"></span>
FreeCAD has an easy way to access the root node of a 3D view scenegraph:
==Introduzione==
<syntaxhighlight>
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
print sg
</syntaxhighlight>
This will return the root node:
<syntaxhighlight>
<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >
</syntaxhighlight>
We can inspect the immediate children of our scene:
<syntaxhighlight>
for node in sg.getChildren():
print node
</syntaxhighlight>
Some of those nodes, such as SoSeparators or SoGroups, can have children themselves. The complete list of the available coin objects can be found in the [http://doc.coin3d.org/Coin/classes.html official coin documentation].


[[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.
Let's try to add something to our scenegraph now. We'll add a nice red cube:
<syntaxhighlight>
col = coin.SoBaseColor()
col.rgb=(1,0,0)
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode.addChild(col)
myCustomNode.addChild(cub)
sg.addChild(myCustomNode)
</syntaxhighlight>
and here is our (nice) red cube. Now, let's try this:
<syntaxhighlight>
col.rgb=(1,1,0)
</syntaxhighlight>
See? everything is still accessible and modifiable on-the-fly. No need to recompute or redraw anything, coin takes care of everything. You can add stuff to your scenegraph, change properties, hide stuff, show temporary objects, anything. Of course, this only concerns the display in the 3D view. That display gets recomputed by FreeCAD on file open, and when an object needs recomputing. So, if you change the aspect of an existing FreeCAD object, those changes will be lost if the object gets recomputed or when you reopen the file.


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.
A key to work with scenegraphs in your scripts is to be able to access certain properties of the nodes you added when needed. For example, if we wanted to move our cube, we would have added a SoTranslation node to our custom node, and it would have looked like this:
<syntaxhighlight>
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)
mtCustomNode.addChild(trans)
myCustomNode.addChild(cub)
sg.addChild(myCustomNode)
</syntaxhighlight>
Remember that in an openInventor scenegraph, the order is important. A node affects what comes next, so you can say something like: color red, cube, color yellow, sphere, and you will get a red cube and a yellow sphere. If we added the translation now to our existing custom node, it would come after the cube, and not affect it. If we had inserted it when creating it, like here above, we could now do:
<syntaxhighlight>
trans.translation.setValue([2,0,0])
</syntaxhighlight>
And our cube would jump 2 units to the right.
Finally, removing something is done with:
<syntaxhighlight>
sg.removeChild(myCustomNode)
</syntaxhighlight>
==Using callback mechanisms==


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 è:
A [http://en.wikipedia.org/wiki/Callback_%28computer_science%29 callback mechanism] is a system that permits a library that you are using, such as our coin library, to call you back, that is, to call a certain function from your currently running python object. This is extremely useful, because that way coin can notify you if some specific event occurs in the scene. Coin can watch very different things, such as mouse position, clicks of a mouse button, keyboard keys being pressed, and many other things.


{{Code|code=
FreeCAD features an easy way to use such callbacks:
from pivy import coin
<syntaxhighlight>
}}
class ButtonTest:
def __init__(self):
self.view = FreeCADGui.ActiveDocument.ActiveView
self.callback = self.view.addEventCallbackPivy(SoMouseButtonEvent.getClassTypeId(),self.getMouseClick)
def getMouseClick(self,event_cb):
event = event_cb.getEvent()
if event.getState() == SoMouseButtonEvent.DOWN:
print "Alert!!! A mouse button has been improperly clicked!!!"
self.view.removeEventCallbackSWIG(SoMouseButtonEvent.getClassTypeId(),self.callback)
ButtonTest()
</syntaxhighlight>
The callback has to be initiated from an object, because that object must still be running when the callback will occur.
See also a [[Code_snippets#Observing_mouse_events_in_the_3D_viewer_via_Python|complete list]] of possible events and their parameters, or the [http://doc.coin3d.org/Coin/classes.html official coin documentation].


<span id="Scenegraph"></span>
== Documentation ==
==Grafo della scena==


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.
Unfortunately pivy itself still doesn't have a proper documentation, but since it is an accurate translation of coin, you can safely use the coin documentation as reference, and use python style instead of c++ style (for example SoFile::getClassTypeId() would in pivy be SoFile.getClassId())


FreeCAD dispone di un modo semplice per accedere al nodo radice (root) di una scena grafica in vista 3D:
{{docnav|Scenegraph|PyQt}}


{{Code|code=
[[Category:Poweruser Documentation]]
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
print(sg)
}}


Ciò restituisce il nodo principale (root):
{{clear}}

<languages/>
{{Code|code=
<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >
}}

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

{{Code|code=
for node in sg.getChildren():
print(node)
}}

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.

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

{{Code|code=
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:

{{Code|code=
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 {{incode|SoTranslation}} {{Emphasis|prima}} del cubo:

{{Code|code=
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:

{{Code|code=
trans.translation.setValue([2, 0, 0])
}}

Infine, la rimozione di qualcosa viene eseguita con:

{{Code|code=
sg.removeChild(myCustomNode)
}}
{{Top}}
<span id="Callbacks"></span>
==Il Callback==

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.

FreeCAD fornisce un modo semplice per utilizzare tali callback:

{{Code|code=
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 [[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.
{{Top}}
<span id="Documentation"></span>
==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++:

{{Code|code=
SoFile::getClassTypeId()
}}

In Pivy:

{{Code|code=
SoFile.getClassId()
}}

* [https://github.com/coin3d Coin3D] homepage.
* [https://github.com/coin3d/pivy Pivy] homepage.
* [https://github.com/coin3d/coin/wiki Coin3D wiki], su GitHub.
* [https://github.com/coin3d/coin/wiki/Documentation Coin3D wiki documentation], su GitHub.
* [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.

<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.

* [https://coin3d.bitbucket.io/Coin/index.html Coin3D Documentation], at BitBucket.
* [https://grey.colorado.edu/coin3d/index.html Coin3D Documentation], at University of Colorado.
* [https://mevislabdownloads.mevis.de/docs/current/MeVis/ThirdParty/Documentation/Publish/OpenInventorReference/index.html Open Inventor Reference Documentation], by MeVisLab.
{{Top}}

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

{{Powerdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]

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