BIMDISPLAY

Icône du lien vers le conceptVoir également Icône du lien vers le conceptExemple

Gestion du contrôle BIM, incluant le chargement des modèles, la gestion des presets et la récupération des propriétés d'objet.

Support WebVue - Non. Renvoie un code d'erreur si exécuté dans ce contexte.

Mode Mnémonique Syntaxe Support WebVue
1 LOADIFC 1 Non
2 SETCOLOR 2 Non
19 SETCOLORBYNAME 3 Non
20 SETCOLORBYINDEX 4 Non
3 RESETCOLOR 5 Non
4 ZOOMOBJECT 6 Non
5 SETOPACITY 7 Non
6 SHOWOBJECTBYTYPE 8 Non
7 SHOWOBJECT 9 Non
11 ADDPRESET 10 Non
9 ADDCUTPLANESETPRESET 11 Non
10 ADDCAMERASETPRESET 12 Non
8 GOTOPRESET 10 Non
12 SAVEPRESETS 13 Non
13 LOADPRESETS 14 Non
14 GETPRESETCOUNT 15 Non
15 GETPRESETNAME 16 Non
16 REMOVEPRESET 10 Non
18 GETIFCPROPERTY 17 Non
17 GETIFCPROPERTIES 18 Non
21 OPENPROPERTIESWINDOW 19 Non
22 GETOBJECTCOUNT 5 Non

Arguments communs à plusieurs modes

Argument Définition
Window Nom de la fenêtre qui contient le contrôle BIM. Type STR.
Branch Branche (si elle existe) de la fenêtre. Utiliser "*" pour indiquer la branche courante du programme. Type STR.
Identity Identifiant du contrôle BIM dans la fenêtre spécifiée. Type STR.
Show Flag pour afficher (1) ou masquer (0) les objets Ifc. Type INTEGER
PresetType

Type de preset. Type INTEGER

0 - Position de la caméra et du plan de coupe
1 - Position du plan de coupe uniquement
2 - Position de la caméra uniquement

PresetName Nom d'un preset. Type STR.
PresetFilename Nom et le chemin d'un fichier Xml où la configuration du preset est stockée. Type STR.
IfcLabelValue Identifiant d'objet Ifc sous la forme de la valeur de la propriété IfcLabel. Type INTEGER
BlinkingTimer

Fréquence de clignotement en millisecondes. Type INTEGER.
Cet argument n'est pris en compte que si les arguments optionnels pour la couleur alternée sont définis.
La valeur doit être un multiple de 500 ms. Dans le cas contraire, elle est automatiquement arrondie à un multiple de 500 ms au moment de l'exécution.
Par exemple, utilisez 2000 pour une couleur clignotante toutes les 2 secondes. La valeur 800 sera arrondie à 1000 et la couleur clignotera chaque seconde.

Comment identifier un objet Ifc

La façon d’identifier un objet Ifc de manière non-ambigüe varie selon la conception du modèle et l’outil utilisé pour le concevoir.
Pour s'adapter aux variations que vous pouvez rencontrer, tous les modes de l'instruction BIMDISPLAY pour lesquels vous devez passer un identifiant d'objet Ifc ont les arguments suivants :

Argument Définition
ObjectIdType

Définit par quelle propriété l'objet Ifc est identifié. Type INTEGER.
1 - IfcLabel - La propriété Ifc Label est utilisée comme identifiant d'objet
2 - GlobaIId - La propriété Ifc GlobalId est utilisée comme identifiant d'objet
3 - Name - La propriété Ifc Name est utilisée comme identifiant d'objet
4 - Réservé pour un usage futur
5 - CustomProperty - Une propriété Ifc personnalisée est utilisée comme identifiant d'objet, le nom de la propriété est passé avec l'argument PropertyName
6 - Réservé pour un usage futur

PropertyName

Quand ObjectIdType est défini à CustomProperty, la valeur de l'argument PropertyName est le nom de la propriété à utiliser pour identifier un objet. Type STR.

PropertyValue

Critère correspondant pour la valeur de la propriété utilisée pour identifier un objet. Type STR.

Par exemple, si vous définissez ObjectIdType à 5 (propriété personnalisée), l'argument PropertyName à la valeur "Reference" et l'argument PropertyValue à la valeur "TL 10", l'action sera effectuée sur tous les objets Ifc pour lesquels la valeur de la propriété "Reference" est égale à "TL 10".

Syntaxe 1

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, IfcFilename[, ConfigFilename]);

Type de retour : LONG.

Argument

Définition

