Revit-API-Ansichtsfilter: Erstellen und Verwalten

Was lernen Sie in dieser Anleitung?

Ansichtsfilter in der Revit API können steuern, welche Elemente in einer Ansicht angezeigt werden und wie sie dort aussehen. In dieser Anleitung behandeln wir zwei Filtertypen: ParameterFilterElement, das mit Kategorien und Parameterbedingungen arbeitet, sowie SelectionFilterElement, das bestimmte Element-IDs umfasst. Wir zeigen Schritt für Schritt, wie Sie Filter erstellen, einer Ansicht hinzufügen, die Sichtbarkeit ändern und grafische Einstellungen anwenden.

In der Architektur­dokumentation lässt sich dieser Ansatz beispielsweise nutzen, um Wände auszublenden, die bestimmte Bedingungen erfüllen, oder ausgewählte Elemente durch eine andere Linienfarbe hervorzuheben. Dies sind beispielhafte Anwendungsszenarien; die verwendeten Kategorien und Regeln sollten auf die Anforderungen des jeweiligen Projekts abgestimmt werden.

Voraussetzungen und Versionsprüfung

Diese Anleitung richtet sich an die Entwicklung von Add-ins mit der Revit API. Sie beschreibt keine Schritte in der Revit-Benutzeroberfläche. Die API-Erläuterungen in den Quellen behandeln das Erstellen und Bearbeiten von Filtern für ein Revit-Dokument und eine Ansicht. Es werden keine besonderen Kontotypen, Kosten oder zusätzlichen Hardwareanforderungen genannt.

Wichtig ist, die API-Dokumentation für die angestrebte Revit-Version heranzuziehen. Laut Autodesks Erläuterungen zur Revit-2024-API können Entwickler die mit dem SDK gelieferte Hilfedatei RevitAPI.chm und die Projektmappe Samples\SDKSamples.sln als Referenz verwenden. Gehen Sie nicht davon aus, dass Code, der für eine ältere Version geschrieben wurde, in einer neueren unverändert funktioniert.

In Revit 2024 wurde beispielsweise die interne Speicherung von ElementId von 32 auf 64 Bit erweitert. An die Stelle der früheren Eigenschaft IntegerValue trat Value, das den vollständigen 64-Bit-Wert zurückgibt. Autodesk weist darauf hin, dass bei Code, der für frühere API-Versionen kompiliert wurde, Probleme mit Typkonvertierungen auftreten können und dieser Code für die Revit-2024-API neu kompiliert werden muss. Prüfen Sie daher bei der Filterentwicklung die Klassen und Methoden in der Dokumentation der Zielversion.

Schritt für Schritt: einen Parameterfilter erstellen

1. Kategorie und Bedingungen festlegen. ParameterFilterElement verwendet eine oder mehrere zulässige Kategorien sowie Regeln, die auf Elemente dieser Kategorien angewendet werden. Legen Sie vor dem Erstellen des Filters fest, welche Elementgruppe er erfassen und nach welchen Parameterwerten er suchen soll. In Autodesks Beispiel wird die Kategorie „Wände“ ausgewählt. Zu den Regeln gehören die Wandfunktion „Exterior“ und ein Längenwert, der einem bestimmten Schwellenwert entspricht oder darüber liegt.

2. Filterelement erstellen und Regeln zuweisen. ParameterFilterElement.Create erstellt anhand des Dokuments, des Filternamens und der Kategorienliste das Filterelement. Sobald die Regeln feststehen, werden sie mit SetRules zugewiesen. Die Quelle zeigt Beispiele für Gleichheit, einen Wert größer oder gleich einem Schwellenwert sowie eine Textanfangsbedingung. Das bedeutet nicht, dass in jedem Projekt dieselben Parameter verwendet werden; die Regel muss zu den jeweiligen Kategorien und Parametern passen.

3. Filter mit der Ansicht verknüpfen. View.AddFilter() wendet den Filter auf die Zielansicht an. Dieser Aufruf verwendet jedoch standardmäßige grafische Überschreibungen. Daher ist der Filter möglicherweise angewendet, ohne dass sich in der Darstellung ein sichtbarer Unterschied zeigt. Betrachten Sie das Vorhandensein des Filters und seine sichtbare Wirkung in der Ansicht als getrennte Aspekte.

4. Sichtbarkeit festlegen. View.SetFilterVisibility() bestimmt, ob Elemente sichtbar sind, die den Filterbedingungen entsprechen. Ist der Filter noch nicht auf die Ansicht angewendet, fügt diese Methode ihn zugleich der Ansicht hinzu. Ein zusätzlicher Aufruf von AddFilter() ist daher nicht zwingend erforderlich. Sollen beispielsweise passende Elemente ausgeblendet werden, muss die Sichtbarkeit entsprechend eingestellt werden.

5. Grafikeinstellungen anwenden. Mit View.SetFilterOverrides() lassen sich Darstellungseigenschaften wie die Linienfarbe von Elementen ändern, die dem Filter entsprechen. Vorhandene Einstellungen können mit View.GetFilterOverrides() abgerufen werden. So kann ein Filter nicht nur die Sichtbarkeit steuern, sondern Elemente in der Ansicht auch visuell hervorheben.

Schritt für Schritt: Auswahlfilter und Filter bearbeiten

