This repository demonstrates the scenario: analyze clash issue and create clash issue from application.
Live verion: bim360-clash-issue.herokuapp.com
To use this sample with your BIM 360 you need to "Enable Custom Integrations". At the app top-right, click Config to get detailed steps.
Recording: this video on how to play the demo.
To work with the sample, firstly upload some source models to BIM 360 folder, then create model set in Model Coordination module with this folder. Please refer to BIM 360 Model Coordination documentation for details. Check Sample Files folder for testing RVT files, it includes two versions of models set.
- After logging in, on top left of navigation panel, select one hub, then select one project.
- After selecting one project, the active modelsets in this activeproject will be listed.
- Click one modelset, all clash instances will be displayed in Clash Raw Table. All clash assigned issue of this modelset will also be displayed in Clash Issue Table. All documents of this modelset will also be loaded in the Forge viewer
- Select one issue in Clash Issue Table, the corresponding clash will be highlighted in the Forge viewer. Click Issue Icon of the Forge Viewer toolbar, the pushpin of the issues will be displayed, including a property panel with basic information of the issue.
- Select one issue in Clash Raw Table you want to create clash issue, the corresponding clash will be highlighted in the Forge viewer. Click Edit Icon of the Forge Viewer toolbar, input a title for the new issue, then click elements of the clashed objects (red/blue). The process of creating a new clash issue will start.
After a while, Clash Issue Table will be refreshed. Switch to BIM 360 UI, check the newly created issue there. It also contains the screenshot of the clash as attachment.
Watch this video to learn how to use this demo.
- BIM 360 Account: must be Account Admin to add the app integration, or invited by admin of BIM admin. Learn about provisioning.
- Forge Account: Learn how to create a Forge Account, activate subscription and create an app at this tutorial. Get Forge client id, Forge client secret and Forge callback url and input them to config.js
- Create some modelsets of Model Coordination and clash issue in BIM 360.
- Node.js: basic knowledge with Node.js.
- JavaScript basic knowledge with jQuery and Bootstrap
Clone this project or download it. It's recommended to install GitHub desktop. To clone it via command line, use the following (Terminal on MacOSX/Linux, Git Shell on Windows):
git clone https://github.com/autodesk-forge/forge-bim360-clashissue
Open the project folder in Visual Studio Code. Install the required packages, set the environment variables with your client ID & secret and finally start it. Via command line, navigate to the folder where this repository was cloned and use the following:
Mac OSX/Linux (Terminal)
npm install
export FORGE_CLIENT_ID=<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
export FORGE_CLIENT_SECRET=<<YOUR CLIENT SECRET>>
export FORGE_CALLBACK_URL=<<YOUR CALLBACK URL>>
npm start
Windows (use Node.js command line from Start menu)
npm install
set FORGE_CLIENT_ID=<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
set FORGE_CLIENT_SECRET=<<YOUR CLIENT SECRET>>
set FORGE_CALLBACK_URL=<<YOUR CALLBACK URL>>
npm start
Open the browser: http://localhost:3000.
To deploy this application to Heroku, the Callback URL for Forge must use your .herokuapp.com address. After clicking on the button below, at the Heroku Create New App page, set your Client ID, Secret and Callback URL for Forge.
Watch this video on how deploy samples to Heroku.
- Forge Blog
- Field of View, a BIM focused blog
- Since the clash data might be large, don't pull the file locally and then process it. Decompressing and streaming the results on the fly would also be recommended, as showned in this sample utility.js
- To make a simple demo, this sample does not use database to manage the clash data.
- On client (browser) side, it may be more efficient to manage the data by IndexDB if the app requires to perform various analysis in different browser sessions.
-
Cannot see my BIM 360 projects: Make sure to provision the Forge App Client ID within the BIM 360 Account, learn more here. This requires the Account Admin permission.
-
The code of highlighting objects within Forge Viewer requires the corresponding documents of one clash instance have been loaded. If not, the highlighting will not work, try again when the loading is completed
This sample is licensed under the terms of the MIT License. Please see the LICENSE file for full details.
Xiaodong Liang @coldwood, Forge Partner Development