For Dashboard Designers Reference IFC3DView
Thursday, October 5, 2023 12:46 PMIFC3DView
Label: :IA_Function
Property: type: IFC3DView
Inherits from: Function and View
IFC3DView is used to load IFC (Industry Foundation Classes) files and display the construction design in a 3D scene. Files can be loaded either over the internet or from a local file. User can rotate, pan and zoom the scene and also highlight and select elements of the model. Functionality to hide different parts of the model is also available through Triggers.
This View is made using Web IFC Viewer
Function parameters
Key | Description | Default value | Possible values | |
---|---|---|---|---|
$url |
URL to load the IFC file from | null |
valid URL string | |
#IFCItems |
Array of all the IFC Objects loaded from the file. Adding or removing or changing properties of IFC items using this parameter is currently not supported | [] |
Array |
|
$IFCItemsById |
Collection of all the IFC Objects loaded from the file indexed by id . Adding or removing IFC items using this parameter is currently not supported. |
{} |
Object |
|
#state.selected |
Array of the currently selected IFC Objects in the scene. Currently only one IFC Item can be selected at a time and the selection cannot be changed by Trigger. | [] |
Array |
|
#state.visible |
Array of the currently visible IFC Objects in the scene | [] |
Array |
To hide/show an item in the scene, set visible
: false
/true
on the item in #IFCItems
.
Outgoing triggers
Type: modelLoaded
Occurrence: When an IFC model has been loaded in the view.
Additional event properties (besides the inherited properties):
Key | Description | Possible values |
---|---|---|
IFCItems |
Array of all the IFC Objects loaded from the file. | Array of IFC items |
IFCItemsById |
Collection of all the IFC Objects loaded from the file indexed by id |
Object / Collection of IFC items |
Type: mouseOver
Occurrence: When the mouse is moved over a new IFC object in the scene.
Additional event properties (besides the inherited properties):
Key | Description | Possible values |
---|---|---|
data |
IFC item hovered by the mouse | IFC item |
Type: IFCItemClick
Occurrence: When the user clicks an IFC object in the scene.
Additional event properties (besides the inherited properties):
Key | Description | Possible values |
---|---|---|
data |
IFC item clicked with the mouse | IFC item |
keyPressed |
Map of keys that are pressed during the click. | object |
keyPressed.alt |
[ALT] key is pressed during click. | true|false |
keyPressed.ctrl |
[CTRL] key is pressed during click. | true|false |
keyPressed.shift |
[SHIFT] key is pressed during click. | true|false |
keyPressed.meta |
[Meta] key (Apple Command or Windows button) is pressed during click | true|false |
mouse |
The coordinates of the click, relative to the page. | Object {x: number, y: number} |
Type: IFCItemRightClick
Occurrence: When the user clicks an IFC object in the scene.
Additional event properties (besides the inherited properties):
Key | Description | Possible values |
---|---|---|
data |
IFC item clicked with the mouse | IFC item |
keyPressed |
Map of keys that are pressed during the click. | object |
keyPressed.alt |
[ALT] key is pressed during click. | true|false |
keyPressed.ctrl |
[CTRL] key is pressed during click. | true|false |
keyPressed.shift |
[SHIFT] key is pressed during click. | true|false |
keyPressed.meta |
[Meta] key (Apple Command or Windows button) is pressed during click | true|false |
mouse |
The coordinates of the click, relative to the page. | Object {x: number, y: number} |