1. Elemente für den Filter bestimmen. SelectionFilterElement arbeitet nicht mit Parameterregeln, sondern mit den IDs einer Elementgruppe. Im Beispiel der Quelle werden zunächst Raumstempel in einer bestimmten Ansicht gesammelt. Anschließend werden die IDs der Stempel, die eine Bedingung für die Raumnummer erfüllen, einer Liste hinzugefügt. Bei diesem Verfahren ergibt sich der Filterumfang aus den ausgewählten Element-IDs, nicht aus Filterregeln.

2. Auswahlfilter erstellen. Mit SelectionFilterElement.Create wird das Filterelement erstellt; SetElementIds weist ihm die Element-IDs zu. Anschließend wird die Filter-ID über View.AddFilter() zur Zielansicht hinzugefügt. Prüfen Sie, ob die richtigen Elemente erfasst wurden, um unerwartete Ergebnisse zu vermeiden.

3. Optional grafische Überschreibungen hinzufügen. Im Beispiel von Autodesk werden die vorhandenen Filtereinstellungen der Ansicht abgerufen, die Linienfarbe auf Blau gesetzt und die Einstellung mit View.SetFilterOverrides() angewendet. Das Beispiel zeigt, wie sich einem Auswahlfilter eine grafische Einstellung hinzufügen lässt. Die verwendete Farbe und andere Darstellungsentscheidungen sollten sich nach den Projektstandards richten.

4. Vorhandene Filter prüfen. View.GetFilters() gibt die IDs der Filter in einer Ansicht zurück. Die Sichtbarkeit eines bestimmten Filters lässt sich mit View.GetFilterVisibility(), seine Grafikeinstellungen mit View.GetFilterOverrides() prüfen. View.RemoveFilter() entfernt den Filter aus der Ansicht. Um vorhandene Einstellungen zu ändern, lesen Sie zunächst die Filterwerte aus und wenden Sie anschließend mit View.SetFilterOverrides() die passenden Grafikeinstellungen an.

In Autodesks Beispielen werden Änderungen am Dokument innerhalb einer Transaktion vorgenommen. Beachten Sie beim Erstellen von Filtern, beim Verknüpfen mit einer Ansicht und beim Ändern grafischer Einstellungen, dass diese Vorgänge das Dokument verändern. Wenn Sie die einzelnen Funktionen getrennt prüfen, lässt sich leichter feststellen, ob ein Problem an der Filterregel, der Sichtbarkeit oder den Grafikeinstellungen liegt.

Häufige Fehler und nächste Schritte

Der Filter wurde hinzugefügt, aber die Ansicht hat sich nicht verändert: AddFilter() verwendet standardmäßige Grafikeinstellungen und muss allein keine sichtbare Änderung bewirken. Prüfen Sie SetFilterVisibility() für die Sichtbarkeit und SetFilterOverrides() für grafische Unterschiede.

Die Regel findet nicht die erwarteten Elemente: Überprüfen Sie erneut die zulässigen Kategorien des Filters und die in den Bedingungen verwendeten Parameter. Da ein Parameterfilter auf Kategorien beschränkt ist, werden Elemente aus anderen Kategorien nicht erfasst, selbst wenn sie die Regel erfüllen.

Der Auswahlfilter enthält die falschen Elemente: Prüfen Sie vor SetElementIds die erstellte ID-Liste und die Auswahlbedingungen, anhand derer sie zusammengestellt wurde. Dieser Filtertyp wendet Parameterregeln nicht automatisch an; die IDs der gewünschten Elemente müssen dem Filter explizit zugewiesen werden.

Das Add-in macht in einer anderen Revit-Version Probleme: Prüfen Sie die API-Änderungen der Zielversion. Die 64-Bit-Änderung von ElementId in Revit 2024 kann eine Neukompilierung von Code erforderlich machen, der für eine ältere API erstellt wurde. Testen Sie das Add-in vor der Entwicklung oder Aktualisierung in einer Testansicht und gleichen Sie die verwendete API-Dokumentation mit der Zielversion ab.

Für Architektur-, Innenarchitektur- und Visualisierungsteams können Filter besonders dann hilfreich sein, wenn Elementgruppen in Ansichten einheitlich verwaltet werden müssen. Ein Parameterfilter beschreibt Kriterien anhand von Kategorien und Regeln; ein Auswahlfilter konzentriert sich dagegen auf eine direkt festgelegte Elementgruppe. Welche Methode geeignet ist, hängt vom Ansichtsstandard und davon ab, wie die Elemente ausgewählt werden sollen. Auch die Add-in-Kompatibilität und Versionswechsel sollten in den Arbeitsablauf einbezogen werden.

Beginnen Sie bei der Umsetzung mit einer kleinen Testansicht: Beschränken Sie zunächst den Umfang und prüfen Sie anschließend Filtertreffer, Sichtbarkeit und Grafikeinstellungen getrennt voneinander. Wenn das Ergebnis wie erwartet funktioniert, können Sie den Ansatz an die Projektstandards anpassen.

Quelle und Lizenz

Diese Anleitung basiert auf Autodesks Erläuterung „View Filters“ im Revit API Developers Guide sowie auf Autodesks Hilfetext zu den API-Änderungen in Revit 2024. Die Quellen sind laut den angegebenen Lizenzinformationen frei zugänglich. Der Text ist eine türkische Adaption der technischen Erläuterungen aus den Quellen.