Extra python modules/es

El interprete de Python dentro de FreeCAD puede extenderse fácilmente añadiendo nuevos módulos a tu instalación de Python. Esos módulos se detectarán automáticamente y utilizarán por FreeCAD.

Todos los módulos de Python se pueden utilizar desde FreeCAD, pero algunos de ellos, listados abajo, tienen una importancia especial porque permiten a los programas de Python tener acceso completo a las funcionalidades principales de FreeCAD. También se pueden encontrar ejemplos de uso de dichos módulos en la página de Pedazos de código.

Nota: de los siguientes módulos, Pivy está ahora integrado por completo en cualquier paquete de instalación de FreeCAD, y PyQt4 también está integrado en el paquete de instalación de Windows.

PyQt4
Web: http://www.riverbankcomputing.co.uk/pyqt

PyQt (versión 4) es una biblioteca de vinculación de Python que permite a los programas acceder, crear o modificar interfaces Qt. Ya que la interfaz de FreeCAD está construida con Qt, la instalación de PyQt4 en tu sistema permitirá a los programas de Python dentro de FreeCAD acceder a todos los interfaces, modificar sus partes, crear nuevos complementos (widgets) o recoger información desde partes del interfaz.

PyQt se distribuye bajo un sistema de múltiples licencias, el mismo sistema que es utilizado por Qt. En resumen, existe una versión comercial y una versión libre GPL. Si quieres utilizarlo para crear aplicaciones comerciales (de código cerrado), necesitas comprar la licencia comercial, en otro caso puedes simplemente instalar y utilizar libremente la versión GPL.

Instalación
Antes de la instalación de PyQt4, obviamente necesitas un entorno de Python instalado y trabajando.

Linux

El modo más sencillo de instalar PyQt4 es a través del gestor de paquetes de tu distribución. En sistemas Debian/Ubuntu, el nombre del paquete es generalmente python-qt4, mientras que en sistemas basados en RPM se denomina pyqt4. Las dependencias necesarias (Qt y SIP) se cogerán automáticamente.

Windows

El programa se puede descargar desde aquí. Necesitas instalar las bibliotecas Qt y SIP antes de instalar (pendiente de documentar).

Utilización
Una vez está instalado, puedes comprobar que todo está funcionando escribiendo en la consola de Python de FreeCAD:

import PyQt4

Para acceder a la interfaz de FreeCAD, escribe:

from PyQt4 import QtCore,QtGui app = QtGui.qApp FreeCADWindow = app.activeWindow

Ahora puedes comenzar a explorar la interfaz con el comando dir. Puedes añadir nuevos elementos, como complementos (widget) personalizados, con comandos como:

FreeCADWindow.addDockWidget(QtCore.Qt.RghtDockWidgetArea,my_custom_widget)

Documentación
Más tutoriales de pyQt4 (incluyendo cómo construir interfaces con Qt Designer para utilizar con Python):

http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/classes.html - la referencia oficial del API de PyQt4

http://www.rkblog.rk.edu.pl/w/p/introduction-pyqt4/ - una simple introducción

http://www.zetcode.com/tutorials/pyqt4/ - un tutorial en profundidad muy completo

Pivy
web: http://pivy.coin3d.org/

Pivy es una biblioteca de vinculación de coin para Python, soportada oficialmente por coin. El propio Coin es un juego de herramientas para construir aplicaciones 3D en OpenGL. Es el juego de herramientas que utiliza FreeCAD para dibujar su escena 3D en la pantalla. Instalando Pivy en tu sistema permitirá a los programas en Python acceder a la escena gráfica de FreeCAD, dibujar nuevos objetos en la escena y utilizar el amplio rango de herramientas de Coin disponibles para operaciones de dibujo. Coin está basado en el lenguaje de descripción de la escena de Open Inventor. Pivy se utiliza por el módulo de croquizado 2D de FreeCAD (y también por el módulo completo), así que es necesario si quieres utilizar cualquier herramienta de dichos módulos.

Es importante saber que FreeCAD sólo utiliza coin para la representación de los objetos en la pantalla, la cual está separada de la definición de los objetos. Esto dignifica que pivy no será capaz de modificar objetos existentes, ni de crear objetos de FreeCAD válidos. Pero puede utilizarse para dibujar todo tipo de cosas temporales en la pantalla, como ejes, parrillas, manipuladores, geometría constructiva, etc...

Pivy, al igual que Coin, se distribuye bajo licencia GPL.

