Pivy/fr

= Pivy/fr =

Pivy est une bibliothèque de codes qui sert de passerelle entre Python et Coin3d, la bibliothèque 3D de rendu graphique utilisé par 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. Pivy est inclus d'origine dans l'installation FreeCAD. La bibliothèque d'outils est divisée en plusieurs parties, Ces modules sont aussi accessibles à pivy, s'ils sont présents sur le système bien sûr. 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. Tout ce que nous aurons à faire, c'est:
 * 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.

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:

 >

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) mtCustomNode.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, ou dans la documentation officielle de coin.

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 coin, et utiliser le style Python au lieu du style c ++ ( par exemple SoFile::getClassTypeId en c++, serait SoFile.getClassId en pivy )