IfcFilename Nom d'un fichier .Ifc. Type STR.
ConfigFilename Nom d'un fichier de configuration .dat associé au modèle BIM pour stocker la configuration des animations. Type STR.

Exécution

Mode

Mnémonique

Action

1 LOADIFC Charge le modèle stocké dans le fichier IfcFile dans le contrôle BIM spécifié et, optionnellement, le fichier de configuration associé ConfigFilename.
Le chemin peut être absolu ou relatif. Si un chemin relatif est spécifié, il est relatif au dossier BIM du projet.
Retour : 1 si OK, 0 sinon.

Syntaxe 2

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, ObjectIdType, PropertyName, PropertyValue, Red, Green, Blue, Opacity [, Red2, Green2, Blue2, Opacity2[, BlinkingTimer]]);

Type de retour : LONG

Argument

Définition

Red Composante rouge, de 0 à 255. Type INTEGER
Green Composante verte, de 0 à 255. Type INTEGER
Blue Composante bleue, de 0 à 255. Type INTEGER
Opacity Opacité, de 0 à 100. Type INTEGER
Red2 Composante rouge pour la couleur clignotante, de 0 à 255. Type INTEGER
Green2 Composante verte pour la couleur clignotante, de 0 à 255. Type INTEGER
Blue2 Composante bleue pour la couleur clignotante, de 0 à 255. Type INTEGER
Opacity2 Opacité de la couleur clignotante, de 0 à 100. Type INTEGER

Exécution

Mode Mnémonique Action
2 SETCOLOR Colore les objets Ifc correspondant aux critères de sélection avec la couleur spécifiée.
Retour : 1 si OK, 0 sinon.

Cette instruction peut être utile pour animer un ensemble cohérent comprenant de nombreux objets. Par exemple pour mettre en évidence un site, un étage ou une façade dans le cadre de la navigation de l'utilisateur dans des synoptiques.
L'utilisation de cette instruction pour gérer des animations couleurs sur des objets individuels est fortement déconseillée. A la place nous vous recommandons de définir des animations avec l'éditeur de configuration du contrôle BIM.

Syntaxe 3

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, ObjectIdType, PropertyName, PropertyValue, ColorName, Opacity[[, Color2Name, Opacity2[, BlinkingTimer]]);

Type de retour : LONG

Argument Définition
ColorName Une couleur nommée. Voir le tableau à la fin de cette rubrique pour la liste de couleurs nommées. Type STR.
Opacity Opacité, de 0 à 100. Type INTEGER
Color2Name Une couleur nommée pour la couleur clignotante. Voir le tableau à la fin de cette rubrique pour la liste de couleurs nommées. Type STR.
Opacity2 Opacité de la couleur clignotante, de 0 à 100. Type INTEGER

Exécution

Mode Mnémonique Action

19

SETCOLORBYNAME

Colore les objets Ifc correspondant aux critères de sélection avec la couleur nommée spécifiée.
Retour : 1 si OK, 0 sinon.

Cette instruction peut être utile pour animer un grand ensemble d'objets de la même appartenance. Par exemple pour mettre en évidence un site, un étage ou une façade dans le cadre de la navigation de l'utilisateur dans des synoptiques.
L'utilisation de cette instruction pour gérer des animations couleurs sur des objets individuels est fortement déconseillée. A la place nous vous recommandons de définir des animations avec l'éditeur de configuration du contrôle BIM.

Syntaxe 4

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, ObjectIdType, PropertyName, PropertyValue, ColorIndex, Opacity);

Type de retour : LONG.

Argument Définition
ColorIndex Id d'une couleur indexée dans la palette de couleurs. Type INTEGER
Opacity Opacité, de 0 à 100. Type INTEGER.
Si ColorIndex correspond à une couleur clignotante, la valeur Opacity est utilisée pour la couleur et la couleur clignotante.

Exécution

Mode Mnémonique Action

20

SETCOLORBYINDEX

Colore les objets Ifc correspondant aux critères de sélection avec la couleur indexée spécifiée.
Retour : 1 si OK, 0 sinon.

Cette instruction peut être utile pour animer un ensemble cohérent comprenant de nombreux objets. Par exemple pour mettre en évidence un site, un étage ou une façade dans le cadre de la navigation de l'utilisateur dans des synoptiques.
L'utilisation de cette instruction pour gérer des animations couleurs sur des objets individuels est fortement déconseillée. A la place nous vous recommandons de définir des animations avec l'éditeur de configuration du contrôle BIM.

Syntaxe 5

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, ObjectIdType, PropertyName, PropertyValue);

Type de retour : LONG

Exécution

Mode Mnémonique Action

