Difference between revisions of "Pivy/fr"

From FreeCAD Documentation
Jump to navigation Jump to search
m
(Created page with "* [https://coin3d.bitbucket.io/Coin/index.html Documentation Coin3D], sur BitBucket. * [https://grey.colorado.edu/coin3d/index.html Coin3D Documentation], à l'Université du...")
 
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<languages/>
 
<languages/>
{{docnav/fr|[[Scenegraph/fr|Graph de scène]]|[[PySide/fr|PySide]]}}
 
  
[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 />
+
{{TOCright}}
Pivy est inclus d'origine dans l'installation FreeCAD.
+
 
 +
==Introduction==
 +
 
 +
[[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 une [[3D_view/fr|3D vue]]. Coin est une implémentation open source de la spécification "Open Inventor" pour gérer les graphiques. Par conséquent, dans FreeCAD, les termes "Pivy", "Coin" ou "Open Inventor" se réfèrent essentiellement à la même chose.
 +
 
 +
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 [[Scenegraph/fr|Graphe de scène]], tel que la [[3D_view/fr|vue 3D]], ou même d'en créer de nouveaux. Pivy n'est pas nécessaire pour compiler FreeCAD, mais il est requis lors de l'exécution lors de l'exécution d'établis basés sur Python qui créent des formes à l'écran, comme [[Draft_Module/fr|Draft]] et [[Arch_Module/fr|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 éléments, Coin lui-même pour manipuler les graphes de scènes et les liaisons pour plusieurs systèmes d'interface graphique, tels que Windows et Qt. S'ils sont présents sur le système, ces modules sont également disponibles pour Pivy. Le module Coin est toujours présent, et c'est ce que nous utiliserons de toute façon, car nous n'aurons pas besoin de nous soucier d'ancrer notre affichage 3D dans aucune interface, ce qui est déjà fait par FreeCAD. Tout ce que nous devons faire est ceci:
  
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
 
}}
 
}}
==Accéder et modifier une scène graphique==
 
  
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.
+
==Graphe de scène==
 +
 
 +
Nous avons vu dans la page [[Scenegraph/fr|Graphe de scène]] comment une scène Coin typique est organisée. Tout ce qui apparaît dans une [[3D_view/fr|vue 3D]] est un Graphe de scène 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:
 
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].
+
 
 +
Certains de ces nœuds, tels que {{incode|SoSeparator}} ou {{incode|SoGroup}}, 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).<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 53:
 
sg.addChild(myCustomNode)
 
sg.addChild(myCustomNode)
 
}}
 
}}
et voici notre (beau) cube rouge.<br />
+
 
 
Maintenant, nous allons essayer ceci:
 
Maintenant, nous allons essayer ceci:
 +
 
{{Code|code=
 
{{Code|code=
col.rgb=(1,1,0)
+
col.rgb = (1, 1, 0)
 
}}
 
}}
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 />
 
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.
 
  
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 />
+
Comme vous pouvez le voir, tout est toujours accessible et modifiable à la volée. Pas besoin de recalculer ou de redessiner quoi que ce soit, Coin s'occupe de tout. Vous pouvez ajouter des éléments à votre graphe de scène, modifier les propriétés, masquer des éléments, afficher des objets temporaires, n'importe quoi. Bien entendu, cela ne concerne que l'affichage dans la vue 3D. Cet affichage est recalculé par FreeCAD lors de l'ouverture d'un fichier et lorsqu'un objet doit être recalculé. Ainsi, si vous modifiez l'aspect d'un objet FreeCAD existant, ces modifications seront perdues si l'objet est recalculé ou lorsque vous rouvrez le fichier.
Par exemple, si nous voulions faire évoluer notre cube, nous aurions ajouté un '''node SoTranslation''' à notre node personnalisé et,<br />
+
 