Requisitos previos
Creo que antes de compilar Pivy querrás tener Coin y SoQt instalados.

Para construirlo en Mac es suficiente instalar el paquete binario de Coin3. Intentar instalar Coin desde MacPorts es problemático: añadir un montón de paquetes de X Windows y finalmente se cuelga con un error de script.

Para Fedora encontré un RPM con Coin3.

SoQt compilado desde código fuente funciona bien en Mac y Linux.

Debian & Ubuntu
Empezando con Debian Squeeze y Ubuntu Lucid, pivy está disponible directamente desde los repositorios oficiales, ahorrándonos un montón de dificultades. Mientras tanto, puedes descargar uno de los paquetes que hemos creado (para Debian y Ubuntu karmic) disponibles en la página de Descargas, o compilarlo tu mismo.

El mejor modo de compilar pivy siomplemente es aprovechar el paquete de código fuente de Debian para pivy y crear un paquete con debuild. Es el mismo código fuente desde la web oficial de pivy, pero la gente de Debian han creado varios parches adicionales. También se compila bien en Ubuntu karmic: http://packages.debian.org/squeeze/python-pivy (descarga los archivos .orig.gz y .diff.gz, luego descomprimelos, y aplica .diff al código fuente: ve a las carpetas del código fuente descomprimido de pivy, y aplica el parche .diff: patch -p1 < ../pivy_0.5.0~svn765-2.diff luego debuild para tener pivy correctamente construido en un paquete oficial de instalación. A continuación, simplemente instala el paquete con gdebi.

Otras distribuciones Linux
Primero consigue la última versión del código fuente de los repositorios del proyecto: hg clone http://hg.sim.no/Pivy/default Pivy

En marzo de 2012, la última versión es Pivy-0.5

Luego necesitas una herramienta llamada SWIG para generar el código C++ para la vinculación de Python. Pivy-0.5 informa que sólo ha sido comprobado con SWIG 1.3.31, 1.3.33, 1.3.35, y 1.3.40. Así que puedes descargar el código fuente en un tarball para una de dichas versiones anteriores desde http://www.swig.org. Luego descomprimelo y desde la línea de comandos haz lo siguiente (como root): ./configure make make install (or checkinstall if you use it) Esto tardará unos segundos en construirse. Como alternativa, puedes tratar de construir con un SWIG más reciente. En marzo de 2012, una versión típica del repositorio es la 2.0.4. Pivy tiene un problema menor de compilación con SWIG 2.0.4 en Mac OS (mira más abajo) pero parece construirse bien en Fedora Core 15.

Después de eso ve al archivo que va a los recursos de pivy y ejecuta python setup.py build lo que creará los archivos fuente. Ten en cuenta que la construcción puede producir miles de advertencias, pero afortunadamente no hay errores.

Es posible que esto esté obsoleto, pero puedes llegar a un error de compilación donde una constante de tipo caracter (char) no puede ser convertida en una 'char*'. Para solucionarlo sólo necesitas escribir una constante antes de las líneas apropiadas. Hay 6 líneas que corregir.

Después de eso, instalar por publicación (como root): python setup.py install (or checkinstall python setup.py install)

Eso es todo, pivy está instalado.

Mac OS
Estas instrucciones puede que no estén completas. Algo parecido funciona para OS 10.7 en marzo de 2012. He utilizado MacPorts para los repositorios, pero también deberían funcionar otras opciones.

Para Linux, consigue la última vcersión del código fuente: hg clone http://hg.sim.no/Pivy/default Pivy

Si no tienes hg, puedes conseguirlo desde MacPorts: port install mercurial

Luego, como se indica arriba, necesitas SWIG. Debería ser cuestión de hacer: port install swig

He encontrado que también necesitaba: port install swig-python

En marzo de 2012, la versión de SWIG en MacPorts es la 2.0.4. Como se ha indicado arriba para Linux, podría ser mejor que descargaras una versión más antigua. SWIG 2.0.4 parece tener un error que detiene la construcción de Pivy. Mira el primer mensaje en este enlace: https://sourceforge.net/mailarchive/message.php?msg_id=28114815

Esto se puede corregir editando las dos ubicaciones de código fuente para añadir: *arg4, *arg5 en lugar de arg4, arg5. Ahora Pivy debería construirse: python setup.py build sudo python setup.py install

