Filtres de vue dans Revit API : guide de création et de gestion

Ce que vous apprendrez dans ce guide

Dans Revit API, un filtre de vue permet de gérer les éléments affichés dans une vue ou leur apparence. Nous allons examiner deux types de filtres : ParameterFilterElement, qui s’appuie sur des catégories et des conditions de paramètres, et SelectionFilterElement, qui regroupe des identifiants d’éléments spécifiques. Nous verrons pas à pas comment créer un filtre, l’ajouter à une vue, modifier la visibilité et appliquer des paramètres graphiques.

Dans la documentation architecturale, cette approche peut par exemple servir à masquer dans une vue les murs qui répondent à certaines conditions ou à distinguer des éléments sélectionnés en leur attribuant une couleur de ligne différente. Il s’agit de scénarios illustratifs ; les catégories et les règles à utiliser doivent être définies en fonction des besoins du projet.

Prérequis et vérification de la version

Ce guide concerne le développement de modules complémentaires avec Revit API ; il ne décrit pas une procédure à suivre dans l’interface utilisateur de Revit. Les explications de l’API dans les sources portent sur la création et la manipulation de filtres dans un document Revit et une vue. Aucune exigence particulière concernant un type de compte, un coût ou du matériel supplémentaire n’est mentionnée.

Il est important de consulter la documentation de l’API correspondant à la version de Revit ciblée. La documentation de l’API Revit 2024 d’Autodesk indique que les développeurs peuvent se référer au fichier d’aide RevitAPI.chm fourni avec le SDK et à la solution Samples\SDKSamples.sln. Il ne faut pas supposer qu’un code écrit pour une ancienne version fonctionnera tel quel dans une nouvelle version.

Par exemple, dans Revit 2024, le stockage interne de la valeur ElementId est passé de 32 à 64 bits. La propriété Value, qui renvoie la valeur complète sur 64 bits, a remplacé l’ancienne propriété IntegerValue. Autodesk indique que certains codes compilés avec les versions précédentes de l’API peuvent rencontrer des problèmes de conversion de types et doivent être recompilés avec l’API Revit 2024. Lors du développement de filtres, il faut donc vérifier les classes et les méthodes dans la documentation de la version ciblée.

Pas à pas : créer un filtre de paramètres

1. Définissez les catégories et les conditions. ParameterFilterElement utilise une ou plusieurs catégories autorisées ainsi que des règles appliquées aux éléments de ces catégories. Avant de créer le filtre, déterminez le groupe d’éléments à inclure et les valeurs de paramètres à rechercher. Dans l’exemple d’Autodesk, la catégorie des murs est sélectionnée ; les règles portent notamment sur la fonction du mur, qui doit être « Exterior », et sur une valeur de longueur égale ou supérieure à un seuil donné.

2. Créez l’élément de filtre et attribuez-lui les règles. ParameterFilterElement.Create crée l’élément de filtre à partir du document, du nom du filtre et de la liste de catégories. Une fois les règles définies, elles sont attribuées au filtre avec SetRules. La source illustre les conditions d’égalité, de valeur supérieure ou égale à un seuil, et de début de texte. Ces exemples ne signifient pas que les mêmes paramètres seront utilisés dans chaque projet ; la règle doit être compatible avec les catégories et les paramètres concernés.

3. Associez le filtre à la vue. View.AddFilter() applique le filtre à la vue cible. Toutefois, cet appel utilise les remplacements graphiques par défaut ; l’application du filtre peut donc ne produire aucune différence visible. Il convient de distinguer la présence du filtre de son effet dans la vue.

4. Réglez la visibilité. View.SetFilterVisibility() détermine si les éléments qui répondent aux conditions du filtre sont visibles. Si le filtre n’a pas encore été appliqué à la vue, cette méthode l’y ajoute également ; il n’est donc pas obligatoire d’appeler AddFilter() séparément. Par exemple, pour masquer les éléments correspondants, réglez la visibilité en conséquence.

5. Appliquez les paramètres graphiques. Pour modifier les propriétés d’affichage des éléments correspondant au filtre, comme la couleur de ligne, vous pouvez utiliser View.SetFilterOverrides(). Les paramètres existants peuvent être récupérés avec View.GetFilterOverrides(). Le filtre peut ainsi servir non seulement à contrôler la visibilité, mais aussi à distinguer visuellement les éléments dans la vue.

Pas à pas : filtre de sélection et modification des filtres

