Pivy/fr: Difference between revisions

From FreeCAD Documentation
mNo edit summary
(Updating to match new version of source page)
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{docnav/fr|[[Scenegraph/fr|Graph de scène]]|[[PySide/fr|PySide]]}}


{{Docnav/fr
[https://bitbucket.org/Coin3D/pivy/src/default/ Pivy] est une bibliothèque de codes qui sert de passerelle entre Python et [https://bitbucket.org/Coin3D/coin/wiki/Home Coin3d], la bibliothèque 3D de [[Scenegraph/fr|rendu graphique]] utilisé dans FreeCAD. Lors de l'importation dans l'interpréteur Python, Pivy permet de dialoguer immédiatement avec les procédures de Coin3d, tels que les vue3D, ou même d'en créer de nouvelles.<br />
|[[Scenegraph/fr|Graphe de scène]]
Pivy est inclus d'origine dans l'installation FreeCAD.
|[[PySide/fr|PySide]]
}}

{{TOCright}}

==Introduction==

<div class="mw-translate-fuzzy">
[[Pivy/fr|Pivy]] est une bibliothèque de liaison [[Python/fr|Python]] pour [https://github.com/coin3d Coin], la bibliothèque de rendu 3D utilisée dans FreeCAD pour afficher des éléments dans la [[3D_view/fr|3D vue]]. Lorsqu'il est importé dans un interpréteur Python en cours d'exécution, Pivy nous permet de communiquer directement avec n'importe quel Coin en cours d'exécution de la [[Scenegraph/fr|Scène graphique]], tel que la [[3D_view/fr|3D vue]] ou même d'en créer de nouveaux. Pivy n'est pas requis pour compiler FreeCAD mais il est requis lors de l'exécution lors de l'exécution d'établissements basés sur Python qui créent des formes à l'écran, comme l'[[Draft_Module/fr|atelier Draft]] et l'[[Arch_Module/fr|atelier Arch]]. Pour cette raison, Pivy est normalement installé lors de l'installation d'une distribution de FreeCAD.
</div>

<div class="mw-translate-fuzzy">
La bibliothèque Coin est divisée en plusieurs morceaux, Coin lui-même pour manipuler les scénarios et les liaisons pour plusieurs systèmes GUI, tels que Windows ou Qt. Ces modules sont également disponibles pour Pivy, selon qu'ils sont présents sur le système. Le module Coin est toujours présent, et c'est ce que nous utiliserons de toute façon, puisque nous n'aurons pas besoin de nous soucier d'ancrer notre affichage 3D dans n'importe quelle interface, cela est déjà fait par FreeCAD lui-même. Tout ce que nous devons faire est le suivant:
</div>


La bibliothèque d'outils est divisée en plusieurs parties,
* '''coin:''' pour manipuler formes graphiques (projet) et gérer le système graphique (GUI), tels que plusieurs fenêtres ou, dans notre cas,
* '''qt :''' pour les interfaces.<br />
Ces modules sont aussi accessibles à pivy, s'ils sont présents sur le système bien sûr.<br />
Le module '''coin''' est toujours présent, et de toute façon c'est lui que nous allons utiliser, nous n'aurons pas besoin de nous occuper de l'affichage 3D dans une interface, FreeCAD s'en occupe lui-même.<br />
Tout ce que nous aurons à faire, c'est:
{{Code|code=
{{Code|code=
from pivy import coin
from pivy import coin
}}
}}

<div class="mw-translate-fuzzy">
==Accéder et modifier une scène graphique==
==Accéder et modifier une scène graphique==
</div>


<div class="mw-translate-fuzzy">
Nous avons vu dans la page [[Scenegraph/fr|Scenegraph]] comment coin organise une scène. Tout ce qui est affiché en 3D dans FreeCAD est construit et géré par '''coin'''.<br /> Nous avons une '''racine''', et tous les objets sur l'écran sont ses '''enfants''', reliés par des '''nodes''' (noeuds). Les enfants aussi peuvent avoir une descendance.
Nous avons vu dans la page [[Scenegraph/fr|Scène graphique]] comment une scène Coin typique est organisée. Tout ce qui apparaît dans une [[3D view/fr|vue 3D]] est une Scène graphique Coin organisée de la même manière. Nous avons un nœud racine et tous les objets à l'écran sont ses enfants.
</div>


FreeCAD a un moyen facile d'accéder a la racine d'une scène 3D:
FreeCAD a un moyen facile d'accéder a la racine d'une scène 3D:

{{Code|code=
{{Code|code=
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
print sg
print(sg)
}}
}}

La racine de la scène 3D sera:
La racine de la scène 3D sera:

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

Vous pouvez inspecter immédiatement les enfants (branches) de la scène 3D:
Vous pouvez inspecter immédiatement les enfants (branches) de la scène 3D:

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

Certains de ces nodes, comme '''SoSeparators''' ou '''SoGroups''', peuvent avoir des enfants eux-mêmes. La liste complète des '''coin objets''' disponibles peut être trouvée dans la documentation [https://coin3d.bitbucket.io/Coin/annotated.html official coin documentation].
<div class="mw-translate-fuzzy">
Certains de ces nœuds, tels que SoSeparators ou SoGroups, peuvent avoir eux-mêmes des enfants. La liste complète des objets Coin est disponible dans la documentation officielle des Coin.
</div>


Maintenant essayons d'ajouter quelque chose à notre scène (projet).<br />
Maintenant essayons d'ajouter quelque chose à notre scène (projet).<br />
Nous allons ajouter un beau cube rouge:
Nous allons ajouter un beau cube rouge:

{{Code|code=
{{Code|code=
col = coin.SoBaseColor()
col = coin.SoBaseColor()
col.rgb=(1,0,0)
col.rgb = (1, 0, 0)
cub = coin.SoCube()
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode = coin.SoSeparator()
Line 45: Line 66:
sg.addChild(myCustomNode)
sg.addChild(myCustomNode)
}}
}}

<div class="mw-translate-fuzzy">
et voici notre (beau) cube rouge.<br />
et voici notre (beau) cube rouge.<br />
Maintenant, nous allons essayer ceci:
Maintenant, nous allons essayer ceci:
</div>

{{Code|code=
{{Code|code=
col.rgb=(1,1,0)
col.rgb = (1, 1, 0)
}}
}}

<div class="mw-translate-fuzzy">
Vu ? Tout est encore accessible et modifiable à la volée.<br />
Vu ? Tout est encore accessible et modifiable à la volée.<br />
Pas besoin de recalculer ou redessiner quoi que ce soit, '''coin''' s'occupe de tout. Vous pouvez ajouter ce que vous voulez à votre scène (projet), propriétés de changements, cacher des objets, montrer des objets temporairement, faire n'importe quoi.<br />
Pas besoin de recalculer ou redessiner quoi que ce soit, '''coin''' s'occupe de tout. Vous pouvez ajouter ce que vous voulez à votre scène (projet), propriétés de changements, cacher des objets, montrer des objets temporairement, faire n'importe quoi.<br />
Bien sûr, cela ne concerne que l'affichage de la vue 3D. L'affichage du document ouvert est recalculé par FreeCAD, et recalcule un objet quand il a besoin de l'être.<br />
Bien sûr, cela ne concerne que l'affichage de la vue 3D. L'affichage du document ouvert est recalculé par FreeCAD, et recalcule un objet quand il a besoin de l'être.<br />
Donc, si vous changez l'aspect d'un objet existant dans FreeCAD, ces modifications seront perdues si l'objet est recalculé, ou lorsque vous rouvrez le fichier.
Donc, si vous changez l'aspect d'un objet existant dans FreeCAD, ces modifications seront perdues si l'objet est recalculé, ou lorsque vous rouvrez le fichier.
</div>


<div class="mw-translate-fuzzy">
Un truc, pour travailler avec scenegraphs dans vos scripts, vous pouvez, lorsque c'est nécessaire accéder à certaines propriétés des nodes que vous avez ajoutés.<br />
Un truc, pour travailler avec scenegraphs dans vos scripts, vous pouvez, lorsque c'est nécessaire accéder à certaines propriétés des nodes que vous avez ajoutés.<br />
Par exemple, si nous voulions faire évoluer notre cube, nous aurions ajouté un '''node SoTranslation''' à notre node personnalisé et,<br />
Par exemple, si nous voulions faire évoluer notre cube, nous aurions ajouté un '''node SoTranslation''' à notre node personnalisé et,<br />
il aurait ressemblé à ceci:
il aurait ressemblé à ceci:
</div>

{{Code|code=
{{Code|code=
col = coin.SoBaseColor()
col = coin.SoBaseColor()
col.rgb=(1,0,0)
col.rgb=(1, 0, 0)
trans = coin.SoTranslation()
trans = coin.SoTranslation()
trans.translation.setValue([0,0,0])
trans.translation.setValue([0, 0, 0])
cub = coin.SoCube()
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode = coin.SoSeparator()
myCustomNode.addChild(col)
myCustomNode.addChild(col)
mtCustomNode.addChild(trans)
myCustomNode.addChild(trans)
myCustomNode.addChild(cub)
myCustomNode.addChild(cub)
sg.addChild(myCustomNode)
sg.addChild(myCustomNode)
}}
}}

<div class="mw-translate-fuzzy">
Souvenez-vous que dans une scène graphique '''OpenInventor''', l'ordre est très important. Un noeud affecte ce qui suit, de sorte que, si vous dites: couleur rouge, cube, couleur jaune, sphère ! vous obtiendrez un cube rouge et une sphère jaune.<br />
Souvenez-vous que dans une scène graphique '''OpenInventor''', l'ordre est très important. Un noeud affecte ce qui suit, de sorte que, si vous dites: couleur rouge, cube, couleur jaune, sphère ! vous obtiendrez un cube rouge et une sphère jaune.<br />
Si nous traduisons maintenant notre noeud personnalisé, il vient après le cube, et ne l'affecte pas.<br />
Si nous traduisons maintenant notre noeud personnalisé, il vient après le cube, et ne l'affecte pas.<br />
Si nous l'avions inséré lors de sa création, comme l'exemple ci-dessus,<br />
Si nous l'avions inséré lors de sa création, comme l'exemple ci-dessus,<br />
nous pourrions faire maintenant:
nous pourrions faire maintenant:
</div>

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

Et notre cube sauterait de 2 unités vers la droite.<br />
<div class="mw-translate-fuzzy">
Enfin, pour supprimer quelque chose, nous ferons:
Et notre cube sauterait de 2 unités vers la droite. Enfin, pour supprimer quelque chose, nous ferons:
</div>

{{Code|code=
{{Code|code=
sg.removeChild(myCustomNode)
sg.removeChild(myCustomNode)
}}
}}

[[#top|top]]

<div class="mw-translate-fuzzy">
==Utilisation des mécanismes de rappel (callback)==
==Utilisation des mécanismes de rappel (callback)==
</div>


<div class="mw-translate-fuzzy">
Un [http://fr.wikipedia.org/wiki/Fonction_de_rappel mécanisme de rappel] est un système qui permet à la bibliothèque que vous utilisez, comme notre bibliothèque '''coin''' de faire un rappel comme, rappeler une certaine fonction pour l'Objet Python en cours d'exécution.<br />
Un [http://fr.wikipedia.org/wiki/Fonction_de_rappel mécanisme de rappel] est un système qui permet à la bibliothèque que vous utilisez, comme notre bibliothèque '''coin''' de faire un rappel comme, rappeler une certaine fonction pour l'Objet Python en cours d'exécution.<br />
Cela est extrêmement utile, car, de cette manière coin peut vous avertir si un événement particulier survient dans la scène.<br />
Cela est extrêmement utile, car, de cette manière coin peut vous avertir si un événement particulier survient dans la scène.<br />
Coin peut voir des choses très différentes, comme, la position de la souris, les clics sur un bouton de la souris, les touches du clavier qui sont pressées, et bien d'autres choses.
Coin peut voir des choses très différentes, comme, la position de la souris, les clics sur un bouton de la souris, les touches du clavier qui sont pressées, et bien d'autres choses.
</div>


FreeCAD dispose d'un moyen facile pour utiliser ces rappels:
FreeCAD dispose d'un moyen facile pour utiliser ces rappels:

{{Code|code=
{{Code|code=
from pivy import coin

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

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

ButtonTest()
ButtonTest()
}}
}}

<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Le rappel doit être initiée à partir d'un objet, et, cet objet doit '''toujours''' être actif au moment du rappel.<br />
Le rappel doit être initié à partir d'un objet, car cet objet doit toujours être en cours d'exécution lorsque le rappel se produira. Voir aussi une [[Code_snippets/fr#Observation_des_.C3.A9v.C3.A8nements_de_la_souris_dans_la_vue_3D_via_Python|liste complète des événements possibles et leurs paramètres]] ou dans la documentation officielle de Coin.
Voir aussi une [[Code_snippets/fr|liste complète des événements possibles et leurs paramètres]] [[Code_snippets|(en)]], ou dans la [http://doc.coin3d.org/Coin/classes.html documentation officielle de coin].
</div>
</div>


[[#top|top]]
== Documentation ==


==Documentation==
Malheureusement, pivy ne dispose pas encore d'une documentation appropriée, mais puisqu'il s'agit d'une traduction exacte de coin, vous pouvez utiliser en toute sécurité la documentation révérencielle de [http://doc.coin3d.org/Coin/classes.html coin], et utiliser le style Python au lieu du style c ++ ( par exemple '''SoFile::getClassTypeId()''' en c++, serait '''SoFile.getClassId()''' en pivy )


<div class="mw-translate-fuzzy">
{{docnav/fr|[[Scenegraph/fr|Graph de scène]]|[[PySide/fr|PySide]]}}
Malheureusement, Pivy n’a pas sa propre documentation. Cependant, puisqu'il s'agit d'un wrapper de la bibliothèque Coin, vous pouvez lire la référence C++ pour plus d'informations. Dans ce cas, vous devez traduire le style de nommage de la classe C++ comme vous la liriez en Python.
</div>


En C++:
{{Userdocnavi/fr}}


{{Code|code=
[[Category:Poweruser Documentation/fr]]
SoFile::getClassTypeId()
}}

Dans Pivy:

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

<div class="mw-translate-fuzzy">
* [https://github.com/coin3d Coin3d] page d'accueil
* [https://github.com/coin3d/pivy Pivy] page d'accueil
* [https://grey.colorado.edu/coin3d/index.html Coin Documentation] Université du Colorado
* [https://coin3d.bitbucket.io/Coin/index.html Coin Documentation] BitBucket
</div>

[[#top|top]]

{{Docnav/fr
|[[Scenegraph/fr|Graphe de scène]]
|[[PySide/fr|PySide]]
}}


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

Revision as of 22:14, 5 June 2020

Introduction

Pivy est une bibliothèque de liaison Python pour Coin, la bibliothèque de rendu 3D utilisée dans FreeCAD pour afficher des éléments dans la 3D vue. Lorsqu'il est importé dans un interpréteur Python en cours d'exécution, Pivy nous permet de communiquer directement avec n'importe quel Coin en cours d'exécution de la Scène graphique, tel que la 3D vue ou même d'en créer de nouveaux. Pivy n'est pas requis pour compiler FreeCAD mais il est requis lors de l'exécution lors de l'exécution d'établissements basés sur Python qui créent des formes à l'écran, comme l'atelier Draft et l'atelier Arch. Pour cette raison, Pivy est normalement installé lors de l'installation d'une distribution de FreeCAD.

La bibliothèque Coin est divisée en plusieurs morceaux, Coin lui-même pour manipuler les scénarios et les liaisons pour plusieurs systèmes GUI, tels que Windows ou Qt. Ces modules sont également disponibles pour Pivy, selon qu'ils sont présents sur le système. Le module Coin est toujours présent, et c'est ce que nous utiliserons de toute façon, puisque nous n'aurons pas besoin de nous soucier d'ancrer notre affichage 3D dans n'importe quelle interface, cela est déjà fait par FreeCAD lui-même. Tout ce que nous devons faire est le suivant:

from pivy import coin

Accéder et modifier une scène graphique

Nous avons vu dans la page Scène graphique comment une scène Coin typique est organisée. Tout ce qui apparaît dans une vue 3D est une Scène graphique Coin organisée de la même manière. Nous avons un nœud racine et tous les objets à l'écran sont ses enfants.

FreeCAD a un moyen facile d'accéder a la racine d'une scène 3D:

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

La racine de la scène 3D sera:

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

Vous pouvez inspecter immédiatement les enfants (branches) de la scène 3D:

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

Certains de ces nœuds, tels que SoSeparators ou SoGroups, peuvent avoir eux-mêmes des enfants. La liste complète des objets Coin est disponible dans la documentation officielle des Coin.

Maintenant essayons d'ajouter quelque chose à notre scène (projet).
Nous allons ajouter un beau cube rouge:

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

et voici notre (beau) cube rouge.
Maintenant, nous allons essayer ceci:

col.rgb = (1, 1, 0)

Vu ? Tout est encore accessible et modifiable à la volée.
Pas besoin de recalculer ou redessiner quoi que ce soit, coin s'occupe de tout. Vous pouvez ajouter ce que vous voulez à votre scène (projet), propriétés de changements, cacher des objets, montrer des objets temporairement, faire n'importe quoi.
Bien sûr, cela ne concerne que l'affichage de la vue 3D. L'affichage du document ouvert est recalculé par FreeCAD, et recalcule un objet quand il a besoin de l'être.
Donc, si vous changez l'aspect d'un objet existant dans FreeCAD, ces modifications seront perdues si l'objet est recalculé, ou lorsque vous rouvrez le fichier.

Un truc, pour travailler avec scenegraphs dans vos scripts, vous pouvez, lorsque c'est nécessaire accéder à certaines propriétés des nodes que vous avez ajoutés.
Par exemple, si nous voulions faire évoluer notre cube, nous aurions ajouté un node SoTranslation à notre node personnalisé et,
il aurait ressemblé à ceci:

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)

Souvenez-vous que dans une scène graphique OpenInventor, l'ordre est très important. Un noeud affecte ce qui suit, de sorte que, si vous dites: couleur rouge, cube, couleur jaune, sphère ! vous obtiendrez un cube rouge et une sphère jaune.
Si nous traduisons maintenant notre noeud personnalisé, il vient après le cube, et ne l'affecte pas.
Si nous l'avions inséré lors de sa création, comme l'exemple ci-dessus,
nous pourrions faire maintenant:

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

Et notre cube sauterait de 2 unités vers la droite. Enfin, pour supprimer quelque chose, nous ferons:

sg.removeChild(myCustomNode)

top

Utilisation des mécanismes de rappel (callback)

Un mécanisme de rappel est un système qui permet à la bibliothèque que vous utilisez, comme notre bibliothèque coin de faire un rappel comme, rappeler une certaine fonction pour l'Objet Python en cours d'exécution.
Cela est extrêmement utile, car, de cette manière coin peut vous avertir si un événement particulier survient dans la scène.
Coin peut voir des choses très différentes, comme, la position de la souris, les clics sur un bouton de la souris, les touches du clavier qui sont pressées, et bien d'autres choses.

FreeCAD dispose d'un moyen facile pour utiliser ces rappels:

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()

Le rappel doit être initié à partir d'un objet, car cet objet doit toujours être en cours d'exécution lorsque le rappel se produira. Voir aussi une liste complète des événements possibles et leurs paramètres ou dans la documentation officielle de Coin.

top

Documentation

Malheureusement, Pivy n’a pas sa propre documentation. Cependant, puisqu'il s'agit d'un wrapper de la bibliothèque Coin, vous pouvez lire la référence C++ pour plus d'informations. Dans ce cas, vous devez traduire le style de nommage de la classe C++ comme vous la liriez en Python.

En C++:

SoFile::getClassTypeId()

Dans Pivy:

SoFile.getClassId()

top