Design Automation API for Revit - Learn Autodesk Forge チュートリアル .NET Core Sample のセットアップ

これまで、Postman Sample で Design Automation API の利用手順をご紹介いたしました。

今回から、Forge Platform API を包括的に習得いただけるチュートリアル Learn Autodesk Forge（日本語）の Design Automation API のセクション、モデルを修正するセクションについて、ご紹介いたします。

モデルを修正するセクションでは、.NET Core を利用して Forge アプリを開発する手順と、 AutoCAD、Inventor、Revit、3ds Max のアドインの対応方法がそれぞれ解説されております。

このセクションでは、Revit プロジェクトの窓ファミリタイプの幅と高さを変更して、OSS の Bucket に保存する learn.forge.designautomation サンプルが GitHub で公開されております。

今回は、このサンプルをローカル環境でテストするための環境構築の手順をご案内いたします。

以前のブログ記事（Forge の開発環境）では、Node.js をベースとした開発環境のセットアップ手順についてご案内しておりますが、今回のサンプルは .NET Core をベースとするため、Visual Studio を利用します。
一部、重複している点もございますので、既にインストールされているツールがある場合は、スキップしてください。

1. Visual Studio 2017 以降のバージョン（最新は 2022）のインストール

下記の URL から Visual Studio 2017 以降のバージョンの Community エディション（無償）または、Visual Studio 2017 以降のバージョンのProfessional エディション（有償） のインストーラをダウンロードしてください。

https://visualstudio.microsoft.com/ja/downloads/

※サンプルを動かすためには、Visual Studio 2017 バージョン 15.7 以降が必要になります。Visual Studio 2017 をお持ちの方は、予めバージョンをご確認ください。

お使いの Visual Studio バージョンを確認するには、次の手順を実行します。

[ヘルプ] メニューの [About Microsoft Visual Studio] (Microsoft Visual Studio のバージョン情報) を選択します。
[Microsoft Visual Studio のバージョン情報] ダイアログで、バージョン番号を確認します。

インストーラを実行すると、Visual Studio 2017以降のバージョンにインストールできるワークロードの選択ウィンドウが表示されます。
この[ワークロード]タブの一覧から、「.NET デスクトップ開発」と「ASP.NET と Web 開発」の２つを選択してください。

ここでは、Visual Studio 2022 Community エディションでご案内いたします。

次に、ポップアップウィンドウ上部の[個別のコンポーネント]タブをクリックします。

.NET Core 3.1 ランタイムと Revit API を利用するために必要な .NET Framework SDK と Targeting Pack を選択してください。

.NET Frameworkのバージョンは、お使いの Revit に応じて異なり、また Design Automation API for Revit は、Revit 2019 以降をサポートしています。

Revit 2019 : .NET Framework 4.7/4.7.1/4.7.2
Revit 2020 : .NET Framework 4.7/4.7.1/4.7.2
Revit 2021 : .NET Framework 4.8
Revit 2022 : .NET Framework 4.8
Revit 2023 : .NET Framework 4.8

既に Visual Studio がインストールされている場合は、下記の URL に記載されている方法で、ワークロードと個別のコンポーネントを追加でインストールすることができます。

https://docs.microsoft.com/ja-jp/visualstudio/install/modify-visual-studio?view=vs-2017

インストールが完了したら、Visual Studio 2022 を起動し、[ファイル]->[新規作成]->[プロジェクト]を選択して[新しいプロジェクト]のテンプレート選択ウィザードを表示し、下記のテンプレートが一覧にあるかご確認ください。

[クラスライブラリ]
- Revit アドインを作成して、編集、ビルド、デバッグを実行するために使用するテンプレートです。
[ASP.NET Core Webアプリ]
- Design Automation API を利用する Forge アプリを作成するために使用するテンプレートです。

2. Revit 2019 - 2023 のインストール

Revit アドインを編集、ビルド、デバッグし、Revit プロジェクトを閲覧するためには、Revit アプリケーションが必要です。
下記のアドレスから、Revit 2019 - 2023 のいずれかのバージョンをインストールしてください。

https://www.autodesk.co.jp/products/revit/free-trial

インストールが完了したら、下記のディレクトリに RevitAPI.dll が保存されていることを確認してください。

C:\Program Files\Autodesk\Revit 20xx\RevitAPI.dll

3. 7zip のインストール

7zip は、オープンソースの高圧縮率のファイルアーカイバ（圧縮・展開/圧縮・解凍ソフト）です。Revit アドインのバンドルパッケージを Visual Studio のビルドイベントで自動で ZIP 圧縮して作成する際に 7zip を利用します。

下記のいずれかのアドレスから、7zip をダウンロードし、インストールしてください。

インストールが完了したら、下記のディレクトリに実行ファイルがあることを確認してください。

C:\Program Files\7-Zip\7z.exe

4. ngrok ツールの入手

ngrok は、ローカル Webサーバーをインターネットに公開することができるツールです。

ローカルマシンで起動している Webサーバーを、ngrok ツールを実行して、任意のポート番号を指定して、インターネット上に一時的に公開することができます。その際、一時的にグローバルの IP アドレスが割り当てられます。

下記のアドレスから、ngrok をダウンロードします。Windows 64bit の場合は、「ngrok-stable-windows-amd64.zip」がダウンロードできます。このファイルを解凍して、任意のディレクトリに配置します。最新版は Agent v3 です。

https://ngrok.com/download

次に、下記の URL から ngrok のアカウントを作成します。

https://dashboard.ngrok.com/signup

ログイン後、下記のページで割り当てられたトークンを確認します。

コマンドプロンプトを開いて、下記のコマンドを実行します。

ngrok config add-authtoken Your Authtoken

トークンが正常に設定されたら、下記のコマンドを実行します。

ngrok http 3000 --host-header=localhost:3000 --scheme http

下記のような画面が表示され、http://localhost:3000 にアドレスが割り当てられたことを確認したら完了です。Ctrl+C で終了します。

5. Google Chrome

Design Automation API で処理した Revit プロジェクトを Forge Viewer で表示するためには、HTML5、CSS3、WebGL をサポートする Webブラウザが必要です。下記の Webブラウザがサポート対象ですが、Google Chrome を推奨いたします。