3

RESETCOLOR

Supprime la coloration de tous les objets Ifc correspondant aux critères de sélection.
Retour : 1 si OK, 0 sinon.
22 GETOBJECTCOUNT

Retourne le nombre d'objets Ifc correspondant aux critères de sélection.

Retour : Un nombre d'objets Ifc ou -1 si le ObjectIdType est invalide.

Syntaxe 6

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, IfcLabelValue[, SelectObject[, ChangeModelOpacity]]);

Type de retour : LONG

Argument Définition
SelectObject Si défini à 1, l'objet sera sélectionné. 0 par défaut. Type INTEGER
ChangeModelOpacity Si défini à 1, l'opacité du modèle sera mise à un niveau bas permettant à l'utilisateur de voir à travers les éléments 3D et de visualiser l'objet sur lequel la caméra a zoomé. 0 par défaut. Type INTEGER

Exécution

Mode Mnémonique Action

4

ZOOMOBJECT

Zoom sur l'objet Ifc dont la valeur de propriété IfcLabel correspond à IfcLabel, le sélectionne et change l'opacité du modèle selon les arguments SelectObject et ChangeModelOpacity .
Retour : 1 si OK, 0 sinon.

Syntaxe 7

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, Opacity);

Type de retour : LONG.

Argument Définition
Opacity Opacité, de 0 à 100. Type INTEGER

Exécution

Mode Mnémonique Action

5

SETOPACITY

Définit l'opacité du modèle en pourcentage.
Retour : 1 si OK, 0 sinon.

Syntaxe 8

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, IfcTypeValue, Show);

Type de retour : LONG.

Argument Définition
IfcTypeValue La valeur de la propriété Ifc Type à faire correspondre. Type STR.

Exécution

Mode Mnémonique Action

6

SHOWOBJECTBYTYPE

Affiche ou masque tous les objets correspondant à la valeur IfcTypeValue spécifiée.
Retour : 1 si OK, 0 sinon.

Syntaxe 9

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, ObjectIdType, PropertyName, PropertyValue, Show);

Type de retour : LONG.

Exécution

Mode Mnémonique Action

7

SHOWOBJECT

Affiche ou masque les objets Ifc correspondant aux critères de sélection.
Retour : 1 si OK, 0 sinon.

Syntaxe 10

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, PresetName[, PresetType]);

Type de retour : LONG

Exécution

Mode Mnémonique Action
11 ADDPRESET

Ajoute la scène actuelle en tant que nouveau preset nommé PresetName, soit comme caméra et/ou position d'un plan de coupe selon PresetType.
Utilisez le mode SAVEPRESETS si vous voulez que tout preset nouvellement ajouté soit sauvegardé de manière permanente.
Retour : 1 si OK, 0 sinon.

8 GOTOPRESET

Appelle le preset PresetName, change la caméra et/ou la position du plan de coupe selon PresetType.
En plus de tout preset défini par l'utilisateur, il y a huit presets prédéfinis de type caméra qui peuvent être utilisés. Les constantes de type chaîne de caractères correspondantes sont les suivantes

"LEFT"

"RIGHT"

"UP"

"DOWN"

"FRONT"

"BACK"

"UNCUT"

"DEFAULT"

Retour : 1 si Ok, 0 sinon.

16 REMOVEPRESET Supprime le preset nommé PresetName.
Utilisez le mode SAVEPRESETS si vous voulez que tout preset nouvellement supprimé soit supprimé de manière permanente.
Retour : 1 si OK, 0 sinon.

Syntaxe 11

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, PresetName, X, Y, Z, VectX, VectY, VectZ);

Type de retour : LONG

Argument Définition
X, Y, Z,
VectX, VectY, VectZ
Paramètres qui définissent un plan de coupe. Type INTEGER.
Les paramètres X, Y et Z spécifient la position du plan de coupe.
Les paramètres vecteurs spécifient le vecteur qui représentent l'orientation du plan de coupe.

Exécution

Mode Mnémonique Action
9 ADDCUTPLANESETPRESET Ajoute un preset de plan de coupe nommé PresetName en utilisant les paramètres fournis.
Utilisez le mode SAVEPRESETS si vous voulez que tout preset nouvellement ajouté soit sauvegardé de manière permanente.
Retour : 1 si OK, 0 sinon.

Syntaxe 12

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, PresetName, LookX, LookY, LookZ, UpX, UpY, UpZ, PosX, PosY, PosZ);

Type de retour : LONG

Argument Définition
LookX, LookY, LookZ,
UpX, UpY, UpZ,
PosX, PosY, PosZ

