Extra python modules/sv

Python tolken inuti FreeCAD kan lätt utökas genom att lägga till nya moduler till ditt systems pythoninstallation. Dessa moduler kommer att upptäckas och användas av FreeCAD automatiskt.

Alla pyhton moduler kan användas inne i FreeCAD, men flera av dem (listas nedan), har en speciell betydelse därför att de tillåter pythonprogram komplett åtkomst till FreeCAD's kärnfunktionalitet. Exempel på hur man använder dessa moduler kan hittas på Kodbitar sidan.

Notera: av följande moduler, så är Pivy nu helt integrerad i alla FreeCAD installationspaket, och PyQt4 är också integrerat i Windows installationspaket.

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

PyQt (version 4) är ett pythonbindningsbibliotek vilket tillåter program att komma åt, skapa eller ändra Qt gränssnitt. Eftersom FreeCAD's gränssnitt är byggt med Qt, så tillåter en installation av PyQt4 på ditt system, att pythonprogram inuti FreeCAD kan komma åt hela gränssnittet, förändra dess delar, skapa nya widgetar eller samla info från gränssnittsdelar.

PyQt är släppt under ett multipelt licensieringssystem, samma system som används av Qt. Det finns en kommersiell version och en fri GPL version. Om du vill använda den för att göra kommersiella (stängd källkod) program, så behöver du köpa den kommersiella licensen, annars så kan du helt enkelt installera och fritt använda GPL versionen.

Installation
Innan du installerar PyQt4, så behöver du givetvis en installerad och fungerande pythonmiljö.

Linux

Det enklaste sättet att installera PyQt4 är genom din distributions pakethanterare. På Debian/Ubuntu system, så heter paketet i allmänhet python-qt4, medan det på RPM-baserade system heter pyqt4. De nödvändiga beroendena (Qt och SIP) kommer att tas hand om automatiskt.

Windows

Programmet kan laddas ned från här. Du kommer att behöva installera Qt och SIP biblioteken innan du installerar pyqt4 (kommer att dokumenteras).

Bruk
När det väl är installerat, så kan du kontrollera att allt fungerar genom att i en FreeCAD pythonkonsoll skriva:

import PyQt4

För att komma åt FreeCAD's gränssnitt, skriv:

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

Nu kan du börja utforska gränssnittet med dir kommandot. Du kan lägga till nya element, som en anpassad widget, med kommandon som:

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

Dokumentation
Fler pyQt4 övningar (inklusive hur man bygger gränssnitt med Qt Designer för att använda med python): http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/classes.html - den officiella PyQt4 API Referensen http://www.rkblog.rk.edu.pl/w/p/introduction-pyqt4/ - en enkel introduktion http://www.zetcode.com/tutorials/pyqt4/ - mycket fullständig, djupgående övning

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

Pivy är ett coin bindningsbibliotek för python, officiellt stött av coin. Coin själv är ett verktygsset för att bygga 3D applikationer i OpenGL. Det är det verktygssetet som FreeCAD använder för att rita sin 3d Scen på skärmen. Genom att installera Pivy på ditt system så kan pythonprogram komma åt FreeCAD's scengraf, rita nya objekt på scenen och använda det stora omfånget av tillgängliga Coinverktyg för ritfunktioner. Coin är baserat på open Inventor scenbeskrivningsspråket. Pivy används av FreeCAD's 2D ritmodul (och även av den kompletta modulen), så den behövs om du vill använda något av dessa modulers verktyg.

Det är viktigt att veta att FreeCAD bara använder coin för representation av objekt på skärmen, vilket är separerat från objektens definition. Detta betyder att pivy inte kan ändra på existerade objekt, eller skapa giltiga FreeCAD objekt. Men det kan användas till att rita alla möjliga temporära saker på skärmen, som axlar, rutnät, manipulatorer, konstruktionsgeometri, etc...

Pivy är såväl som Coin släppt under en GPL licens.

Debian & Ubuntu
Med början i Debian Squeeze och Ubuntu Lucid, så kommer pivy att finnas tillgängligt direkt från de officiella förråden, vilket sparar mycket krångel. Innan dess, så kan du antingen ladda ned ett av de paket som vi har gjort (för debian och ubuntu karmic) tillgängliga på Nedladdningssidorna, eller så kan du kompilera det själv.

Det bästa sättet att kompilera pivy smidigt är att hämta debians källkodspaket för pivy och göra ett paket med debuild. Det är samma källkod som på den officiella pivysajten, men debianfolket har gjort flera bugg-fixningstillägg. Det kompilerar också bra på ubuntu karmic: http://packages.debian.org/squeeze/python-pivy (ladda ned .orig.gz och .diff.gz file, packa upp båda, tillämpa sedan .diff på källkoden: gå till den uppackade pivy källkodsmappen, och tillämpa .diff patchen:

patch -p1 < ../pivy_0.5.0~svn765-2.diff

sedan

debuild

för att få pivy korrekt byggt till ett officiellt installerbart paket. Sedan så är det bara att installera paketet med gdebi.

Andra linux distributioner
Hämta först den senaste källkoden från projekets förråd:

svn co https://svn.coin3d.org/repos/Pivy/trunk Pivy

