Pivy/fr: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
Line 6: Line 6:
[[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.
[[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.


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 class="mw-translate-fuzzy">
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:
</div>
{{Code|code=
{{Code|code=
from pivy import coin
from pivy import coin

Revision as of 10:02, 20 May 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 Scenegraph comment coin organise une scène. Tout ce qui est affiché en 3D dans FreeCAD est construit et géré par coin.
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.

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 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 official coin documentation.

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)

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:

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

Le rappel doit être initiée à partir d'un objet, et, cet objet doit toujours être actif au moment du rappel.
Voir aussi une liste complète des événements possibles et leurs paramètres (en), ou dans la documentation officielle de coin.

Documentation

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 vous la liriez en Python.

En C++:

SoFile::getClassTypeId()

En Pivy

SoFile.getClassId()