過去バージョン

この記事は Revit カテゴリの一部です。開発の前提は 開発環境構築、API の全体像は Revit API 概要 を参照してください。

1外部コマンド（IExternalCommand）

IExternalCommand は、リボンのボタンなどから 1 回実行される処理を表すインターフェースです。実装するのは Execute メソッドだけで、処理の成否を戻り値で返します。

戻り値が Cancelled / Failed の場合、自動トランザクションモードでは変更がロールバックされる点を覚えておきましょう。

2外部アプリ（IExternalApplication）

IExternalApplication は Revit 起動時にロードされ、セッション中ずっと常駐するアドインです。リボンの構築やイベント購読など「最初に一度だけ行う初期化」を担います。

どちらも成功時は Result.Succeeded を返します。.addin マニフェストでは Type="Application" として登録します。

3リボン UI（RibbonPanel と PushButton）

独自のボタンは OnStartup の中で構築します。タブ → パネル → ボタンの順に組み立て、ボタンに外部コマンドのクラスを紐づけます。

using Autodesk.Revit.UI;

public Result OnStartup(UIControlledApplication app)
{
    string tab = "MyTools";
    app.CreateRibbonTab(tab);
    RibbonPanel panel = app.CreateRibbonPanel(tab, "ユーティリティ");

    string asm = System.Reflection.Assembly
                    .GetExecutingAssembly().Location;

    PushButtonData data = new PushButtonData(
        "btnHello", "Hello",
        asm, "MyAddin.HelloWorldCommand");
    panel.AddItem(data);

    return Result.Succeeded;
}

PushButtonData の第 3 引数にアセンブリのパス、第 4 引数に呼び出すコマンドの完全修飾クラス名を渡します。アイコン画像やツールチップは PushButton のプロパティで設定できます。

4外部イベント（ExternalEvent）とモードレス

Revit API には「API はトランザクション可能なコンテキスト（Revit の操作中）からしか呼べない」という制約があります。モーダルダイアログ（操作をブロックするウィンドウ）なら問題ありませんが、画面を見ながら操作できる「モードレス」ダイアログから直接 API を呼ぶと例外になります。

これを解決するのが ExternalEvent（外部イベント）です。IExternalEventHandler を実装したハンドラを登録し、モードレス UI 側からは ExternalEvent.Raise() を呼ぶだけにします。すると Revit が安全なタイミングでハンドラの Execute を実行し、その中でトランザクションを伴うモデル操作ができます。

常駐パネルやドッキングウィンドウを持つ本格的なツールでは、この外部イベントの仕組みが必須になります。逆に言えば、単純なボタン 1 つで完結する処理ならモーダルダイアログで十分で、外部イベントを持ち出す必要はありません。常駐ウィンドウから選択や入力を受け取りながらモデルを書き換える、といった対話的なツールに進む段階で初めて、ExternalEvent の出番になると考えておくとよいでしょう。

→次に読む