Sedan behöver du ett verktyg som kallas för SWIG för att generera C++ koden för Pythonbindningarna. Det rekommenderas att version 1.3.25 av SWIG används, inte den senaste versionen, därför att pivy för tillfället endast fungerar korrekt med 1.3.25. Ladda ned 1.3.25 source tarball från http://www.swig.org. Packa sedan upp den, och gör som root följande i en konsol:

./configure make make install (eller checkinstall om du använder den)

Det tar bara några sekunder att bygga.

Efter det, gå till pivy källkoden och anropa

python setup.py build

viltet skapar källkodsfilerna. Du kan få kompileringsfel där en 'const char*' inte kan konverteras till en 'char*'. För att fixa det så behöver du bara skriva en 'const' innan raderna som orsakade felet. Det finns sex rader att fixa. Efter det, installera genom att skriva (som root):

python setup.py install (or checkinstall python setup.py install)

Klart! Pivy är installerat.

Windows
När du använder Visual Studio 2005 eller senare så ska du öppna en kommandoprompt med 'Visual Studio 2005 Command prompt' från Tools menyn. Om du ännu inte har Pythontolken i systemsökvägen, gör

set PATH=path_to_python_2.5;%PATH%

För att få pivy att fungera så ska du hämta den senaste källkoden från projektets förråd:

svn co https://svn.coin3d.org/repos/Pivy/trunk Pivy

Sedan behöver du ett verktyg som kallas för SWIG för att generera C++ koden för Python bindningarna. Det rekommenderas att version 1.3.25 av SWIG används, inte den senaste versionen, därför att pivy för tillfället endast fungerar korrekt med 1.3.25. Ladda ned binärkoden för 1.3.25 från http://www.swig.org. Packa sedan upp den och lägg till den i systemsökvägen från kommandoraden

set PATH=path_to_swig_1.3.25;%PATH%

och ställ in COINDIR till den riktiga sökvägen

set COINDIR=path_to_coin

På Windows så förväntar sig pivys konfigurationsfil SoWin istället för SoQt som standard. Jag har inte hittat en självklart sätt att bygga med SoQt, så Jag modifierade filen setup.py direkt.

Ta på rad 200 bort delen 'sowin' : ('gui._sowin', 'sowin-config', 'pivy.gui.') (ta inte bort den stängande parentesen).

Efter det, gå till pivy källkoden och anropa

python setup.py build

vilket skapar källkodsfilerna. Du kan få kompileringsfel för att flera headerfiler inte kunde hittas. I detta fall så får du justera INCLUDE variabeln

set INCLUDE=%INCLUDE%;path_to_coin_include_dir

och om SoQt headers int är på samma plats som Coin headers så får du också justera

set INCLUDE=%INCLUDE%;path_to_soqt_include_dir

och slutligen Qt headers

set INCLUDE=%INCLUDE%;path_to_qt4\include\Qt

Om du använder Expressutgåvan av Visual Studio så kan du få ett python keyerror undantag.

I detta fall så måste du ändra en del saker i msvccompiler.py som finns i din python installation.

Gå till rad 122 och byt ut raden

vsbase = r"Software\Microsoft\VisualStudio\%0.1f" % version

mot

vsbase = r"Software\Microsoft\VCExpress\%0.1f" % version

Försök sedan igen.

Om du får ett andra fel som

error: Python was built with Visual Studio 2003;...

Så måste du även byta ut rad 128

self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv1.1")

mot

self.set_macro("FrameworkSDKDir", net, "sdkinstallrootv2.0")

Försök igen. Om du åter får ett fel som

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.

så ska du kontrollera miljövariablerna DISTUTILS_USE_SDK och MSSDK med

echo %DISTUTILS_USE_SDK% echo %MSSDK%

Om de inte är inställda än, ställ in dem till 1

set DISTUTILS_USE_SDK=1 set MSSDK=1

Nu kan du få kompileringsfel där en 'const char*' inte kan konverteras till en 'char*'. För att fixa det så behöver du bara skriva en 'const' innan raderna som orsakade felet. Det finns sex rader att fixa.

Kopiera sedan den genererade pivykatalogen till en plats där pythontolken i FreeCAD kan hitta den.

Bruk
För att Pivy ska komma åt FreeCAD scengrafen, gör följande:

from pivy import coin App.newDocument # Öppna ett dokument och en vy view = Gui.ActiveDocument.ActiveView FCSceneGraph = view.getSceneGraph # returnerar ett pivy Python objekt som håller en SoSeparator, Coin scengrafens huvud "behållare" FCSceneGraph.addChild(coin.SoCube) # lägg till en låda i scenen

Nu kan du utforska FCSceneGraph med dir kommandot.

Dokumentation
Olyckligtvis så existerar det knappast ännu någon dokumentation om pivy på nätet. Men Coin dokumentationen kan vara användbar, eftersom pivy helt enkelt översätter Coin funktioner, noder och metoder i python, allt behåller samma namn och egenskaper, bara man tänker på syntaxskillnaden mellan C och python:

http://doc.coin3d.org/Coin/classes.html - Coin3D API Referens http://www-evasion.imag.fr/~Francois.Faure/doc/inventorMentor/sgi_html/index.html - The Inventor Mentor - Inventor scenbeskrivningsspråkets "bibel". Du kan också titta på Draft.py filen i FreeCAD Mod/Draft mappen, eftersom den använder pivy mycket.