Difference between revisions of "Pivy/sv"

From FreeCAD Documentation
Jump to navigation Jump to search
(Created page with "En del av dessa noder, som SoSeparators eller SoGroups, kan själva ha barn. Den kompletta listan på de tillgängliga coin objekten kan återfinnas på [http://doc.coin3d.org...")
(Updating to match new version of source page)
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<languages/>
 +
 +
{{TOCright}}
 +
 +
==Introduction==
 +
 +
<div class="mw-translate-fuzzy">
 
[http://pivy.coin3d.org/ Pivy] är ett python bindnings bibliotek för [http://www.coin3d.org Coin3d], det 3D-renderingsbibliotek som används av FreeCAD. när det importeras i en körande python tolk, så kan du föra en direkt dialog med alla körande [[Scenegraph/sv|scengrafer]], som FreeCAD's 3D vyer, eller att även skapa nya. Pivy följer med i en standard FreeCAD installation.
 
[http://pivy.coin3d.org/ Pivy] är ett python bindnings bibliotek för [http://www.coin3d.org Coin3d], det 3D-renderingsbibliotek som används av FreeCAD. när det importeras i en körande python tolk, så kan du föra en direkt dialog med alla körande [[Scenegraph/sv|scengrafer]], som FreeCAD's 3D vyer, eller att även skapa nya. Pivy följer med i en standard FreeCAD installation.
 +
</div>
  
 +
When imported in a running Python interpreter, Pivy allows us to communicate directly with any running Coin [[Scenegraph|scenegraph]], such as the [[3D_view|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_Module|Draft]] and [[Arch_Module|Arch]]. Because of this, Pivy is normally installed when installing a distribution of FreeCAD.
 +
 +
<div class="mw-translate-fuzzy">
 
Coin biblioteket är uppdelat i flera delar, själva coin, för manipulation av scengrafer och bindningar för flera GUI system, som windows, eller som i vårt fall, qt. Dessa moduler är även tillgängliga för pivy, beroende på om de finns i systemet. Coin modulen finns alltid, och det är vad vi kommer att använda i alla fall, eftersom vi inte behöver bry oss om att förankra vårt 3D fönster i något gränssnitt, det görs redan av FreeCAD själv. Allt vi behöver göra är detta:
 
Coin biblioteket är uppdelat i flera delar, själva coin, för manipulation av scengrafer och bindningar för flera GUI system, som windows, eller som i vårt fall, qt. Dessa moduler är även tillgängliga för pivy, beroende på om de finns i systemet. Coin modulen finns alltid, och det är vad vi kommer att använda i alla fall, eftersom vi inte behöver bry oss om att förankra vårt 3D fönster i något gränssnitt, det görs redan av FreeCAD själv. Allt vi behöver göra är detta:
<syntaxhighlight>
+
</div>
from pivy import coin
+
 
</syntaxhighlight>
+
{{Code|code=
 +
from pivy import coin
 +
}}
 +
 
 +
<div class="mw-translate-fuzzy">
 
==Komma åt och ändra scengrafen==
 
==Komma åt och ändra scengrafen==
 +
</div>
  
 +
<div class="mw-translate-fuzzy">
 
Vi såg i [[scenegraph/sv|Scengraf]] sidan hur en typisk Coin scen är organiserad. Allt som syns i en FreeCAD 3D vy är en coin scengraf, organiserad på samma sätt. Vi har en rotnod, och alla objekt på skärmen är dess barn.
 
Vi såg i [[scenegraph/sv|Scengraf]] sidan hur en typisk Coin scen är organiserad. Allt som syns i en FreeCAD 3D vy är en coin scengraf, organiserad på samma sätt. Vi har en rotnod, och alla objekt på skärmen är dess barn.
 +
</div>
  
 
FreeCAD har ett lätt sätt att komma åt 3D vy scengrafens rotnod:
 
FreeCAD har ett lätt sätt att komma åt 3D vy scengrafens rotnod:
<syntaxhighlight>
+
 
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
+
{{Code|code=
print sg
+
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
</syntaxhighlight>
+
print(sg)
 +
}}
 +
 
 
Detta kommer att returnera rotnoden:
 
Detta kommer att returnera rotnoden:
<syntaxhighlight>
+
 
<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >
+
{{Code|code=
</syntaxhighlight>
+
<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >
 +
}}
 +
 
 
Vi kan inspektera vår scen's närmaste barn:
 
Vi kan inspektera vår scen's närmaste barn:
<syntaxhighlight>
 
for node in sg.getChildren():
 
    print node
 
</syntaxhighlight>
 
En del av dessa noder, som SoSeparators eller SoGroups, kan själva ha barn. Den kompletta listan på de tillgängliga coin objekten kan återfinnas på [http://doc.coin3d.org/Coin/classes.html official coin documentation].
 
  
Let's try to add something to our scenegraph now. We'll add a nice red cube:
+
{{Code|code=
<syntaxhighlight>
+
for node in sg.getChildren():
col = coin.SoBaseColor()
+
    print(node)
col.rgb=(1,0,0)
+
}}
cub = coin.SoCube()
+
 
myCustomNode = coin.SoSeparator()
+
<div class="mw-translate-fuzzy">
myCustomNode.addChild(col)
+
En del av dessa noder, som SoSeparators eller SoGroups, kan själva ha barn. Den kompletta listan på de tillgängliga coin objekten kan återfinnas på [http://coin3d.bitbucket.org/Coin/classes.html official coin documentation].
myCustomNode.addChild(cub)
+
</div>
sg.addChild(myCustomNode)
+
 
</syntaxhighlight>
+
Låt oss försöka lägga till något till vår scengraf nu. Vi lägger till en snygg röd kub:
and here is our (nice) red cube. Now, let's try this:
+
 
<syntaxhighlight>
+
{{Code|code=
col.rgb=(1,1,0)
+
col = coin.SoBaseColor()
</syntaxhighlight>
+
col.rgb = (1, 0, 0)
See? everything is still accessible and modifiable on-the-fly. No need to recompute or redraw anything, coin takes care of everything. You can add stuff to your scenegraph, change properties, hide stuff, show temporary objects, anything. Of course, this only concerns the display in the 3D view. That display gets recomputed by FreeCAD on file open, and when an object needs recomputing. So, if you change the aspect of an existing FreeCAD object, those changes will be lost if the object gets recomputed or when you reopen the file.
+
cub = coin.SoCube()
 +
myCustomNode = coin.SoSeparator()
 +
myCustomNode.addChild(col)
 +
myCustomNode.addChild(cub)
 +
sg.addChild(myCustomNode)
 +
}}
 +
 
 +
<div class="mw-translate-fuzzy">
 +
och här är vår (snygga) röda kub. Låt os nu försöka detta:
 +
</div>
 +
 
 +
{{Code|code=
 +
col.rgb = (1, 1, 0)
 +
}}
 +
 
 +
<div class="mw-translate-fuzzy">
 +
Se? Allt är fortfarande åtkomligt och förändringsbart direkt. Inget behov av omberäkningar eller omritningar, coin tar hand om allt. Du kan lägga till saker till din scengraf, ändra egenskaper, gömma saker, visa temporära objekt, allting. Detta gäller förstås endast visningen i 3D vyn. Den visningen beräknas om av FreeCAD när filen öppnas, och när ett objekt behöver omberäknas. Så om du ändrar en aspekt på ett existerande FreeCAD objekt, så kommer dessa ändringar att förloras om objektet beräknas om eller när du öppnar filen igen.
 +
</div>
 +
 
 +
<div class="mw-translate-fuzzy">
 +
En nyckel till arbete med scengrafer i dina skript är att kunna komma åt vissa egenskaper på de noder som du vid behov lägger till. Till exempel, om vi skulle vilja flytta vår kub, så skulle vil ha lagt till en SoTranslation nod till vår anpassade nod, och det skulle ha sett ut så här:
 +
</div>
 +
 
 +
{{Code|code=
 +
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)
 +
myCustomNode.addChild(trans)
 +
myCustomNode.addChild(cub)
 +
sg.addChild(myCustomNode)
 +
}}
 +
 
 +
<div class="mw-translate-fuzzy">
 +
Kom ihåg att i en openInventor scengraf, så är ordningen viktig. en nod påverkar efterkommande saker, så du kan säga något som : färg röd, kub, färg gul, sfär, och du kommer att få en röd kub och en gul sfär. Om vi lade till förflyttning till vår existerande anpassade nod, så skulle den komma efter kuben, och inte påverka den. Om vi hade satt in den när vi skapade den, som här ovan, så skulle vi nu kunna göra:
 +
</div>
 +
 
 +
{{Code|code=
 +
trans.translation.setValue([2, 0, 0])
 +
}}
 +
 
 +
<div class="mw-translate-fuzzy">
 +
Och vår kub skulle hoppa 2 enheter åt höger.
 +
Slutligen, att ta bort något görs med:
 +
</div>
 +
 
 +
{{Code|code=
 +
sg.removeChild(myCustomNode)
 +
}}
 +
 
 +
[[#top|top]]
 +
 
 +
<div class="mw-translate-fuzzy">
 +
==Använda återanropsmekanismer==
 +
</div>
 +
 
 +
<div class="mw-translate-fuzzy">
 +
En [http://en.wikipedia.org/wiki/Callback_%28computer_science%29 återanropsmekanism] är ett system som tillåter ett bibliotek som du använder, som vårt coin bibliotek, att anropa tillbaka, vilket innebär att anropa en viss funktion från ditt för närvarande körande python objekt. Detta är väldigt användbart, därför att på det sättet så kan coin meddela python objektet om någon specifik händelse uppstår i scenen. Coin kan övervaka väldigt olika saker, som musposition, musklick, tangentbordsnedtryckningar, och många andra saker.
 +
</div>
 +
 
 +
FreeCAD erbjuder ett lätt sätt att använda sådana återanrop:
 +
 
 +
{{Code|code=
 +
from pivy import coin
  
A key to work with scenegraphs in your scripts is to be able to access certain properties of the nodes you added when needed. For example, if we wanted to move our cube, we would have added a SoTranslation node to our custom node, and it would have looked like this:
+
class ButtonTest:
<syntaxhighlight>
+
    def __init__(self):
col = coin.SoBaseColor()
+
        self.view = FreeCADGui.ActiveDocument.ActiveView
col.rgb=(1,0,0)
+
        self.callback = self.view.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.getMouseClick)  
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)
 
</syntaxhighlight>
 
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:
 
<syntaxhighlight>
 
trans.translation.setValue([2,0,0])
 
</syntaxhighlight>
 
And our cube would jump 2 units to the right.
 
Finally, removing something is done with:
 
<syntaxhighlight>
 
sg.removeChild(myCustomNode)
 
</syntaxhighlight>
 
==Using callback mechanisms==
 
  
A [http://en.wikipedia.org/wiki/Callback_%28computer_science%29 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.
+
    def getMouseClick(self, event_cb):
 +
        event = event_cb.getEvent()
 +
        if event.getState() == coin.SoMouseButtonEvent.DOWN:
 +
            print("Alert!!! A mouse button has been improperly clicked!!!")
 +
            self.view.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.callback)
  
FreeCAD features an easy way to use such callbacks:
+
ButtonTest()
<syntaxhighlight>
+
}}
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()
 
</syntaxhighlight>
 
The callback has to be initiated from an object, because that object must still be running when the callback will occur.
 
See also a [[Code_snippets#Observing_mouse_events_in_the_3D_viewer_via_Python|complete list]] of possible events and their parameters, or the [http://doc.coin3d.org/Coin/classes.html official coin documentation].
 
  
== Documentation ==
+
<div class="mw-translate-fuzzy">
 +
Återanropet måste initieras från ett objekt, därför så måste det objektet fortfarande köras när återanropet uppstår.
  
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())
+
Se även [[Code_snippets#Observing_mouse_events_in_the_3D_viewer_via_Python/sv|den kompletta listan]] för möjliga händelser och dess parametrar, eller [http://doc.coin3d.org/Coin/classes.html i den officiella coin dokumentationen].
 +
</div>
  
{{docnav|Scenegraph|PyQt}}
+
[[#top|top]]
  
[[Category:Poweruser Documentation]]
+
<div class="mw-translate-fuzzy">
 +
== Dokumentation ==
 +
</div>
  
 +
<div class="mw-translate-fuzzy">
 +
Olyckligtvis har pivy själv ingen ordentlig dokumentation, men eftersom det är en riktig översättning av coin, så kan du med säkerhet använda coin dokumentationen som referens, och använda python stil istället för c++ stil (till exempel SoFile::getClassTypeId() skulle i pivy bli SoFile.getClassId())
 +
</div>
 +
 +
In C++:
 +
 +
{{Code|code=
 +
SoFile::getClassTypeId()
 +
}}
 +
 +
In Pivy:
 +
 +
{{Code|code=
 +
SoFile.getClassId()
 +
}}
 +
 +
* [https://github.com/coin3d Coin3D] homepage.
 +
* [https://github.com/coin3d/pivy Pivy] homepage.
 +
* [https://grey.colorado.edu/coin3d/index.html Coin3D Documentation], at University of Colorado.
 +
* [https://coin3d.bitbucket.io/Coin/index.html Coin3D Documentation], at BitBucket.
 +
* [https://mevislabdownloads.mevis.de/docs/current/MeVis/ThirdParty/Documentation/Publish/OpenInventorReference/index.html Open Inventor Reference Documentation], by MeVisLab.
 +
 +
[[#top|top]]
 +
 +
{{Powerdocnavi{{#translation:}}}}
 +
[[Category:Developer Documentation{{#translation:}}]]
 +
[[Category:Python Code{{#translation:}}]]
 
{{clear}}
 
{{clear}}
<languages/>
 

Revision as of 21:20, 23 August 2020

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎italiano • ‎polski • ‎română • ‎svenska • ‎čeština • ‎русский • ‎日本語

Introduction

Pivy är ett python bindnings bibliotek för Coin3d, det 3D-renderingsbibliotek som används av FreeCAD. när det importeras i en körande python tolk, så kan du föra en direkt dialog med alla körande scengrafer, som FreeCAD's 3D vyer, eller att även skapa nya. Pivy följer med i en standard FreeCAD installation.

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.

Coin biblioteket är uppdelat i flera delar, själva coin, för manipulation av scengrafer och bindningar för flera GUI system, som windows, eller som i vårt fall, qt. Dessa moduler är även tillgängliga för pivy, beroende på om de finns i systemet. Coin modulen finns alltid, och det är vad vi kommer att använda i alla fall, eftersom vi inte behöver bry oss om att förankra vårt 3D fönster i något gränssnitt, det görs redan av FreeCAD själv. Allt vi behöver göra är detta:

from pivy import coin

Komma åt och ändra scengrafen

Vi såg i Scengraf sidan hur en typisk Coin scen är organiserad. Allt som syns i en FreeCAD 3D vy är en coin scengraf, organiserad på samma sätt. Vi har en rotnod, och alla objekt på skärmen är dess barn.

FreeCAD har ett lätt sätt att komma åt 3D vy scengrafens rotnod:

sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
print(sg)

Detta kommer att returnera rotnoden:

<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >

Vi kan inspektera vår scen's närmaste barn:

for node in sg.getChildren():
    print(node)

En del av dessa noder, som SoSeparators eller SoGroups, kan själva ha barn. Den kompletta listan på de tillgängliga coin objekten kan återfinnas på official coin documentation.

Låt oss försöka lägga till något till vår scengraf nu. Vi lägger till en snygg röd kub:

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

och här är vår (snygga) röda kub. Låt os nu försöka detta:

col.rgb = (1, 1, 0)

Se? Allt är fortfarande åtkomligt och förändringsbart direkt. Inget behov av omberäkningar eller omritningar, coin tar hand om allt. Du kan lägga till saker till din scengraf, ändra egenskaper, gömma saker, visa temporära objekt, allting. Detta gäller förstås endast visningen i 3D vyn. Den visningen beräknas om av FreeCAD när filen öppnas, och när ett objekt behöver omberäknas. Så om du ändrar en aspekt på ett existerande FreeCAD objekt, så kommer dessa ändringar att förloras om objektet beräknas om eller när du öppnar filen igen.

En nyckel till arbete med scengrafer i dina skript är att kunna komma åt vissa egenskaper på de noder som du vid behov lägger till. Till exempel, om vi skulle vilja flytta vår kub, så skulle vil ha lagt till en SoTranslation nod till vår anpassade nod, och det skulle ha sett ut så här:

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)
myCustomNode.addChild(trans)
myCustomNode.addChild(cub)
sg.addChild(myCustomNode)

Kom ihåg att i en openInventor scengraf, så är ordningen viktig. en nod påverkar efterkommande saker, så du kan säga något som : färg röd, kub, färg gul, sfär, och du kommer att få en röd kub och en gul sfär. Om vi lade till förflyttning till vår existerande anpassade nod, så skulle den komma efter kuben, och inte påverka den. Om vi hade satt in den när vi skapade den, som här ovan, så skulle vi nu kunna göra:

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

Och vår kub skulle hoppa 2 enheter åt höger. Slutligen, att ta bort något görs med:

sg.removeChild(myCustomNode)

top

Använda återanropsmekanismer

En återanropsmekanism är ett system som tillåter ett bibliotek som du använder, som vårt coin bibliotek, att anropa tillbaka, vilket innebär att anropa en viss funktion från ditt för närvarande körande python objekt. Detta är väldigt användbart, därför att på det sättet så kan coin meddela python objektet om någon specifik händelse uppstår i scenen. Coin kan övervaka väldigt olika saker, som musposition, musklick, tangentbordsnedtryckningar, och många andra saker.

FreeCAD erbjuder ett lätt sätt att använda sådana återanrop:

from pivy import coin

class ButtonTest:
    def __init__(self):
        self.view = FreeCADGui.ActiveDocument.ActiveView
        self.callback = self.view.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.getMouseClick) 

    def getMouseClick(self, event_cb):
        event = event_cb.getEvent()
        if event.getState() == coin.SoMouseButtonEvent.DOWN:
            print("Alert!!! A mouse button has been improperly clicked!!!")
            self.view.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.callback)

ButtonTest()

Återanropet måste initieras från ett objekt, därför så måste det objektet fortfarande köras när återanropet uppstår.

Se även den kompletta listan för möjliga händelser och dess parametrar, eller i den officiella coin dokumentationen.

top

Dokumentation

Olyckligtvis har pivy själv ingen ordentlig dokumentation, men eftersom det är en riktig översättning av coin, så kan du med säkerhet använda coin dokumentationen som referens, och använda python stil istället för c++ stil (till exempel SoFile::getClassTypeId() skulle i pivy bli SoFile.getClassId())

In C++:

SoFile::getClassTypeId()

In Pivy:

SoFile.getClassId()

top