Pivy/es

Pivy es una librería para enlazar python con Coin3d, la biblioteca de renderizado-3D usada con FreeCAD. Cuando es importado en un intérprete de Python en ejecución, permite dialogar directamente con cualquier scenegraphsCoin3d en ejecución, como las  vistas 3D de FreeCAD, o incluso para crear otras nuevas. Pivy se incluye en la instalación estándar de FreeCAD.

La biblioteca de Coin se divide en varias partes, la propia Coin, para manipular scenegraphs y pasarelas para varios sistemas de interfaz gráfica de usuario (GUI), tales como ventanas o, como en nuestro caso, qt. Esos módulos están también disponibles para pivy, si están presentes en el sistema. El módulo Coin está siempre presente, y es lo que vamos a utilizar en todos los casos, y usted no tendrá que preocuparse de anclar nuestra pantalla 3D en ninguna interfaz, ya que FreeCAD ya lo ha hecho por si mismo. Todo lo que necesitamos hacer es esto:

from pivy import coin

Acceso y modificación de la scenegraph
Vimos en la Página de Scenegraph cómo se organiza una típica escena de Coin. Todo lo que aparece en una vista 3D de FreeCAD es una scenegraph de Coin, organizada de la misma manera. Tenemos un nodo raíz, y todos los objetos en la pantalla son sus hijos.

FreeCAD tiene una forma fácil de acceder al nodo raíz de una vista 3D scenegraph:

sg = FreeCADGui.ActiveDocument.ActiveView.getScenegraph print sg

Esto devolverá el nodo raíz:

 >

Podemos inspeccionar los elementos secundarios inmediatos de nuestra escena:

for node in sg.getChilden print node

Algunos de esos nodos, tales como SoSeparators o SoGroups, pueden tener sus propios hijos. La lista completa de los objetos de Coin disponibles se puede encontrar en el official coin documentation.

Ahora vamos a tratar de añadir algo a nuestra scenegraph. Vamos a añadir un bonito cubo rojo:

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

y aquí está nuestro (magnífico) cubo rojo. Ahora, vamos a probar esto:

col.rgb=(1,1,0)

¿Ve? todo se mantiene accesible y modificable sobre la marcha. No hay necesidad de volver a calcular o dibujar cualquier cosa, Coin se encarga de todo. Puede agregar cosas a la scenegraph, cambiar las propiedades, ocultar cosas, mostrar objetos temporales, cualquier cosa. Por supuesto, esto sólo afecta a la pantalla en la vista 3D. Esa pantalla se vuelve a calcular por FreeCAD al abrir el archivo, y cuando un objeto necesita recalcular. Por lo tanto, si cambia el aspecto de un objeto FreeCAD existente, esos cambios se perderán si el objeto se vuelve a recalcular o cuando se vuelve a abrir el archivo.

Una de las claves para trabajar con scenegraphs en los scripts es poder tener acceso cuando sea necesario a ciertas propiedades de los nodos que ha añadido. Por ejemplo, si quisieramos mover nuestro cubo, habríamos añadido un nodo SoTranslation a nuestro nodo de referencia, y se vería así:

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)

Remember that in an openInventor scenegraph, the order is important. A node affects what comes next, so you can say something like: color red, cube, color yellow, sphere, and you will get a red cube and a yellow sphere. If we added the translation now to our existing custom node, it would come after the cube, and not affect it. If we had inserted it when creating it, like here above, we could now do:

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

And our cube would jump 2 units to the right. Finally, removing something is done with:

sg.removeChild(myCustomNode)

Using callback mechanisms
A callback mechanism is a system that permits a library that you are using, such as our coin library, to call you back, that is, to call a certain function from your currently running python object. This is extremely useful, because that way coin can notify you if some specific event occurs in the scene. Coin can watch very different things, such as mouse position, clicks of a mouse button, keyboard keys being pressed, and many other things.

FreeCAD features an easy way to use such callbacks:

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

The callback has to be initiated from an object, because that object must still be running when the callback will occur. See also a complete list of possible events and their parameters, or the official coin documentation.

Documentation
Unfortunately pivy itself still doesn't have a proper documentation, but since it is an accurate translation of coin, you can safely use the coin documentation as reference, and use python style instead of c++ style (for example SoFile::getClassTypeId would in pivy be SoFile.getClassId)