1. Déterminez les éléments à inclure dans le filtre. SelectionFilterElement s’appuie sur les identifiants d’un groupe d’éléments, plutôt que sur des règles de paramètres. Dans l’exemple de la source, les étiquettes de pièce d’une vue donnée sont d’abord collectées, puis les identifiants de celles qui répondent à une condition portant sur le numéro de pièce sont ajoutés à une liste. Avec cette méthode, le filtre repose sur les identifiants des éléments sélectionnés et non sur des règles.

2. Créez le filtre de sélection. L’élément de filtre est créé avec SelectionFilterElement.Create ; les identifiants des éléments lui sont attribués avec SetElementIds. L’identifiant du filtre est ensuite ajouté à la vue cible à l’aide de View.AddFilter(). Vérifier que les éléments concernés ont été correctement collectés aide à limiter les résultats inattendus.

3. Ajoutez, si nécessaire, un remplacement graphique. Dans l’exemple d’Autodesk, les paramètres de filtre existants de la vue sont récupérés, la couleur de ligne est définie sur le bleu, puis l’ensemble est appliqué avec View.SetFilterOverrides(). Cet exemple montre comment ajouter un paramètre graphique à un filtre de sélection ; la couleur et les autres choix visuels doivent être définis selon les normes du projet.

4. Examinez les filtres existants. View.GetFilters() renvoie les identifiants des filtres d’une vue. Vous pouvez vérifier la visibilité d’un filtre donné avec View.GetFilterVisibility() et ses paramètres graphiques avec View.GetFilterOverrides(). View.RemoveFilter() supprime le filtre de la vue. Pour modifier les paramètres existants, commencez par lire les valeurs des filtres, puis appliquez les paramètres graphiques appropriés avec View.SetFilterOverrides().

Dans les exemples d’Autodesk, les opérations qui modifient le document sont exécutées dans une transaction. Lors de la création d’un filtre, de son association à une vue ou de la modification de paramètres graphiques, gardez à l’esprit que ces opérations modifient le document. Vérifier chaque fonction séparément facilite l’identification de l’origine d’un problème : règle du filtre, visibilité ou paramètres graphiques.

Erreurs fréquentes et prochaines étapes

Le filtre a été ajouté, mais la vue n’a pas changé : AddFilter() utilise les paramètres graphiques par défaut et ne produit pas nécessairement un changement visible à lui seul. Vérifiez SetFilterVisibility() pour la visibilité et SetFilterOverrides() pour les différences graphiques.

La règle ne trouve pas les éléments attendus : revérifiez les catégories autorisées du filtre ainsi que les paramètres utilisés dans les conditions. Un filtre de paramètres étant limité à une catégorie, les éléments d’une catégorie hors périmètre ne seront pas inclus, même s’ils répondent à la règle.

Le filtre de sélection inclut les mauvais éléments : examinez la liste d’identifiants créée avant SetElementIds ainsi que les conditions de sélection qui ont servi à la produire. Ce type de filtre n’applique pas automatiquement de règles de paramètres ; les identifiants des éléments visés doivent lui être attribués explicitement.

Le module complémentaire pose problème avec une autre version de Revit : vérifiez les changements de l’API pour la version ciblée. La modification de ElementId en 64 bits dans Revit 2024 peut imposer la recompilation des codes compilés avec une API plus ancienne. Avant le développement ou la mise à jour, il est utile de travailler dans une vue de test et de faire correspondre la documentation de l’API utilisée à la version de Revit.

Pour les équipes d’architecture, d’architecture d’intérieur et de visualisation, les filtres peuvent être utiles lorsqu’il faut gérer de manière cohérente des groupes d’éléments dans les vues. Un filtre de paramètres définit les critères à l’aide de catégories et de règles ; un filtre de sélection cible directement un groupe d’éléments déterminé. Le choix dépend des normes de la vue et de la manière dont les éléments doivent être sélectionnés. La compatibilité des modules complémentaires et les migrations entre versions doivent également être prises en compte dans le flux de travail.

Pour commencer, créez une petite vue de test : limitez d’abord le périmètre, puis vérifiez séparément les correspondances du filtre, la visibilité et les paramètres graphiques. Lorsque le résultat est conforme aux attentes, adaptez l’approche aux normes du projet.

Sources et licence

Ce guide s’appuie sur la section « View Filters » du Revit API Developers Guide d’Autodesk et sur le contenu d’aide d’Autodesk consacré aux changements de l’API Revit 2024. Selon les informations de licence fournies, les sources sont librement accessibles ; ce texte est une adaptation en turc des explications techniques qui y figurent.