Pivy/de: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{docnav/de
{{Docnav/de
|[[Scenegraph/de|Szenengraph]]
|[[Scenegraph/de|Szenengraph]]
|[[PySide/de|PySide]]
|[[PySide/de|PySide]]
}}
}}


{{TOCright}}
[https://bitbucket.org/Coin3D/pivy/src/default/ Pivy] ist eine Python Bindungsbibliothek für [https://bitbucket.org/Coin3D/coin/wiki/Home Coin3d], die in FreeCAD verwendete 3D Rendering Bibliothek. Beim Import in einen laufenden Python-Interpreter ist es möglich, direkt mit allen laufenden Coin3d [[Scenegraph/de|Szenegraphen]], wie beispielsweise den FreeCAD 3D Ansichten, in den Dialog zutreten oder sogar neue zu erstellen. Pivy ist in der Standard FreeCAD Installation enthalten.

==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.

<div class="mw-translate-fuzzy">
Wenn in einen laufenden Python Interpreter importiert wird, erlaubt Pivy direkt mit jeder laufenden Coin zu kommunizieren [[Scenegraph/de|Szenengraph]], wie z.B. der [[3D_view/de|3D Ansicht]], oder sogar neue zu erstellen. Pivy ist nicht erforderlich, um FreeCAD zu kompilieren, aber es wird zur Laufzeit benötigt, wenn Python basierte Arbeitsbereiche ausgeführt werden, die Formen auf dem Bildschirm erstellen, wie [[Draft_Workbench/de|Entwurf Arbeitsbereich]] und [[Arch_Workbench/de|Architektur]]. Aus diesem Grund wird Pivy normalerweise installiert, wenn eine Distribution von FreeCAD installiert wird.
</div>

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:


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:
{{Code|code=
{{Code|code=
from pivy import coin
from pivy import coin
}}
}}
==Zugreifen auf und Ändern im Szenengraph==


==Szenengraph==
Wir sahen in der [[Scenegraph]]-Seite, wie eine typische Münze Szene organisiert ist. Alles, was in einer FreeCAD-3D-Ansicht erscheint, ist ein Coin-Szenengraph und immer auf die gleiche Weise organisiert. Wir haben einen Wurzelknoten, und alle Objekte auf dem Bildschirm sind seine Kinder.

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.


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:

{{Code|code=
{{Code|code=
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
sg = FreeCADGui.ActiveDocument.ActiveView.getSceneGraph()
print sg
print(sg)
}}
}}

Dies gibt den Root-Knoten aus:
Dies gibt den Root-Knoten aus:

{{Code|code=
{{Code|code=
<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >
<pivy.coin.SoSelection; proxy of <Swig Object of type 'SoSelection *' at 0x360cb60> >
}}
}}

Wir können die unmittelbaren Kinder unserer Szene untersuchen:
Wir können die unmittelbaren Kinder unserer Szene untersuchen:

{{Code|code=
{{Code|code=
for node in sg.getChildren():
for node in sg.getChildren():
print node
print(node)
}}
}}

<div class="mw-translate-fuzzy">
Einige dieser Knoten, wie SoSeparators oder SoGroups, können selbst Kinder haben. Die vollständige Liste der verfügbaren Coin-Objekte kann man nachlesen in der [http://coin3d.bitbucket.org/Coin/classes.html offiziellen coin-Dokumentation].
Einige dieser Knoten, wie {{incode|SoSeparator}} oder {{incode|SoGroup}}, können selbst Kinder haben. Die vollständige Liste der verfügbaren Coin Objekte findest du in der offiziellen Coin Dokumentation.
</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:

{{Code|code=
{{Code|code=
col = coin.SoBaseColor()
col = coin.SoBaseColor()
col.rgb=(1,0,0)
col.rgb = (1, 0, 0)
cub = coin.SoCube()
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode = coin.SoSeparator()
Line 44: Line 59:
sg.addChild(myCustomNode)
sg.addChild(myCustomNode)
}}
}}

und da ist unser (schöner) roter Würfel. Jetzt wollen wir dies hier versuchen:
Versuchen wir Folgendes:

{{Code|code=
{{Code|code=
col.rgb=(1,1,0)
col.rgb = (1, 1, 0)
}}
}}
Sehen Sie? Alles ist immer noch zugänglich und on-the-fly modifizierbar. Keine Notwendigkeit, neu zu berechnen oder alles neu zu zeichnen, Coin kümmert sich schon um alles. Sie können Elemnte zum Szenengraph hinzufügen, Eigenschaften ändern, Dinge verbergen, temporäre Objekte anzeigen, einfach alles. Natürlich betrifft diese nur die Anzeige in der 3D-Ansicht. Diese Anzeige wird von FreeCAD bei öffnen einer Datei neu berechnet, und wenn ein Objekt eine Neuberechnung benötigt.
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.


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.
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:

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

{{Code|code=
{{Code|code=
col = coin.SoBaseColor()
col = coin.SoBaseColor()
col.rgb=(1,0,0)
col.rgb = (1, 0, 0)
trans = coin.SoTranslation()
trans = coin.SoTranslation()
trans.translation.setValue([0,0,0])
trans.translation.setValue([0, 0, 0])
cub = coin.SoCube()
cub = coin.SoCube()
myCustomNode = coin.SoSeparator()
myCustomNode = coin.SoSeparator()
Line 64: Line 82:
sg.addChild(myCustomNode)
sg.addChild(myCustomNode)
}}
}}

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:
Um unseren Würfel zu bewegen, können wir jetzt folgendes tun:

{{Code|code=
{{Code|code=
trans.translation.setValue([2,0,0])
trans.translation.setValue([2, 0, 0])
}}
}}

Und unser Würfel würde damit 2 Einheiten nach rechts springen.
Zum Schluß etwas entfernen wird ausgeführt mit:
Schließlich wird das Entfernen von etwas, wie folgt erledigt:

{{Code|code=
{{Code|code=
sg.removeChild(myCustomNode)
sg.removeChild(myCustomNode)
}}
}}
{{Top}}
==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.
==Verwenden von Rückrufmechanismen==

Ein [http://en.wikipedia.org/wiki/Callback_%28computer_science%29 Rückruf-mechanismus] ist ein System, das einer Bibliothek erlaubt, wie zum Beispiel unserer Coin-Bibliothek, uns zurück zu rufen, das heißt, eine bestimmte Funktion von Ihrem laufenden Python-Objekt abzufordern. Das ist äußerst nützlich, weil COIN Sie auf diese Weise benachrichtigen kann, wenn ein bestimmtes Ereignis in der Szene eintritt. Coin kann sehr verschiedene Dinge beobachten, wie zum Beispiel Maus-Position, Mausklicks, gedrückte Tasten der Tastatur, und noch viele andere Dinge.


FreeCAD bietet eine einfache Möglichkeit, solche Rückrufe zu verwenden:
FreeCAD bietet eine einfache Möglichkeit, solche Rückrufe zu verwenden:

{{Code|code=
{{Code|code=
from pivy import coin

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

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

ButtonTest()
ButtonTest()
}}
}}
<div class="mw-translate-fuzzy">
Der Rückruf muss von einem Objekt abgesetzt werden, weil das Objekt noch ausgeführt werden muss, wenn der Rückruf auftritt.
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].
</div>


Der Rückruf muss von einem Objekt initiiert werden, da dieses Objekt zum Zeitpunkt des Rückrufs noch laufen muss.
== Dokumentation ==
Siehe auch eine [[Code_snippets#Observing_mouse_events_in_the_3D_viewer_via_Python|complete list]] von möglichen Ereignissen und deren Parameter, oder die offizielle Coin Dokumentation.
{{Top}}
==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.
<div class="mw-translate-fuzzy">
Leider hat pivy selbst noch keine richtige Dokumentation, aber da es eine genaue Übersetzung von Coin gibt, können Sie problemlos die Coin-Dokumentation als Referenz nutzen, und Python-Stil verwenden, anstatt C++-Stil (z. B. SoFile::getClassTypeId() würde in pivy zu dem werden: SoFile.getClassId())
</div>


In C++:
In C++:

{{Code|code=
{{Code|code=
SoFile::getClassTypeId()
SoFile::getClassTypeId()
}}
}}

In Pivy
In Pivy:

{{Code|code=
{{Code|code=
SoFile.getClassId()
SoFile.getClassId()
}}
}}


<div class="mw-translate-fuzzy">
* [https://grey.colorado.edu/coin3d/index.html Coin Documentation], at University of Colorado
* [https://github.com/coin3d Coin3D] Startseite.
* [https://coin3d.bitbucket.io/Coin/index.html Coin Documentation], at BitBucket
* [https://github.com/coin3d/pivy Pivy] Startseite.
* [https://grey.colorado.edu/coin3d/index.html Coin3D Dokumentation], der Universität von Colorado.
* [https://coin3d.bitbucket.io/Coin/index.html Coin3D Dokumentation], auf BitBucket.
* [https://mevislabdownloads.mevis.de/docs/current/MeVis/ThirdParty/Documentation/Publish/OpenInventorReference/index.html Open Inventor Referenz Dokumentation], von MeVisLab.
</div>


=== Older ===
{{docnav/de|[[Scenegraph/de|Scenegraph]]|[[PySide/de|PySide]]}}


These links provide reference documentation for Coin v3.x. The differences with v4.x are minimal, so they may still be useful.
{{Userdocnavi/de}}


* [https://coin3d.bitbucket.io/Coin/index.html Coin3D Documentation], at BitBucket.
[[Category:Poweruser Documentation/de]]
* [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
|[[Scenegraph/de|Szenengraph]]
|[[PySide/de|PySide]]
}}


{{Powerdocnavi{{#translation:}}}}
{{clear}}
[[Category:Developer Documentation{{#translation:}}]]
[[Category:Python Code{{#translation:}}]]

Revision as of 13:52, 22 October 2021

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 wird, erlaubt Pivy direkt mit jeder laufenden Coin zu kommunizieren Szenengraph, wie z.B. der 3D Ansicht, oder sogar neue zu erstellen. Pivy ist nicht erforderlich, um FreeCAD zu kompilieren, aber es wird zur Laufzeit benötigt, wenn Python basierte Arbeitsbereiche ausgeführt werden, die Formen auf dem Bildschirm erstellen, wie Entwurf Arbeitsbereich und Architektur. 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)

Anfang

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()

Der Rückruf muss von einem Objekt initiiert werden, da dieses Objekt zum Zeitpunkt des Rückrufs noch laufen muss. Siehe auch eine complete list von möglichen Ereignissen und deren Parameter, oder die offizielle Coin Dokumentation.

Anfang

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()

Older

These links provide reference documentation for Coin v3.x. The differences with v4.x are minimal, so they may still be useful.

Anfang