Paramètres qui définissent la position d'une caméra. Type INTEGER.
Les paramètres Look sont des vecteurs qui représentent la direction du champ de vision de la caméra.
Les paramètres Up sont des vecteurs qui représentent la direction ascendante dans la projection de la scène.
Les paramètres Pos sont des points qui précisent la position de la caméra.

Exécution

Mode Mnémonique Action
10 ADDCAMERASETPRESET Ajoute un preset caméra nommé PresetName en utilisant les paramètres fournis.
Utilisez le mode SAVEPRESETS si vous voulez que tout preset nouvellement ajouté soit sauvegardé de manière permanente.
Retour : 1 si OK, 0 sinon.

Syntaxe 13

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, PresetFilename);

Type de retour : LONG

Exécution

Mode Mnémonique Action
12 SAVEPRESETS Sauvegarde les presets dans le fichier Xml PresetFilename. Si un chemin relatif est spécifié, il est relatif au dossier BIM du projet.
Retour : 1 si OK, 0 sinon.

Syntaxe 14

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, PresetFilename[, LoadingMode]);

Type de retour : LONG

Argument Définition
LoadingMode Mode de chargement. Type INTEGER.
0 - Les présets chargés remplacent tous les présets précédents.
1 - Les presets chargés sont ajoutés aux presets existants.

Exécution

Mode Mnémonique Action
13 LOADPRESETS Charge des presets depuis le fichier Xml FileName. Si un chemin relatif est spécifié, il est relatif au dossier BIM du projet.
Retour : 1 si OK, 0 sinon.

Syntaxe 15

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity[, CountMode]);

Type de retour : LONG

Argument Définition
CountMode Mode du compteur. Type INTEGER.
0 - Renvoie le nombre total de presets. Presets plan de coupe, presets caméra et aussi presets qui sont la position d'une caméra ou d'un plan de coupe. Par défaut.
1 - Renvoie le nombre de presets de type plan de coupe. Les presets qui sont la position d'une caméra ou la position d'un plan de coupe sont inclus.
2 - Renvoie le nombre de presets de type caméra. Les presets qui sont la position d'une caméra ou la position d'un plan de coupe sont inclus.

Execution

Mode Mnémonique Action
14 GETPRESETCOUNT

Récupère le nombre de presets tel que spécifié par CountMode.

Retour : Nombre de presets disponibles si OK, -1 sinon.

Syntaxe 16

StrVal = BIMDISPLAY(Mode, Window, Branch, Identity, Index[, PresetType]);

Type de retour : STR

Argument Définition
Index Index dans la liste des presets. Commence à 0. Type INTEGER

Exécution

Mode Mnémonique Action
15 GETPRESETNAME

Récupère le nom du preset correspondant au numéro prédéfini spécifié Index dans la liste des présets de type PresetType.
Retour : Nom prédéfini si OK, chaîne vide sinon.

Syntaxe 17

StrVal = BIMDISPLAY(Mode, Window, Branch, Identity, IfcLabelValue, PropertyName);

Type de retour : STR

Exécution

Mode Mnémonique Action
18 GETIFCPROPERTY Récupère la valeur de la propriété PropertyName pour l'objet Ifc dont la valeur de la propriété IfcLabel correspond à IfcLabelValue.
Retour : La valeur de la propriété si OK, chaîne vide sinon.

Syntaxe 18

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity, ObjectIdType, PropertyName, PropertyValue[, XmlFilename]);

Type de retour : LONG

Argument Définition
XmlFilename Nom d'un fichier Xml. Facultatif. Type STR.
Le chemin peut être absolu ou relatif. Si un chemin relatif est spécifié, il est relatif au dossier BIM du projet.

Exécution

Mode Mnémonique Action
17 GETIFCPROPERTIES Récupère toutes les propriétés d'objets Ifc correspondant aux critères de sélection dans un format Xml et les charge dans un espace de noms ou génère un fichier Xml si Filename est fourni.
Le namespace créé en mémoire est : <Branch>.<Window>.<Identity>
Retour : 1 si OK, 0 sinon.

Syntaxe 19

LongVal = BIMDISPLAY(Mode, Window, Branch, Identity);

Type de retour : LONG

Exécution

Mode Mnémonique Action
21 OPENPROPERTIESWINDOW Ouvre la fenêtre de propriétés Ifc pour le contrôle BIM spécifié par Window, Branch et Identity.

Retour : 1 si OK, 0 sinon.

Couleurs nommées

Pour la table des couleurs nommées, cliquez ici. FerméVoir l'image
Couleurs pour le contrôle BIM