Pivy/fr

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.

When imported in a running Python interpreter, Pivy allows us to communicate directly with any running Coin scenegraph, such as the 3D view, or even to create new ones. Pivy is not required to compile FreeCAD, but it is required at runtime when running Python-based workbenches that create shapes on screen, like Draft and Arch. Because of this, Pivy is normally installed when installing a distribution of 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:

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:

La racine de la scène 3D sera:

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

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:

et voici notre (beau) cube rouge.

Maintenant, nous allons essayer ceci:

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:

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:

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

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:

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++:

Dans Pivy:


 * Coin3d page d'accueil
 * Pivy page d'accueil
 * Coin Documentation Université du Colorado
 * Coin Documentation BitBucket

Older
These links provide reference documentation for Coin v3.x. The differences with v4.x are minimal, so they may still be useful.


 * Coin3D Documentation, at BitBucket.
 * Coin3D Documentation, at University of Colorado.
 * Open Inventor Reference Documentation, by MeVisLab.

top