il aurait ressemblé à ceci:
+
Comme déjà mentionné, dans un graphe de scène openInventor, l'ordre est important. Un nœud affecte ce qui vient ensuite. Par exemple, si nous voulons avoir la possibilité de déplacer notre cube, nous devrons ajouter un nœud {{incode|SoTranslation}} {{Emphasis|avant}} le cube:
 +
 
 
{{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()
Line 70: Line 76:
 
sg.addChild(myCustomNode)
 
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.<br />
+
 
Si nous traduisons maintenant notre noeud personnalisé, il vient après le cube, et ne l'affecte pas.<br />
+
Pour déplacer notre cube, nous pouvons maintenant faire:
Si nous l'avions inséré lors de sa création, comme l'exemple ci-dessus,<br />
+
 
nous pourrions faire maintenant:
 
 
{{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 />
+
 
Enfin, pour supprimer quelque chose, nous ferons:
+
Enfin, supprimer quelque chose se fait avec:
 +
 
 
{{Code|code=
 
{{Code|code=
 
sg.removeChild(myCustomNode)
 
sg.removeChild(myCustomNode)
 
}}
 
}}
  
==Utilisation des mécanismes de rappel (callback)==
+
[[#top|En haut]]
  
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 />
+
==Rappels (callback)==
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.
+
Un [https://fr.wikipedia.org/wiki/Fonction_de_rappel mécanisme de rappel] est un système qui permet à une bibliothèque, telle que notre bibliothèque Coin, de vous rappeler, c'est-à-dire d'appeler une certaine fonction depuis votre objet Python en cours d'exécution. De cette façon, Coin peut vous informer qu'un événement spécifique s'est produit dans la scène. Coin peut regarder des choses très différentes, telles que la position de la souris, les clics sur les boutons de la souris, les touches du clavier enfoncées et bien d'autres.
  
 
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()
      print "Alert!!! A mouse button has been improperly clicked!!!"
+
        if event.getState() == coin.SoMouseButtonEvent.DOWN:
      self.view.removeEventCallbackSWIG(SoMouseButtonEvent.getClassTypeId(),self.callback)  
+
            print("Alert!!! A mouse button has been improperly clicked!!!")
+
            self.view.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.callback)
 +
 
 
ButtonTest()
 
ButtonTest()
 
}}
 
}}
Le rappel doit être initiée à partir d'un objet, et, cet objet doit '''toujours''' être actif au moment du rappel.<br />
 
Voir aussi une [[Code_snippets/fr|liste complète des événements possibles et leurs paramètres]] [[Code_snippets|(en)]], ou dans la [https://coin3d.bitbucket.io/Coin/index.html documentation officielle de coin].
 
  
== Documentation ==
+
Le rappel doit être initié à partir d'un objet, car cet objet doit toujours être en cours d'exécution lorsque le rappel se produit. 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.
  
Malheureusement, Pivy n’a pas sa propre documentation. Cependant, puisqu'il s'agit d'un wrapper de la bibliothèque Coin3d, 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 en Python.
+
[[#top|En haut]]
 +
 
 +
==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++:
 
En C++:
 +
 
{{Code|code=
 
{{Code|code=
 
SoFile::getClassTypeId()
 
SoFile::getClassTypeId()
 
}}
 
}}
En Pivy
+
 
 +
Dans Pivy:
 +
 
 
{{Code|code=
 
{{Code|code=
 
SoFile.getClassId()
 
SoFile.getClassId()
 
}}
 
}}
{{docnav/fr|[[Scenegraph/fr|Graph de scène]]|[[PySide/fr|PySide]]}}
 
  
{{Userdocnavi/fr}}
+
* [https://github.com/coin3d Coin3D] page d'accueil.
 +
* [https://github.com/coin3d/pivy Pivy] page d'accueil.
 +
* [https://github.com/coin3d/coin/wiki Coin3D wiki], sur GitHub.
 +
* [https://github.com/coin3d/coin/wiki/Documentation Documentation du wiki Coin3D], sur GitHub.
 +
* [https://coin3d.github.io/Coin/html/ Documentation Coin3D], dernière documentation Doxygen générée automatiquement.
 +
 
 +
=== Plus ancien ===
 +
 
 +
Ces liens fournissent une documentation de référence pour Coin v3.x. Les différences avec la v4.x sont minimes, elles peuvent donc toujours être utiles.
 +
 
 +
* [https://coin3d.bitbucket.io/Coin/index.html Documentation Coin3D], sur BitBucket.
 +
* [https://grey.colorado.edu/coin3d/index.html Coin3D Documentation], à l'Université du Colorado.
 +
* [https://mevislabdownloads.mevis.de/docs/current/MeVis/ThirdParty/Documentation/Publish/OpenInventorReference/index.html Ouvrir la documentation de référence Inventor], par MeVisLab.
  
[[Category:Poweruser Documentation/fr]]
+
[[#top|top]]
  
 +
{{Powerdocnavi{{#translation:}}}}
 +
[[Category:Developer Documentation{{#translation:}}]]
 +
[[Category:Python Code{{#translation:}}]]
 
{{clear}}
 
{{clear}}

Latest revision as of 13:43, 17 January 2021

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎italiano • ‎polski • ‎română • ‎svenska • ‎čeština • ‎русский • ‎日本語

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 une 3D vue. Coin est une implémentation open source de la spécification "Open Inventor" pour gérer les graphiques. Par conséquent, dans FreeCAD, les termes "Pivy", "Coin" ou "Open Inventor" se réfèrent essentiellement à la même chose.

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 Graphe de scène, tel que la vue 3D, ou même d'en créer de nouveaux. Pivy n'est pas nécessaire pour compiler FreeCAD, mais il est requis lors de l'exécution lors de l'exécution d'établis basés sur Python qui créent des formes à l'écran, comme Draft et 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 éléments, Coin lui-même pour manipuler les graphes de scènes et les liaisons pour plusieurs systèmes d'interface graphique, tels que Windows et Qt. S'ils sont présents sur le système, ces modules sont également disponibles pour Pivy. Le module Coin est toujours présent, et c'est ce que nous utiliserons de toute façon, car nous n'aurons pas besoin de nous soucier d'ancrer notre affichage 3D dans aucune interface, ce qui est déjà fait par FreeCAD. Tout ce que nous devons faire est ceci:

from pivy import coin

Graphe de scène

Nous avons vu dans la page Graphe de scène comment une scène Coin typique est organisée. Tout ce qui apparaît dans une vue 3D est un Graphe de scène 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 SoSeparator ou SoGroup, 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)

Maintenant, nous allons essayer ceci:

col.rgb = (1, 1, 0)

Comme vous pouvez le voir, tout est toujours accessible et modifiable à la volée. Pas besoin de recalculer ou de redessiner quoi que ce soit, Coin s'occupe de tout. Vous pouvez ajouter des éléments à votre graphe de scène, modifier les propriétés, masquer des éléments, afficher des objets temporaires, n'importe quoi. Bien entendu, cela ne concerne que l'affichage dans la vue 3D. Cet affichage est recalculé par FreeCAD lors de l'ouverture d'un fichier et lorsqu'un objet doit être recalculé. Ainsi, si vous modifiez l'aspect d'un objet FreeCAD existant, ces modifications seront perdues si l'objet est recalculé ou lorsque vous rouvrez le fichier.

Comme déjà mentionné, dans un graphe de scène openInventor, l'ordre est important. Un nœud affecte ce qui vient ensuite. Par exemple, si nous voulons avoir la possibilité de déplacer notre cube, nous devrons ajouter un nœud SoTranslation avant le cube:

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)

Pour déplacer notre cube, nous pouvons maintenant faire:

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

Enfin, supprimer quelque chose se fait avec:

sg.removeChild(myCustomNode)

En haut

Rappels (callback)

Un mécanisme de rappel est un système qui permet à une bibliothèque, telle que notre bibliothèque Coin, de vous rappeler, c'est-à-dire d'appeler une certaine fonction depuis votre objet Python en cours d'exécution. De cette façon, Coin peut vous informer qu'un événement spécifique s'est produit dans la scène. Coin peut regarder des choses très différentes, telles que la position de la souris, les clics sur les boutons de la souris, les touches du clavier enfoncées et bien d'autres.

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 produit. Voir aussi une liste complète des événements possibles et leurs paramètres ou dans la documentation officielle de Coin.

En haut

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

Plus ancien

Ces liens fournissent une documentation de référence pour Coin v3.x. Les différences avec la v4.x sont minimes, elles peuvent donc toujours être utiles.

top