Windows
Asumiendo que utilizas Visual Studio 2005 o superior deberías abrir una ventana de comandos con 'Visual Studio 2005 Command prompt' desde el menú Herramientas. Si el interprete aún no está en el sistema, haz set PATH=path_to_python_2.5;%PATH%

Para tener pivy funcionando deberías conseguir las últimas fuentes desde los repositorios del proyect: svn co https://svn.coin3d.org/repos/Pivy/trunk Pivy Luego necesitas una herramienta denominada SWIG para generar el ódigo C++ para la vinculación con Python. Es recomendable utilizar la versión 1.3.25 de SWIG, no la última versión, porque de momento pivy sólo funciona correctamente con con la versión with 1.3.25. Descarga los binarios para 1.3.25 desde http://www.swig.org. Luego descomprimelo y desde la línea de comandos añádelo al sistema path set PATH=path_to_swig_1.3.25;%PATH% y establece COINDIR a la ruta aproviada set COINDIR=path_to_coin

En Windows el archivo de configuración de pivyespera SoWin en lugar de SoQt por defecto. No he encontrado una manera obvia para construirlo con SoQt, así que he modificado el arhivo setup.py directamente. En la línea 200 simplemente elimina la parte 'sowin' : ('gui._sowin', 'sowin-config', 'pivy.gui.') (no elimines los paréntesis de cierre).

Después de esto ve a las fuentes de pivy y ejecuta python setup.py build lo cual crea los archivos de fuente. Puedes llegar a un error de compilación de 'Varios archivos de cabecera no se han encontrado'. En este caso ajusta la variable INCLUDE set INCLUDE=%INCLUDE%;path_to_coin_include_dir y si las cabeceras de SoQt no están en el mismo sitio que las cabeceras de Coin también set INCLUDE=%INCLUDE%;path_to_soqt_include_dir y finalmente las cabeceras de Qt set INCLUDE=%INCLUDE%;path_to_qt4\include\Qt

Si estas utilizando la versión Express Edition de Visual Studio puedes tener una excepción de error de clave de Python. En este caso tendrás que modificar unas cuantas cosas en msvccompiler.py situado en la instalación de Python.

Ve a la línea 122 y reemplaza la línea vsbase = r"Software\Microsoft\VisualStudio\%0.1f" % version con vsbase = r"Software\Microsoft\VCExpress\%0.1f" % version Luego prueba de nuevo. Si te da un segundo error como error: Python was built with Visual Studio 2003;... debes reemplazar también la línea 128 self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv1.1") con self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv2.0") Intenta de nuevo. Si tienes un nuevo error como error: Python was built with Visual Studio version 8.0, and extensions need to be built with the same version of the compiler, but it isn't installed. entonces deberías comprobar las variables de entorno DISTUTILS_USE_SDK y MSSDK con echo %DISTUTILS_USE_SDK% echo %MSSDK% If not yet set then just set it e.g. to 1 set DISTUTILS_USE_SDK=1 set MSSDK=1

Ahora, debes encontrar un error de compilación donde una constante de tipo char no se puede convertir en char. Para solucionarlo necesitas escribir una constante antes de las líneas apropiadas. Hay 6 líneas que corregir. Después copia el directorio de pivy generado a un lugar donde el interprete de Python de FreeCAD lo pueda encontrar.

Utilización
Para tener Pivy acceso a la escena gráfica de FreeCAD haz lo siguiente:

from pivy import coin App.newDocument # Open a document and a view view = Gui.ActiveDocument.ActiveView FCSceneGraph = view.getSceneGraph # returns a pivy Python object that holds a SoSeparator, the main "container" of the Coin scenegraph FCSceneGraph.addChild(coin.SoCube) # add a box to scene

Ahora puedes explorar FCSceneGraph con el comando dir.

Documentación
Desafortunadamente la documentación sobre pivy es casi inexistente en la redt. Pero podrías encontrar la documentación de Coin útil, ya que pivy simplemente traduce las funciones de Coin, los nodos y métodos en Python, todo mantiene el mismo nombre y propiedades, teniendo en cuenta la diferencia de sintaxis entre C y Python:

http://doc.coin3d.org/Coin/classes.html - Referencia del API de Coin3D

http://www-evasion.imag.fr/~Francois.Faure/doc/inventorMentor/sgi_html/index.html - The Inventor Mentor - La "biblia" del lenguaje de descripción de escena de Inventor.

También puedes echar un vistazo al archivo Draft.py en el directorio de FreeCAD Mod/Draft, ya que hace un uso importante de pivy.