This repository demonstrates advanced viewing of clash raw data by Model Coordination API and demos exporting a PDF report on the clashes the user is interested in.
Live version: bim360-clash-pdf-exporter.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.
Watch this video to learn how to use this demo.
The sample first downloads the model set data and clash data of the selected project.
The relationship of the data are clash mapping, please refer to the other sample Clash View Basic
Based on the relationship, the code analyzes the data to build the mapping among the clash document, version URN and viewable guid etc. The mapping is saved to docsMap.json
The method getBreakdownData iterates each clash instances. For one element (lvid) of one clash, the method dumps all clashes that this element (lvid) is involved, and groups them in the document.
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-clashpdfexport
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.
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