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 scenegraphs Coin3d 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)

Recuerde que en un scenegraph openInventor, el orden es importante. Un nodo afecta a lo que viene a continuación, por lo que puede decir algo como: color rojo, cubo, color amarillo, esfera, y obtendrá un cubo rojo y una esfera amarilla. Si ahora añadimos la traslación a nuestro nodo de referencia existente, eso llegaría después de el cubo, y no lo afectaría. Si lo hubieramos insertado cuando lo creamos, como aquí arriba, ahora podríamos hacer:

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

Y nuestro cubo saltaría 2 unidades a la derecha. Por último, se quita algo con:

sg.removeChild(myCustomNode)

La utilización de mecanismos de devolución de llamada
Un callback mechanism (mecanismo de devolución de llamada) es un sistema que permite a una biblioteca que está utilizando, como la biblioteca Coin, que le devuelva la llamada, es decir, que llame a una función específica de su objeto de Python ejecutado actualmente. Esto es muy útil, porque de esa manera Coin puede avisarle si algún evento específico se produce en la escena. Coin pueden ver cosas muy diferentes, como la posición del ratón, clics en un botón del ratón, las teclas del teclado que son pulsadas y muchas otras cosas.

FreeCAD cuenta con una manera fácil de utilizar devoluciones de llamada de este tipo:

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

La devolución de llamada tiene que ser iniciada por un objeto, y ese objeto debe estar todavía en ejecución cuando la devolución de llamada se produzca. Véase también una complete list de los eventos posibles y sus parámetros, o el official coin documentation.

Documentación
Lamentablemente pivy aún no tiene una documentación formal, pero como es una traducción exacta de Coin, usted puede utilizar con seguridad la documentación de Coin como referencia, y usar el estilo de Python en lugar del estilo C++ (por ejemplo,  SoFile::getClassTypeId se escribiría en pivy como:  SoFile.getClassId )