Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/autodesk-forge/forge-civil3d-properties

Extract style information from Civil 3D entities and show on the property panel
https://github.com/autodesk-forge/forge-civil3d-properties

autodesk-civil3d autodesk-designautomation netcore

Last synced: about 5 hours ago
JSON representation

Extract style information from Civil 3D entities and show on the property panel

Host: GitHub
URL: https://github.com/autodesk-forge/forge-civil3d-properties
Owner: Autodesk-Forge
Created: 2020-06-22T23:17:42.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-12-08T10:48:25.000Z (almost 2 years ago)
Last Synced: 2024-04-09T21:50:08.398Z (7 months ago)
Topics: autodesk-civil3d, autodesk-designautomation, netcore
Language: C#
Homepage: https://forge-civil3d.herokuapp.com
Size: 7.74 MB
Stars: 4
Watchers: 7
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Extract style information - Civil 3D

![Platforms](https://img.shields.io/badge/Webapp-Windows|MacOS|Linux-lightgray.svg)

[![ASP.NET Core](https://img.shields.io/badge/ASP.NET%20Core-3.1-blue.svg)](https://asp.net/)

[![oAuth2](https://img.shields.io/badge/oAuth2-v1-green.svg)](http://developer.autodesk.com/)

[![Data-Management](https://img.shields.io/badge/Data%20Management-v1-green.svg)](http://developer.autodesk.com/)

[![Design-Automation](https://img.shields.io/badge/Design%20Automation-v3-green.svg)](http://developer.autodesk.com/)

![Platforms](https://img.shields.io/badge/Plugins-Windows-lightgray.svg)

![.NET](https://img.shields.io/badge/.NET%20Framework-4.7-blue.svg)

[![Civil 3D](https://img.shields.io/badge/Civil%203D-2020-lightblue.svg)](http://developer.autodesk.com/)

![Intermediate](https://img.shields.io/badge/Level-Intermediate-green.svg)

[![License](http://img.shields.io/:license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

# Description

This sample demonstrates using Design Automation with Civil 3D support included in the AutoCAD engine. User can select a DWG file hosted on BIM 360 Document Manager (or A360) and view using the Forge Viewer. 

Once the file is loaded, in the background, a Design Automation workitem will run a .NET plugin to extract additional `Style` information from the file. When ready, the information will be visible on the property panel. 

This sample is based on the [Learn Forge](http://learnforge.autodesk.io) tutorials (`View hubs` section).

# Thumbnail

![thumbnail](/thumbnail.gif)

# Setup

## Prerequisites

1. **Forge Account**: Learn how to create a Forge Account, activate subscription and create an app at [this tutorial](http://learnforge.autodesk.io/#/account/). 

2. **Visual Studio**: Either Community (Windows) or Code (Windows, MacOS). 

3. **.NET Core** basic knowledge with C#

4. **ngrok**: Routing tool, [download here](https://ngrok.com/)

7. **Civil 3D** 2020: required to compile changes into the plugin. Windows only.

For using this sample, you need an Autodesk developer credentials. Visit the [Forge Developer Portal](https://developer.autodesk.com), sign up for an account, then [create an app](https://developer.autodesk.com/myapps/create) that uses Data Management and Model Derivative APIs. For this new app, use `http://localhost:3000/api/forge/callback/oauth` as Callback URL, although is not used on 2-legged flow. Finally take note of the **Client ID** and **Client Secret**.

## Running locally

Clone this project or download it. It's recommended to install [GitHub desktop](https://desktop.github.com/). To clone it via command line, use the following (**Terminal** on MacOSX/Linux, **Git Shell** on Windows):

    git clone https://git.autodesk.com/goncala/bim360civil

**Visual Studio** (Windows):

Right-click on the project, then go to **Debug**. Adjust the settings as shown below. 

![](readme/visual_studio_settings.png)

**Visual Sutdio Code** (Windows, MacOS):

Open the folder, at the bottom-right, select **Yes** and **Restore**. This restores the packages (e.g. Autodesk.Forge) and creates the launch.json file. See *Tips & Tricks* for .NET Core on MacOS.

![](readme/visual_code_restore.png)

**ngrok**

Run `ngrok http 3000 -host-header="localhost:3000"` to create a tunnel to your local machine, then copy the address into the `FORGE_WEBHOOK_URL` environment variable.

**Environment variables**

At the `.vscode\launch.json`, find the env vars and add your Forge Client ID, Secret and callback URL. Also define the `ASPNETCORE_URLS` variable. The end result should be as shown below:

```json

"env": {

    "ASPNETCORE_ENVIRONMENT": "Development",

    "ASPNETCORE_URLS" : "http://localhost:3000",

    "FORGE_CLIENT_ID": "your id here",

    "FORGE_CLIENT_SECRET": "your secret here",

    "FORGE_CALLBACK_URL": "http://localhost:3000/api/forge/callback/oauth",

    "FORGE_WEBHOOK_URL": "your ngrok address here: e.g. http://abcd1234.ngrok.io"

},

```

**Civil 3D plugin**

A compiled version of the `Civil 3D` plugin (.bundles) is included on the `webapp` module, under `wwwroot/bundles` folder. Any changes on these plugins will require to create a new .bundle, the **Post-build** event should create it.

Start the app.

Open `http://localhost:3000` to start the app, select a DWG file. A pop-up will indicate when the style information is ready.

## Deployment

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.

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

# Further Reading

Documentation:

- [BIM 360 API](https://developer.autodesk.com/en/docs/bim360/v1/overview/) and [App Provisioning](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps)

- [Data Management API](https://developer.autodesk.com/en/docs/data/v2/overview/)

- [Viewer](https://developer.autodesk.com/en/docs/viewer/v7) 

- [Design Automation](https://forge.autodesk.com/en/docs/design-automation/v3/developers_guide/overview/)

### Troubleshooting

1. **Cannot see my BIM 360 projects**: Make sure to provision the Forge App Client ID within the BIM 360 Account, [learn more here](https://forge.autodesk.com/blog/bim-360-docs-provisioning-forge-apps). This requires the Account Admin permission.

2. **error setting certificate verify locations** error: may happen on Windows, use the following: `git config --global http.sslverify "false"`

## License

This sample is licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for full details.

## Written by

Augusto Goncalves [@augustomaia](https://twitter.com/augustomaia), [Forge Partner Development](http://forge.autodesk.com)