Pivy/de: Difference between revisions
No edit summary |
(Created page with "===Ältere===") |
||
(21 intermediate revisions by 4 users not shown) | |||
Line 8: | Line 8: | ||
{{TOCright}} |
{{TOCright}} |
||
<span id="Introduction"></span> |
|||
==Einführung== |
==Einführung== |
||
[[Pivy/de|Pivy]] ist eine [[Python/de|Python]] Bindungsbibliothek für [https://github.com/coin3d Coin], die 3D Rendering Bibliothek, die in FreeCAD verwendet wird, um Dinge in einer [[3D_view/de|3D Ansicht]] anzuzeigen. Coin ist eine quelloffene Implementierung der "Open Inventor" Spezifikation zur Handhabung von Grafiken. Daher beziehen sich in FreeCAD die Begriffe "Pivy", "Coin" oder "Open Inventor" im Wesentlichen auf die gleiche Sache. |
[[Pivy/de|Pivy]] ist eine [[Python/de|Python]] Bindungsbibliothek für [https://github.com/coin3d Coin], die 3D Rendering Bibliothek, die in FreeCAD verwendet wird, um Dinge in einer [[3D_view/de|3D Ansicht]] anzuzeigen. Coin ist eine quelloffene Implementierung der "Open Inventor" Spezifikation zur Handhabung von Grafiken. Daher beziehen sich in FreeCAD die Begriffe "Pivy", "Coin" oder "Open Inventor" im Wesentlichen auf die gleiche Sache. |
||
Wenn in einen laufenden Python |
Wenn in einen laufenden Python-Interpreter importiert, erlaubt Pivy direkt mit jedem laufenden Coin-[[Scenegraph/de|Szenengraph]], wie z.B. der [[3D_view/de|3D-Ansicht]] zu kommunizieren, oder sogar neue zu erstellen. Pivy ist nicht erforderlich, um FreeCAD zu kompilieren, aber es wird zur Laufzeit benötigt, wenn auf Python basierende Arbeitsbereiche ausgeführt werden, die Formen auf dem Bildschirm erstellen, wie die Arbeitsbereiche [[Draft_Workbench/de|Draft]] und [[Arch_Workbench/de|Arch]]. Aus diesem Grund wird Pivy normalerweise installiert, wenn eine Distribution von FreeCAD installiert wird. |
||
Die Coin Bibliothek ist in mehrere Teile unterteilt, Coin selbst zur Manipulation von Szenegraphen und Bindungen für verschiedene GUI Systeme wie Windows und Qt. Falls auf dem System vorhanden, sind diese Module auch für Pivy verfügbar. Das Coin Modul ist immer vorhanden, und wir werden es sowieso verwenden, da wir uns nicht darum kümmern müssen, unsere 3D Darstellung in irgendeiner Schnittstelle zu verankern, was bereits von FreeCAD getan wird. Alles, was wir tun müssen, ist dies: |
|||
<div class="mw-translate-fuzzy"> |
|||
Die Coin3d-Bibliothek ist in mehrere Teile geteilt, Coin selbst, für die Manipulation von Szenengraphen und Bindungen für mehrere GUI-Systeme, wie z.B. Windows, oder, wie in unserem Fall, qt. Diese Module stehen auch in pivy zur Verfügung, abhängig davon, ob sie auf dem System vorhanden sind. |
|||
Das Coin Modul ist immer vorhanden, und es ist das, was wir ohnehin verwenden werden, somit brauchen wir uns nicht mehr um unsere Verankerung des 3D Display in jeder Oberfläche zu kümmern, dies wird bereits durch FreeCAD selbst getan. Alles, was wir tun müssen, ist dies: |
|||
</div> |
|||
{{Code|code= |
{{Code|code= |
||
Line 23: | Line 21: | ||
}} |
}} |
||
<span id="Scenegraph"></span> |
|||
<div class="mw-translate-fuzzy"> |
|||
== |
==Szenengraph== |
||
</div> |
|||
⚫ | Wir haben auf der [[Scenegraph/de|Szenengraph]] Seite gesehen, wie eine typische Coin szene organisiert ist. Alles, was in einer [[3D_view/de|3D Ansicht]] erscheint, ist ein Coin Szenegraph, der auf die gleiche Weise organisiert ist. Wir haben einen Wurzelknoten, und alle Objekte auf dem Bildschirm sind seine Kinder. |
||
<div class="mw-translate-fuzzy"> |
|||
⚫ | |||
</div> |
|||
FreeCAD hat eine einfache Möglichkeit, auf den Root-Knoten eines 3D-Ansicht Szenengraph zugreifen: |
FreeCAD hat eine einfache Möglichkeit, auf den Root-Knoten eines 3D-Ansicht Szenengraph zugreifen: |
||
Line 51: | Line 46: | ||
}} |
}} |
||
⚫ | |||
<div class="mw-translate-fuzzy"> |
|||
⚫ | |||
</div> |
|||
Lasst uns versuchen, jetzt etwas zu unserem Szenengraph hinzuzufügen. Wir fügen einen schönen roten Würfel ein: |
Lasst uns versuchen, jetzt etwas zu unserem Szenengraph hinzuzufügen. Wir fügen einen schönen roten Würfel ein: |
||
Line 67: | Line 60: | ||
}} |
}} |
||
Versuchen wir Folgendes: |
|||
<div class="mw-translate-fuzzy"> |
|||
und da ist unser (schöner) roter Würfel. Jetzt wollen wir dies hier versuchen: |
|||
</div> |
|||
{{Code|code= |
{{Code|code= |
||
Line 75: | Line 66: | ||
}} |
}} |
||
⚫ | Wie du siehst, ist alles nach wie vor zugänglich und gleichzeitig veränderbar. Du musst nichts neu berechnen oder neu zeichnen, Coin kümmert sich um alles. Du kannst deinem Szenegraphen Sachen hinzufügen, Eigenschaften ändern, Sachen ausblenden, temporäre Objekte anzeigen, alles. Dies betrifft natürlich nur die Darstellung in der 3D Ansicht. Diese Anzeige wird von FreeCAD bei geöffneter Datei neu berechnet, und wenn ein Objekt neu berechnet werden muss. Wenn du also den Aspekt eines bestehenden FreeCAD Objekts änderst, gehen diese Änderungen verloren, wenn das Objekt neu berechnet wird oder wenn du die Datei erneut öffnest. |
||
<div class="mw-translate-fuzzy"> |
|||
⚫ | |||
Also, diese Änderungen gehen verloren, wenn Sie den Aspekt eines vorhandenen FreeCAD-Objekts ändern, wenn das Objekt neu berechnet wird oder wenn Sie die Datei wiederer öffnen. |
|||
</div> |
|||
Wie bereits erwähnt, ist in einer openInventor Szenografie die Reihenfolge wichtig. Ein Knoten beeinflusst, was als nächstes kommt. Wenn wir zum Beispiel die Möglichkeit haben wollen, unseren Würfel zu bewegen, müssen wir einen {{incode|SoTranslation}} Knoten {{Emphasis|before}} dem Würfel hinzufügen |
|||
<div class="mw-translate-fuzzy"> |
|||
Ein Schlüssel zum Bearbeiten des Szenengraphen mit Ihren Skripten ist, in der Lage zu sein, auf bestimmte Eigenschaften der Knoten die Sie hinzugefügten, bei Bedarf zugreifen zu können. Zum Beispiel, wenn wir unseren Würfel bewegen wollten, hätten wir einen SoTranslation-Knoten zu unserem benutzerdefinierten Knoten hinzugefügt, und es hätte dann so ausgesehen: |
|||
</div> |
|||
{{Code|code= |
{{Code|code= |
||
Line 97: | Line 83: | ||
}} |
}} |
||
Um unseren Würfel zu bewegen, können wir jetzt folgendes tun: |
|||
<div class="mw-translate-fuzzy"> |
|||
Denken Sie daran, dass in einem OpenInventor-Szenengraph, die Reihenfolge wichtig ist. Ein Knoten beeinflusst das, was als nächstes kommt, so können Sie etwas sagen wie: Farbe rot, Würfel, Farbe gelb, Kugel, und Sie werden einen roten Würfel und eine gelbe Kugel bekommen. Wenn wir das Verschieben jetzt zu unserem vorhandenen benutzerdefinierten Knoten hinzufügen würden, würde es nach dem Würfel kommen, und diesen nicht betreffen. Wenn wir es bei der Erstellung eingefügt hätten, wie hier oben, könnten wir jetzt folgendes tun: |
|||
</div> |
|||
{{Code|code= |
{{Code|code= |
||
Line 105: | Line 89: | ||
}} |
}} |
||
Zum Schluß etwas entfernen wird ausgeführt mit: |
|||
<div class="mw-translate-fuzzy"> |
|||
Und unser Würfel würde damit 2 Einheiten nach rechts springen. |
|||
Schließlich wird das Entfernen von etwas, wie folgt erledigt: |
|||
</div> |
|||
{{Code|code= |
{{Code|code= |
||
sg.removeChild(myCustomNode) |
sg.removeChild(myCustomNode) |
||
}} |
}} |
||
⚫ | |||
<span id="Callbacks"></span> |
|||
[[#top|top]] |
|||
==Rückrufe== |
==Rückrufe== |
||
⚫ | Ein [http://en.wikipedia.org/wiki/Callback_%28computer_science%29 callback mechanism] ist ein System, das es einer Bibliothek, wie z.B. unserer Coin Bibliothek, erlaubt, Sie zurückzurufen, d.h. eine bestimmte Funktion von deinem aktuell laufenden Python Objekt aus aufzurufen. Auf diese Weise kann Coin dich darüber informieren, dass ein bestimmtes Ereignis in der Szene aufgetreten ist. Coin kann sehr unterschiedliche Dinge beobachten, wie z.B. Mausposition, Mausklicks, das Drücken von Tasten auf der Tastatur und vieles mehr. |
||
<div class="mw-translate-fuzzy"> |
|||
⚫ | Ein [http://en.wikipedia.org/wiki/Callback_%28computer_science%29 |
||
</div> |
|||
FreeCAD bietet eine einfache Möglichkeit, solche Rückrufe zu verwenden: |
FreeCAD bietet eine einfache Möglichkeit, solche Rückrufe zu verwenden: |
||
Line 141: | Line 119: | ||
}} |
}} |
||
Die Rückmeldung muss von einem Objekt initiiert werden, da dieses Objekt zum Zeitpunkt der Rückmeldung noch laufen muss. |
|||
<div class="mw-translate-fuzzy"> |
|||
Siehe auch die [[Code_snippets#Observe_mouse_events_in_the_3D_viewer_via_Python|komplette Liste]] von möglichen Ereignissen und deren Parametern, oder die offizielle Coin-Dokumentation. |
|||
Der Rückruf muss von einem Objekt abgesetzt werden, weil das Objekt noch ausgeführt werden muss, wenn der Rückruf auftritt. |
|||
{{Top}} |
|||
Beachten Sie auch die [[Code_snippets#Observing_mouse_events_in_the_3D_viewer_via_Python|complete list]] möglicher Ereignisse und deren Parameter, oder die [http://doc.coin3d.org/Coin/classes.html offiziellen coin-Dokumentation]. |
|||
<span id="Documentation"></span> |
|||
</div> |
|||
[[#top|Anfang]] |
|||
==Dokumentation== |
==Dokumentation== |
||
Line 166: | Line 141: | ||
* [https://github.com/coin3d Coin3D] Startseite. |
* [https://github.com/coin3d Coin3D] Startseite. |
||
* [https://github.com/coin3d/pivy Pivy] Startseite. |
* [https://github.com/coin3d/pivy Pivy] Startseite. |
||
* [https:// |
* [https://github.com/coin3d/coin/wiki Coin3D wiki], auf GitHub. |
||
* |
*[https://github.com/coin3d/coin/wiki/Documentation Coin3D wiki documentation], auf GitHub. |
||
* [https:// |
* [https://coin3d.github.io/Coin/html/ Coin3D Documentation], die neueste automatisch generierte Doxygen-Dokumentation. |
||
* [https://webdocs.cs.ualberta.ca/~graphics/books/mentor.pdf (Open)Inventor Mentor] - empfohlen. |
|||
<span id="Older"></span> |
|||
===Ältere=== |
|||
These links provide reference documentation for Coin v3.x. The differences with v4.x are minimal, so they may still be useful. |
|||
* [https://coin3d.bitbucket.io/Coin/index.html Coin3D Documentation], at BitBucket. |
|||
[[#top|Anfang]] |
|||
* [https://grey.colorado.edu/coin3d/index.html Coin3D Documentation], at University of Colorado. |
|||
* [https://mevislabdownloads.mevis.de/docs/current/MeVis/ThirdParty/Documentation/Publish/OpenInventorReference/index.html Open Inventor Reference Documentation], by MeVisLab. |
|||
{{Top}} |
|||
{{Docnav/de |
{{Docnav/de |
||
Line 180: | Line 164: | ||
[[Category:Developer Documentation{{#translation:}}]] |
[[Category:Developer Documentation{{#translation:}}]] |
||
[[Category:Python Code{{#translation:}}]] |
[[Category:Python Code{{#translation:}}]] |
||
⚫ |
Latest revision as of 07:47, 9 April 2023
Einführung
Pivy ist eine Python Bindungsbibliothek für Coin, die 3D Rendering Bibliothek, die in FreeCAD verwendet wird, um Dinge in einer 3D Ansicht anzuzeigen. Coin ist eine quelloffene Implementierung der "Open Inventor" Spezifikation zur Handhabung von Grafiken. Daher beziehen sich in FreeCAD die Begriffe "Pivy", "Coin" oder "Open Inventor" im Wesentlichen auf die gleiche Sache.
Wenn in einen laufenden Python-Interpreter importiert, erlaubt Pivy direkt mit jedem laufenden Coin-Szenengraph, wie z.B. der 3D-Ansicht zu kommunizieren, oder sogar neue zu erstellen. Pivy ist nicht erforderlich, um FreeCAD zu kompilieren, aber es wird zur Laufzeit benötigt, wenn auf Python basierende Arbeitsbereiche ausgeführt werden, die Formen auf dem Bildschirm erstellen, wie die Arbeitsbereiche Draft und Arch. Aus diesem Grund wird Pivy normalerweise installiert, wenn eine Distribution von FreeCAD installiert wird.
Die Coin Bibliothek ist in mehrere Teile unterteilt, Coin selbst zur Manipulation von Szenegraphen und Bindungen für verschiedene GUI Systeme wie Windows und Qt. Falls auf dem System vorhanden, sind diese Module auch für Pivy verfügbar. Das Coin Modul ist immer vorhanden, und wir werden es sowieso verwenden, da wir uns nicht darum kümmern müssen, unsere 3D Darstellung in irgendeiner Schnittstelle zu verankern, was bereits von FreeCAD getan wird. Alles, was wir tun müssen, ist dies:
from pivy import coin
Szenengraph
Wir haben auf der Szenengraph Seite gesehen, wie eine typische Coin szene organisiert ist. Alles, was in einer 3D Ansicht erscheint, ist ein Coin Szenegraph, der auf die gleiche Weise organisiert ist. Wir haben einen Wurzelknoten, und alle Objekte auf dem Bildschirm sind seine Kinder.
FreeCAD hat eine einfache Möglichkeit, auf den Root-Knoten eines 3D-Ansicht Szenengraph zugreifen:
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
print(sg)
Dies gibt den Root-Knoten aus:
<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >
Wir können die unmittelbaren Kinder unserer Szene untersuchen:
for node in sg.getChildren():
print(node)
Einige dieser Knoten, wie SoSeparator
oder SoGroup
, können selbst Kinder haben. Die vollständige Liste der verfügbaren Coin Objekte findest du in der offiziellen Coin Dokumentation.
Lasst uns versuchen, jetzt etwas zu unserem Szenengraph hinzuzufügen. Wir fügen einen schönen roten Würfel ein:
col = coin.SoBaseColor()
col.rgb = (1, 0, 0)
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode.addChild(col)
myCustomNode.addChild(cub)
sg.addChild(myCustomNode)
Versuchen wir Folgendes:
col.rgb = (1, 1, 0)
Wie du siehst, ist alles nach wie vor zugänglich und gleichzeitig veränderbar. Du musst nichts neu berechnen oder neu zeichnen, Coin kümmert sich um alles. Du kannst deinem Szenegraphen Sachen hinzufügen, Eigenschaften ändern, Sachen ausblenden, temporäre Objekte anzeigen, alles. Dies betrifft natürlich nur die Darstellung in der 3D Ansicht. Diese Anzeige wird von FreeCAD bei geöffneter Datei neu berechnet, und wenn ein Objekt neu berechnet werden muss. Wenn du also den Aspekt eines bestehenden FreeCAD Objekts änderst, gehen diese Änderungen verloren, wenn das Objekt neu berechnet wird oder wenn du die Datei erneut öffnest.
Wie bereits erwähnt, ist in einer openInventor Szenografie die Reihenfolge wichtig. Ein Knoten beeinflusst, was als nächstes kommt. Wenn wir zum Beispiel die Möglichkeit haben wollen, unseren Würfel zu bewegen, müssen wir einen SoTranslation
Knoten before dem Würfel hinzufügen
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)
Um unseren Würfel zu bewegen, können wir jetzt folgendes tun:
trans.translation.setValue([2, 0, 0])
Zum Schluß etwas entfernen wird ausgeführt mit:
sg.removeChild(myCustomNode)
Rückrufe
Ein callback mechanism ist ein System, das es einer Bibliothek, wie z.B. unserer Coin Bibliothek, erlaubt, Sie zurückzurufen, d.h. eine bestimmte Funktion von deinem aktuell laufenden Python Objekt aus aufzurufen. Auf diese Weise kann Coin dich darüber informieren, dass ein bestimmtes Ereignis in der Szene aufgetreten ist. Coin kann sehr unterschiedliche Dinge beobachten, wie z.B. Mausposition, Mausklicks, das Drücken von Tasten auf der Tastatur und vieles mehr.
FreeCAD bietet eine einfache Möglichkeit, solche Rückrufe zu verwenden:
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()
Die Rückmeldung muss von einem Objekt initiiert werden, da dieses Objekt zum Zeitpunkt der Rückmeldung noch laufen muss. Siehe auch die komplette Liste von möglichen Ereignissen und deren Parametern, oder die offizielle Coin-Dokumentation.
Dokumentation
Leider verfügt Pivy nicht über eine eigene Dokumentation. Da es sich jedoch um einen genauen Wrapper der Coin Bibliothek handelt, kannst du zur Information die C++ Referenz lesen. In diesem Fall musst du den C++ Klassennamensstil in Python Stil übersetzen.
In C++:
SoFile::getClassTypeId()
In Pivy:
SoFile.getClassId()
- Coin3D Startseite.
- Pivy Startseite.
- Coin3D wiki, auf GitHub.
- Coin3D wiki documentation, auf GitHub.
- Coin3D Documentation, die neueste automatisch generierte Doxygen-Dokumentation.
- (Open)Inventor Mentor - empfohlen.
Ältere
These links provide reference documentation for Coin v3.x. The differences with v4.x are minimal, so they may still be useful.
- Coin3D Documentation, at BitBucket.
- Coin3D Documentation, at University of Colorado.
- Open Inventor Reference Documentation, by MeVisLab.
- FreeCAD scripting: Python, Introduction to Python, Python scripting tutorial, FreeCAD Scripting Basics
- Modules: Builtin modules, Units, Quantity
- Workbenches: Workbench creation, Gui Commands, Commands, Installing more workbenches
- Meshes and Parts: Mesh Scripting, Topological data scripting, Mesh to Part, PythonOCC
- Parametric objects: Scripted objects, Viewproviders (Custom icon in tree view)
- Scenegraph: Coin (Inventor) scenegraph, Pivy
- Graphical interface: Interface creation, Interface creation completely in Python (1, 2, 3, 4, 5), PySide, PySide examples beginner, intermediate, advanced
- Macros: Macros, How to install macros
- Embedding: Embedding FreeCAD, Embedding FreeCADGui
- Other: Expressions, Code snippets, Line drawing function, FreeCAD vector math library (deprecated)
- Hubs: User hub, Power users hub, Developer hub