OperationDriver によるプル型イベント処理

ヒスイのコマンドではプル型イベント処理によるマウスオペレーションが記述できます。このページの説明はチュートリアルの内容を前提としていますので、まずはチュートリアルをやってからお読みください。

プッシュ型の問題

.NET Framework で使用される通常のイベント処理は「プッシュ型イベント」と言えます。何故なら、イベントの発火側が一方的にイベントをプッシュする方式であり、必要なイベントを選別する責務はイベントの受け取り側にあるからです。

このプッシュ型イベント処理は、CADの作図コマンドのような複雑なマウスオペレーションを扱うには不便です。例えばマウスの2点クリックで直線を作図するコマンドを考えてみましょう。

1回目のMouseClickイベントで直線作図開始
MouseMoveイベントの度に直線をプレビュー表示（ラバーバンド表示）
2回目のMouseClickイベントで直線作図が完了し、直線エンティティをドキュメントに登録

このように、直線を作図するだけでも3つのイベントハンドラが必要ですし、直線作図モードかどうかを区別するフラグも必要です。つまり「直線を作図する」という一つの関心事が、3つのイベントハンドラ関数と1つのフラグに分散してしまうことになります。これでは、コマンドの数が増えるとコードの管理は非常に厄介になってしまいます。

プル型イベント処理

このような作図コマンドは、次のように1つの関数内に素直にフローを記述したいものです。

直線作図()
{
  1回目のMouseClickを取得;
  2回目のMouseClickを取得;
  直線エンティティを作成して登録;
}

チュートリアルをやれば分かるように、ヒスイではこのように素直にオペレーションのフローを記述することが出来ます。これはコマンド側が必要なイベントを要求する形式なので、プル型のイベント処理と言えます。このプル型イベント処理を実現するのが、次で説明する OperationDriver クラスです。

OperationDriver

使い方

OperationDriverを利用する場合には、直線を作図するコマンドを次のような関数で定義します。

static IEnumerator<Hisui.Ctrl.IOperation> DrawLine(...)
{
  System.Windows.Forms.Control ctrl = ...; // クリックイベントを受け取るコントロール
  Hisui.Ctrl.LButtonClick click1 = new Hisui.Ctrl.LButtonClick( ctrl );
  Hisui.Ctrl.LButtonClick click2 = new Hisui.Ctrl.LButtonClick( ctrl );
  
  yield return click1;
  yield return click2;
  
  System.Drawing.Point pt1 = click1.EventArgs.Location; // 1点目のクリック位置
  System.Drawing.Point pt2 = click2.EventArgs.Location; // 2点目のクリック位置
  直線を作図;
}

この関数を呼び出して、OperationDriverに次のように渡します。

Hisui.Ctrl.OperationDriver driver = new Hisui.Ctrl.OperationDriver();
...
driver.Run( DrawLine(...) );

IOperationインターフェイス

DrawLine() 関数では IOperation のイテレータを戻り値として返しています。 IOperationインターフェイスは次のように定義されています。

namespace Hisui.Ctrl
{
  public delegate void TerminationHandler() ;

  public interface IOperation
  {
    void Run( TerminationHandler terminate ) ;
    void Abort() ;
    void Suspend() ;
    void Resume() ;
  }
}

このインターフェイスをユーザーが実装する機会はあまりないでしょう。ヒスイには IOperation を実装したマウスオペレーションが既に定義されています。以下に代表的なものを示します。

MouseMove
MouseWheel
LButtonClick, RButtonClick, MButtonClick
LButtonDown, RButtonDown, MButtonDown
LButtonUp, RButtonUp, MButtonUp

マウスオペレーションによるコマンドは、これらマウスオペレーションの列として表すことが出来ます。したがって、OperationDriver にはオペレーション列 IEnumerator<IOperation> を渡す仕様となっています。これはコマンドの状態遷移を素直に表現したイテレータとなっています。

グローバルな OperationDriver

ヒスイは次のようにグローバルな OperationDriver インスタンスを一つ定義しています。

namespace Hisui.Ctrl
{
  public static class Current
  {
    ...
    static OperationDriver _driver = new OperationDriver();
    ...
    public static OperationDriver Driver
    {
      get { return _driver; }
    }
    ...
  }
}

チュートリアルで作成した直線作図のようなコマンドは、このグローバルな OperationDriver を利用して実行されます。

戻る