Erstellen von DynamoRevit aus Quelldateien
Last updated
Last updated
Die DynamoRevit-Quelldateien werden auch im DynamoDS-GitHub gehostet, damit Entwickler Beiträge einbringen und Beta-Versionen erstellen können. Die Erstellung von DynamoRevit aus Quelldateien folgt im Allgemeinen dem gleichen Prozess wie bei Dynamo, mit Ausnahme einiger wichtiger Details:
DynamoRevit referenziert Dynamo-Assemblys. Diese sollten daher mit entsprechenden NuGet-Paketen erstellt werden. DynamoRevit 2.x lässt sich beispielsweise nicht in Dynamo 1.3 laden.
DynamoRevit ist für bestimmte Revit-Versionen spezifisch. Beispiel: Die Verzweigung DynamoRevit 2018 muss unter Revit 2018 ausgeführt werden.
In diesem Handbuch verwenden wir folgende Versionen:
Revit 2023
Den neuesten DynamoRevit-Build in der Verzweigung Revit2023
Den neuesten Dynamo-Build
Um einen erfolgreichen Build zu gewährleisten, werden sowohl das Dynamo- als auch das DynamoRevit-Repository, die für diese exemplarische Vorgehensweise verwendet werden, geklont und erstellt.
Anmerkung: Die manuelle Erstellung von Dynamo vor DynamoRevit ist nur erforderlich, wenn Sie Dynamo 1.x und DynamoRevit 1.x erstellen. Neuere Versionen des DynamoRevit-Repositorys basieren auf dem NuGet-Paket-Manager für die zum Erstellen erforderlichen Dynamo-Abhängigkeiten. Auch wenn beim Build Dynamo Revit 2.x kein manueller Abruf von Dynamo erforderlich ist, benötigen Sie die dlls -Kerndateien dennoch an anderer Stelle, um das Dynamo Revit-addin auszuführen. Es lohnt sich also, Dynamo dennoch abzurufen und zu erstellen. Weitere Informationen finden Sie unten: Erstellen des Repositorys mit Visual Studio
Der Code für das DynamoRevit-Projekt befindet sich in einem separaten Repository auf GitHub, nicht in dem Repository, in dem sich der Dynamo-Kernquellcode befindet. Dieses Repository enthält die Quelldateien für Revit-spezifische Blöcke und das Revit-Zusatzmodul, das Dynamo lädt. Builds von DynamoRevit für verschiedene Versionen von Revit (z. B. 2016, 2017 oder 2018) sind im Repository als Verzweigungen angeordnet.
Die DynamoRevit-Quelldateien befinden sich hier: https://github.com/DynamoDS/DynamoRevit.
Klonen oder laden Sie das Repository herunter.
Die DynamoRevit-Verzweigungen referenzieren Revit-Versionen.
Ähnlich wie beim Abrufen des Dynamo-Repositorys verwenden wir den Git-Befehl zum Klonen, um DynamoRevit zu klonen und die Verzweigung anzugeben, die unserer Revit-Version entspricht. Zunächst öffnen wir eine Befehlszeilenschnittstelle und legen das aktuelle Verzeichnis auf den Speicherort fest, an den wir die Dateien klonen möchten.
cd C:\Users\username\Documents\GitHub ändert das aktuelle Verzeichnis.
Ersetzen Sie
usernamedurch Ihren Benutzernamen.
Jetzt können wir das Repository in dieses Verzeichnis klonen. Wir müssen eine Verzweigung des Repositorys angeben. Wir können jedoch nach dem Klonen zu dieser Verzweigung wechseln.
git clone https://github.com/DynamoDS/DynamoRevit.git klont das Repository von einer Remote-URL und wechselt vorgabemäßig zur Hauptverzweigung.
Nachdem das Klonen des Repositorys abgeschlossen ist, ändern Sie das aktuelle Verzeichnis in den Repository-Ordner, und wechseln Sie zu der Verzweigung, die der installierten Version von Revit entspricht. In diesem Beispiel wird Revit RC2.13.1_Revit2023 verwendet. Alle Remote-Verzweigungen können auf der GitHub-Seite im Dropdown-Menü Branch angezeigt werden.
cd C:\Users\username\Documents\GitHub\DynamoRevit ändert das Verzeichnis in DynamoRevit.
git checkout RC2.13.1_Revit2023 setzt die aktuelle Verzweigung auf RC2.13.1_Revit2023.
git branch überprüft, in welcher Verzweigung wir uns befinden, und zeigt die anderen Verzweigungen an, die lokal verfügbar sind.
Die Verzweigung mit einem Sternchen ist die derzeit ausgecheckte Verzweigung. Die Verzweigung
Revit2018wird angezeigt, da wir diese zuvor ausgecheckt haben, sodass sie lokal verfügbar ist.
Es ist wichtig, die richtige Verzweigung des Repositorys zu wählen, um sicherzustellen, dass beim Erstellen des Projekts in Visual Studio Assemblys in der richtigen Version des Revit-Installationsverzeichnisses referenziert werden, insbesondere RevitAPI.dll und RevitAPIUI.dll.
Bevor wir das Repository erstellen, müssen wir die NuGet-Pakete mit der Datei restorepackages.bat im Ordner src wiederherstellen. Diese BAT-Datei verwendet den NuGet-Paket-Manager, um die für DynamoRevit erforderlichen, erstellten Binärdateien von Dynamo Core abzurufen. Sie können diese auch manuell erstellen, aber nur, wenn Sie nur Änderungen an DynamoRevit und nicht an Dynamo Core vornehmen. So können Sie schneller durchstarten. Führen Sie diese Datei als Administrator aus.
Klicken Sie mit der rechten Maustaste auf
restorepackages.bat, und wählen SieRun as administrator.
Wenn die Pakete erfolgreich wiederhergestellt wurden, wird ein packages-Ordner mit den neuesten NuGet-Beta-Paketen zum Ordner src hinzugefügt.
Die neuesten Dynamo-NuGet-Beta-Pakete
Nachdem die Pakete wiederhergestellt wurden, öffnen Sie die Visual Studio-Projektmappendatei DynamoRevit.All.sln in src, und erstellen Sie die Projektmappe. Der Build kann AssemblySharedInfo.cs möglicherweise zunächst nicht finden. Wenn dies der Fall ist, kann dieses Problem durch erneutes Ausführen des Builds behoben werden.
Wählen Sie
Build > Build Solutionaus.Überprüfen Sie im Ausgabefenster, ob die Erstellung erfolgreich war. Es sollte eine Meldung ähnlich der folgenden angezeigt werden:
===== Build: 13 succeeded, 0 failed, 0 up-to-date, 0 skipped =====.
Revit benötigt eine Zusatzmoduldatei, um DynamoRevit zu erkennen. Diese würde vom Installationsprogramm automatisch erstellt. In der Entwicklung müssen wir manuell eine Zusatzmoduldatei erstellen, die auf den gewünschten Build von DynamoRevit verweist, insbesondere auf die Assembly DynamoRevitDS.dll. Außerdem müssen wir DynamoRevit auf einen Dynamo-Build verweisen.
Erstellen Sie eine Dynamo.addin-Datei im Zusatzmodulordner von Revit, der sich unter C:\ProgramData\Autodesk\Revit\Addins\2023 befindet. Wir haben bereits eine Version von DynamoRevit installiert, daher bearbeiten wir einfach die vorhandene Datei, um auf den neuen Build zu verweisen.
Geben Sie den Dateipfad von DynamoRevitDS.dll in <Assembly>...</Assembly> an.
Alternativ können wir auch festlegen, dass das Zusatzmodul die Versionsauswahl anstelle einer bestimmten Assembly lädt.
Legen Sie den Dateipfad für <Assembly>...</Assembly> auf DynamoRevitVersionSelector.dll fest.
<FullClassName>...</FullClassName> gibt an, welche Klasse aus der Assembly instanziiert werden soll, auf die mit dem oben angegebenen Assembly-Elementpfad verwiesen wurde. Diese Klasse wird als Einstiegspunkt für das Zusatzmodul verwendet.
Außerdem müssen wir die vorhandene Dynamo-Version entfernen, die im Lieferumfang von Revit enthalten ist. Wechseln Sie dazu zu C:\\Program Files\Autodesk\Revit 2023\AddIns , und entfernen Sie die beiden Ordner, die Dynamo enthalten: DynamoForRevit und DynamoPlayerForRevit. Sie können sie entweder löschen oder in einem separaten Ordner sichern, wenn Sie die Originalversion von Dynamo for Revit wiederherstellen müssen.
Der zweite Schritt besteht darin, einen Dateipfad für die Dynamo Core-Assemblys zur Datei Dynamo.config im Ordner bin von DynamoRevit hinzuzufügen. DynamoRevit lädt diese, wenn das Zusatzmodul in Revit geöffnet wird. In dieser Konfigurationsdatei können Sie Ihr DynamoRevit-Zusatzmodul auf verschiedene Versionen von Dynamo Core verweisen, um Änderungen sowohl in Core als auch in DynamoRevit zu entwickeln und zu testen.
Der Code sollte wie folgt aussehen:
Fügen Sie den Verzeichnispfad des Ordners bin zu <add key/> hinzu.
Wir haben Dynamo direkt vor dieser exemplarischen Vorgehensweise geklont und erstellt, um sicherzustellen, dass Dynamo gut mit DynamoRevit funktioniert. Der Verzeichnispfad verweist auf diesen Build.
Wenn wir jetzt Revit öffnen, sollte sich auf der Registerkarte Verwalten ein Dynamo-Zusatzmodul befinden.
Wählen Sie
Manageaus.Klicken Sie auf das Symbol für das Dynamo-Zusatzmodul.
Eine Instanz von DynamoRevit.
Wenn ein Fehler-Dialogfeld mit fehlenden Assemblys angezeigt wird, ist es wahrscheinlich, dass ein Konflikt zwischen den von Ihnen erstellten Versionen von DynamoCore und den Versionen, die Sie zur Laufzeit laden, aufgetreten ist. Beispiel: DynamoRevit mit den neuesten 2.0-Beta-Paketen von DynamoCore funktioniert nicht, wenn Sie versuchen, die Anwendung mit Dynamo 1.3-DLL-Dateien zu starten. Stellen Sie sicher, dass beide Repositorys dieselbe Version aufweisen und DynamoRevit eine übereinstimmende Version der NutGet-Abhängigkeiten abruft. Diese werden in der Datei package.json des DynamoRevit-Repositorys definiert.
Im vorherigen Abschnitt Erstellen von Dynamo aus Quelldateien haben wir das Debugging in Visual Studio kurz vorgestellt und beschrieben, wie Visual Studio an einen Prozess angehängt werden kann. Anhand einer Beispielausnahme im Block Wall.ByCurveAndHeight werden Sie durch das Anhängen an einen Prozess, das Festlegen von Haltepunkten, das Durchgehen durch Code und das Ermitteln der Quelle der Ausnahme mithilfe der Aufrufliste geführt. Diese Debugging-Werkzeuge gelten generell für .NET-Entwicklungsarbeitsabläufe. Daher ist es sinnvoll, sich außerhalb dieses Handbuchs eingehender mit diesen zu beschäftigen.
An den Prozess anhängen: Hierbei wird eine laufende Anwendung zum Debuggen mit Visual Studio verknüpft. Wenn wir für das Verhalten in einem Build von DynamoRevit ein Debugging durchführen möchten, können wir die DynamoRevit-Quelldateien in Visual Studio öffnen und den Revit.exe-Prozess anhängen. Dies ist der übergeordnete Prozess des DynamoRevit-Zusatzmoduls. Visual Studio verwendet eine Symboldatei (.pbd), um die Verbindung zwischen den Assemblys, die DynamoRevit ausführt, und dem Quellcode herzustellen.
Haltepunkte definieren im Quellcode Zeilen, an denen die Anwendung vor dem Ausführen angehalten wird. Wenn ein Block einen Absturz von DynamoRevit verursacht oder ein unerwartetes Ergebnis zurückgibt, können wir einen Haltepunkt zur Quelle des Blocks hinzufügen, um den Vorgang anzuhalten, den Code einzusehen und die Live-Werte der Variablen zu überprüfen, bis wir die Ursache des Problems gefunden haben.
Code durchgehen: Hierbei wird die Quelle Zeile für Zeile durchlaufen. Wir können Funktionen nacheinander ausführen, einen Funktionsaufruf schrittweise ausführen oder die gerade ausgeführte Funktion verlassen.
Die Aufrufliste zeigt die Funktion an, die derzeit von einem Prozess ausgeführt wird, im Vergleich zu den vorherigen Funktionsaufrufen, die diesen Funktionsaufruf veranlasst haben. Visual Studio verfügt über ein Aufruflistenfenster, um dies anzuzeigen. Wenn wir beispielsweise eine Ausnahme außerhalb des Quellcodes erreichen, können wir den Pfad zum aufrufenden Code in der Aufrufliste sehen.
Im Artikel 2,000 Things You Should Know About C# erhalten Sie eine ausführlichere Erläuterung zu Aufruflisten.
Der Block Wall.ByCurveAndHeight gibt eine Ausnahme mit der folgenden Meldung aus, wenn er eine PolyCurve als Kurveneingabe erhält: To BSPlineCurve Not Implemented. Durch das Debugging können wir herausfinden, warum genau der Block diesen Geometrietyp nicht als Eingabe für den Kurvenparameter akzeptiert. In diesem Beispiel wird davon ausgegangen, dass DynamoRevit erfolgreich erstellt wurde und als Zusatzmodul für Revit ausgeführt werden kann.
Der Block Wall.ByCurveAndHeight löst eine Ausnahme aus.
Öffnen Sie zunächst die Projektmappendatei DynamoRevit.All.sln, starten Sie Revit, und starten Sie dann das DynamoRevit-Zusatzmodul. Hängen Sie anschließend im Fenster Attach to Process Visual Studio an den Revit-Prozess an.
Revit und DynamoRevit müssen ausgeführt werden, um als verfügbare Prozesse angezeigt zu werden.
Öffnen Sie das Fenster
Attach to Processdurch Auswahl vonDebug > Attach to Process....Legen Sie
TransportaufDefaultfest.Wählen Sie
Revit.exeaus.Wählen Sie
Attachaus.
Wenn Visual Studio an Revit angehängt ist, öffnen Sie den Wall.ByCurveAndHeight-Quellcode in Wall.cs. Wir finden diesen im Projektmappen-Explorer unter Libraries > RevitNodes > Elements im Bereich Public static constructors der Datei. Legen Sie im Konstruktor des Wandtyps einen Haltepunkt fest, sodass bei Ausführung eines Blocks in Dynamo der Prozess unterbrochen wird und wir die Codezeilen einzeln durchgehen können. Normalerweise beginnen Dynamo-Konstruktoren vom Typ Zero-Touch mit By<parameters>.
Die Klassendatei mit dem Konstruktor für Wall.ByCurveAndHeight.
Legen Sie einen Haltepunkt fest, indem Sie entweder links neben die Zeilennummer klicken oder mit der rechten Maustaste auf die Codezeile klicken und
Breakpoint > Insert Breakpointauswählen.
Nachdem der Haltepunkt festgelegt wurde, muss der Prozess durch die Funktion Wall.ByCurveAndHeight laufen. Die Funktion kann in Dynamo erneut ausgeführt werden, indem erneut eine Verbindung mit einem der Anschlüsse hergestellt wird. Dadurch wird eine erneute Ausführung des Blocks erzwungen. Der Haltepunkt wird in Visual Studio erreicht.
Das Symbol für den Haltepunkt ändert sich, wenn er erreicht wird.
Das Fenster mit der Aufrufliste zeigt die als Nächstes angewendete Methode.
Überspringen Sie nun die einzelnen Zeilen im Konstruktor, bis die Ausnahme erreicht wird. Der gelb hervorgehobene Code ist die nächste auszuführende Anweisung.
Die Debugging-Werkzeuge für die Navigation im Code.
Drücken Sie
Step Over, um den markierten Code auszuführen, und unterbrechen Sie dann die Ausführung, nachdem die Funktion zurückgegeben wurde.Die nächste auszuführende Anweisung, angegeben durch die gelbe Hervorhebung und den Pfeil.
Wenn wir weiter durch die Funktion gehen, erreichen wir die Ausnahme, die im DynamoRevit-Fenster angezeigt wird. Im Fenster mit der Aufrufliste können wir sehen, dass die Ausnahme ursprünglich von einer Methode mit dem Namen Autodesk.Revit.CurveAPIUtils.CreateNurbsCurve ausgelöst wurde. Glücklicherweise wird die Ausnahme hier verarbeitet, sodass Dynamo nicht abgestürzt ist. Der Debugging-Prozess hat den Kontext für das Problem zugänglich gemacht, indem eine andere Methode im Quellcode ermittelt wurde.
Da dies keine Open-Source-Bibliothek ist, können wir dort keine Änderungen vornehmen. Jetzt, da wir über weitere Informationen verfügen, können wir das Problem mit mehr Kontext melden, indem wir eine GitHub-Anfrage übermitteln. Oder wir können eine Lösung für dieses Problem vorschlagen, indem wir eine Pull-Anforderung stellen.
Wenn wir in
Walls.csauf die Anweisung treffen, die die Ausnahme verursacht, gelangen wir durch den Debugging-Prozess so nah wie möglich an die Ursache des Problems im Benutzercode inProtoToRevitCurve.cs.Die Anweisung, die die Ausnahme in
ProtoToRevitCurve.csverursacht.In der Aufrufliste sehen wir, dass die Ausnahme aus Nichtbenutzercode stammt.
Ein Popup-Fenster mit Informationen zur Ausnahme.
Dieser Vorgang kann auf alle Quelldateien angewendet werden, mit denen wir arbeiten. Wenn wir eine Bibliothek mit Zero-Touch-Blöcken für Dynamo Studio entwickeln, können wir die Quelle der Bibliothek öffnen und einen Dynamo-Prozess anhängen, um für die Blockbibliothek ein Debugging durchzuführen. Auch wenn alles perfekt funktioniert, ist das Debugging eine gute Möglichkeit, Code zu prüfen und herauszufinden, wie bestimmte Aspekte funktionieren.
Dieser Vorgang ist fast identisch mit dem Abrufen von Änderungen für Dynamo, mit der Ausnahme, dass wir sicherstellen müssen, dass wir uns in der richtigen Verzweigung befinden. Verwenden Sie den Befehl git branch im DynamoRevit-Repository, um zu sehen, welche Verzweigungen lokal verfügbar und welche derzeit ausgecheckt sind.
cd C:\Users\username\Documents\GitHub\DynamoRevit legt das aktuelle Verzeichnis auf das DynamoRevit-Repository fest.
git branch überprüft, ob wir uns in der richtigen Verzweigung, RC2.13.1_Revit2023, befinden.
git pull origin RC2.13.1_Revit2023 ruft Änderungen aus der Remote-Ursprungsverzweigung RC2.13.1_Revit2023 ab.
Der Ursprung verweist einfach auf die ursprüngliche URL, die wir geklont haben.
Wir sollten hier sorgsam darauf achten, in welcher Verzweigung wir uns gerade befinden und von welcher Verzweigung wir Daten abrufen, um zu vermeiden, dass Änderungen beispielsweise von
RC2.13.1_Revit2023inRevit2018abgerufen werden.
Wie unter Erstellen von Dynamo aus Quelldateien erwähnt, können wir eine Pull-Anforderung erstellen, wenn wir bereit sind, eine Änderung an das DynamoRevit-Repository zu übermitteln. Dabei folgen wir den Richtlinien des Dynamo-Teams, die im Abschnitt zu Pull-Anforderungen beschrieben werden.
