Revitのアドインアプリケーション

Revitのアドインアプリケーションの作成方法について

はじめに

こんにちは。本記事では、Autodesk Revitのアドインアプリケーションの作成方法について、プログラミング初心者の方でもわかりやすいように丁寧に解説いたします。Revitのアドインアプリケーションは、Revitの起動時に実行されるコードを追加することができ、Revitの機能を拡張するための強力なツールです。

必要なツール

まず、アドインアプリケーションを作成するために必要なツールを準備しましょう。

1. Visual Studio：

   • Microsoftが提供する統合開発環境（IDE）です。無料版のVisual Studio Communityで十分です。

   • Visual Studioのダウンロードページからダウンロードしてインストールしてください。

2. Revit API：

   • Revitのアドインを作成するためのライブラリです。Revitをインストールすると、Revit APIも含まれています。

3. .NET Framework：

   • Revitアドインは.NET Frameworkを使用して開発します。通常、Visual Studioと一緒にインストールされます。

プロジェクトの作成

1. Visual Studioを起動します。

2. **「新しいプロジェクトの作成」**を選択します。

3. **「C#クラスライブラリ」**のテンプレートを選びます。

4. プロジェクト名を入力します（例：RevitAddinApp）。

5. 作成ボタンを押してプロジェクトを作成します。

Revit APIの参照を追加

1. プロジェクトが作成されたら、ソリューションエクスプローラーでプロジェクト名を右クリックし、**「参照の追加」**を選択します。

2. **「参照マネージャー」が開くので、「参照」**をクリックし、Revitのインストールディレクトリから以下のDLLを追加します。

   • `RevitAPI.dll`

   • `RevitAPIUI.dll`

   • これらのファイルは通常、Revitのインストールフォルダ内の`C:\Program Files\Autodesk\Revit 202X`にあります（202Xはバージョン番号）。

アドインアプリケーションの作成

次に、実際のアドインアプリケーションを作成します。

1. プロジェクトに新しいクラスを追加します。ソリューションエクスプローラーでプロジェクト名を右クリックし、**「追加」 -> 「クラス」**を選択します。クラス名を「App.cs」とします。

2. 以下のコードを「App.cs」に追加します。

using System;
using Autodesk.Revit.UI;

namespace RevitAddinApp
{
    public class App : IExternalApplication
    {
        public Result OnStartup(UIControlledApplication application)
        {
            // Revitが起動したときの処理
            TaskDialog.Show("Revit Add-in", "アドインが起動しました");
            return Result.Succeeded;
        }

        public Result OnShutdown(UIControlledApplication application)
        {
            // Revitが終了したときの処理
            TaskDialog.Show("Revit Add-in", "アドインが終了しました");
            return Result.Succeeded;
        }
    }
}

このコードでは、Revitが起動したときと終了したときにメッセージを表示する簡単なアドインアプリケーションを作成しています。

アドインマニフェストファイルの作成

Revitにアドインを認識させるために、アドインマニフェストファイル（.addinファイル）を作成します。

1. プロジェクトのルートフォルダに「MyRevitAddinApp.addin」という名前のXMLファイルを作成します。

2. 以下の内容をファイルに追加します。

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<RevitAddIns>
    <AddIn Type="Application">
        <Name>MyRevitAddinApp</Name>
        <Assembly>$(targetpath)</Assembly>
        <AddInId>12345678-1234-1234-1234-123456789012</AddInId>
        <VendorId>Company</VendorId>
        <VendorDescription>Your Company</VendorDescription>
    </AddIn>
</RevitAddIns>

ここで、`$(targetpath)`はビルド後のDLLのパスに置き換わります。通常、Visual Studioが自動的に正しいパスに置き換えます。

ビルドとデプロイ

1. プロジェクトをビルドします。メニューの「ビルド」から「ソリューションのビルド」を選択します。

2. ビルドが成功したら、ビルドされたDLLファイルと「MyRevitAddinApp.addin」ファイルをRevitのアドインフォルダにコピーします。

   • 例：`C:\Users<ユーザー名>\AppData\Roaming\Autodesk\Revit\Addins\202X`

アドインのテスト

1. Revitを起動します。

2. Revitが起動する際に、「アドインが起動しました」というメッセージが表示されるはずです。

3. Revitを終了すると、「アドインが終了しました」というメッセージが表示されます。

まとめ

この記事では、Revitのアドインアプリケーションを作成する基本的な手順を紹介しました。初めての方でも、この手順に従って進めれば、簡単なアドインアプリケーションを作成し、Revitの機能を拡張することができます。