Scripting : Query

Ce chapitre présente le système de Query, permettant de cibler précisément des objets associés à un équipement afin de manipuler et personnaliser leur affichage dans le jumeau numérique 3D.

Dans cet article

    Afficher plus
    Réduire

    Le système de Query permet de récupérer de manière ciblée une partie des objets associés à un équipement pour appeler ensuite des méthodes permettant de manipuler et customiser leur affichage dans le jumeau numérique 3D.

    Principe général

    Un équipement peut être composé de plusieurs objets.

    Par exemple, un portail peut être constitué de deux portes : une porte gauche et une porte droite.

    Grâce au système de Query, il est possible de récupérer uniquement la porte gauche ou la porte droite, même si les deux sont associées au même équipement portail.

    Le résultat d’une Query est un objet JavaScript sur lequel il est possible d’appeler différentes méthodes.

    Principe général du système de Query appliqué aux objets d’un équipement.

    Récupérer des objets selon leur type

    Il est possible de filtrer les objets en fonction de leur type, par exemple les modèles 3D. Pour cela il faut spécifier le caractère . suivi du type à filtrer.

    La liste des types possible est la suivante :

    • model : N’importe quel modèle 3D
    • icon : Les icônes (marqueurs d’équipements)
    • zone : une zone (sols)
    • structure : une structure (mur)
    • polyline : une ligne

    Script JS :

    // Query des objets de type Modèle 3D
    equipment.Query(".model");
    

    Résultat :

    Cette Query retourne tous les objets de type Modèle 3D associés à l’équipement.

    Récupérer des objets selon leur nom

    Il est également possible de récupérer des objets à partir de leur nom. Pour cela il faut spécifier le caractère # suivi du nom de l’objet que l’on cherche.

    La configuration du nom d’un objet se fait directement depuis Forge. Lorsque l’on sélectionne un objet, il est possible de lui associer le nom qu’on souhaite. Ici Camion.

    Script JS :

    // Query des objets portant l’ID "Camion"
    equipment.Query("#Camion");
    

    Résultat :

    Cette Query retourne tous les objets portant le nom Gauche.

    Combiner plusieurs règles dans une Query

    Le système de Query permet de combiner plusieurs critères afin d’affiner la sélection des objets.

    Opérateur AND (ET)

    Pour créer une Query qui doit respecter tous les paramètres, il faut séparer les critères par un espace.

    Script JS :

    // Query des objets de type Modèle 3D et portant l’ID "Gauche"
    equipment.Query(".model #Gauche");
    

    Résultat :

    Cette Query retourne le modèle 3D portant le nom Gauche.

    Opérateur OR (OU)

    Pour créer une Query qui doit respecter au moins un des paramètres, il faut séparer les critères par une virgule.

    Script JS :

    // Query des objets portant l’ID "Gauche" ou l’ID "Droite"
    equipment.Query("#Gauche, #Droite");
    

    Résultat :

    Cette Query retourne les objets portant le nom Gauche ou le nom Droite.