editor_register

あなたのエディタオブジェクトの初期化ルーチンでは、クラスを初期化するために setup を呼び出した後、editor_register を使って、あなたのエディタの存在を Timeline オブジェクトに知らせます。Timeline は、データ型によってエディタを分類します。このデータ型とは、エディタが時間内の特定の瞬間にオブジェクトに対して送信するメッセージの型を記述したシンボルです。QuickTime ムービーエディタは、movie と呼ばれる型を考案し、これを Timeline のコンテキスト内で動作するように修正された Max の movie オブジェクトと結びつけるために使っています。あなたのエディタは複数のデータ型に対して登録することができ、新しいインスタンスが生成されると、あなたのオブジェクトはインスタンスが要求するデータ型を報告されます。

エディタを含むトラックが折りたたまれた場合に、イベントの矩形領域の、トラックの最上部からのオフセットを保存します。

event_new

この関数は、Event のほとんどのフィールドを初期化します（ box_new と同様、これは既存のイベントを渡され、イベント自体の生成は行ないません）。引数 flags のための定数は次の通りです。

あなたは、F_GROWY または F_GROWBOTH のいずれかを使わなければなりません。また、オブションとして、F_CONSTANTWIDTH を使います。

event_box

この関数は Event の矩形領域を初期化します。これについて簡単に説明します。この関数は event_new の後に呼び出さなければなりません。そうすることによって、Event の 開始時刻（start）と持続時間（duration)の値を使って、Event の矩形領域の現在位置を計算することができます。

この関数は、初期化の際に editor_register に供給され、ユーザがタイムライントラックで新しいイベントを作ったときに呼び出されます。メニュー関数は生成ルーチンの結果を返さなければなりません。結果は、新しく生成されたオブジェクトへのポインタ、または、生成時にエラーが発生した場合は 0 になります。

一般的に、メニュー関数では、あなたのオブジェクトの生成ルーチンに渡すための Atom の配列を組み立てます。この配列は、ファイルが読み込まれる際に生成関数がタイムラインオブジェクトから直接受け取るものと同じ引数フォーマットを取ります。

次のものは、エディタのための一般的なメニュー関数の例です。これは、int データ型のためのメッセージを扱います。使用されている定数は timelineEvent.h で宣言されています。

void *myEditor_menu(t_symbol *dataType, t_symbol *message, void *track, void *obj, long start, Point pt) { MyEditor *x; long dur; t_atom a[18]; SETOBJ(a + ED_TRACK,(void*)track); /* イベントのトラック */ SETSYM(a + ED_MESSAGE,message); /* イベントのメッセージ */ SETLONG(a + ED_START,start); /* イベントの開始時刻 */ dur = track_pixToMS(track,132); SETLONG(a + ED_DURATION,dur); /* イベントの持続時間 */ SETLONG(a + ED_TOP,(long)pt.v); /* box の上端 */ SETLONG(a + ED_BOTTOM,(long)pt.v+64); /* box の下端 */ x = myEditor_new(dataType,6,a); return (x); }

event_spool

イベントのアピアランスに影響を及ぼすような変更を行った場合、その後に event_spool を呼び出します。これは、あなたのインスタンス生成ルーチンで行う必要があります。標準のエディタメッセージのコンテキスト外の関数によって単にオブジェクトの状態を再描画したい場合、event_spool を呼び出すことができます。この場合には、上記のセクションで説明されたセットアップを行う必要がない点に注意して下さい。

psave

バインディング

宣言

このメッセージは、イベントがコピーされるか、タイムラインファイルが保存された時に、あなたのオブジェクトに対しその内容を保存するために送られます。最初の９個の引数はすべてのイベントに標準となるもので、必ず保存されなければなりません。そして、関数　event_save によって、Atom の配列の中に置かれます。その後に、あなたのエディタインスタンスをリストアするために必要な追加データを置くことができます。そして、この配列を、binbuf_insert に渡しますが、この第１引数には dest を用います。event_save 関数の記述の後にあるサンプルを参照して下さい。psave メソッドへの引数は、パッチャーのユーザインターフェイスオブジェクトのケースやノーマルオブジェクトの save メッセージのためのメソッドと同じである点に注意して下さい。

eventStart

バインディング

宣言

このメッセージは割り込みレベルで送られる可能性があります。従って、メソッドの動作に対しては通常の制限が適用されます。一つのデータ要素を持つエディタオブジェクトのために、通常、eventStart の実装には、引数 receiver へのメッセージの送信が含まれます。イベントの持続時間内にイベントのシリーズをスケジューリングするような、より複雑なオブジェクトの場合には、タイムラインに関連したスケジューリング機能が作られます。最初に、シンプルなケースでどのような実装が行なわれるかについて見てみましょう。次に示す例では、eventStart メソッドはレシーバに１つの整数（int) を送信します。これは、int データ型を扱うナンバーボックスエディタによって使われるものと同じ実装です。これは、レシーバに対し、メッセージセレクタ int を送信せずに、Event の e_message フィールドを使っている点に注意して下さい。

void myNumberEditor_eventStart(MyEditor *x, t_object *receiver) { t_atom val; val.a_w.w_type = A_LONG; val.a_w.w_long = x->m_value; typedmess(receiver,x->m_event.e_message,1,&val); }

event_save

この関数は Event の標準的な９個の項目を、Atom の配列にコピーします。これによって、Event のデータ構造体を保存するための詳細について考えずに済みます。次のものは、event_save が使用する psave メソッドの実装例です。この後、データの追加部分を、binbuf_insert を呼び出す前に付け加えます。

void myEditor_psave(MyEditor *x, void *buf) { t_atom buffer[10]; event_save((Event)x,buffer); SETLONG(buffer+9,x->m_value); binbuf_insert(buf,0L,10,buffer); }

event_schedule

これは、event_schedule を使って、イベントの持続時間に基づいた、均一な間隔での４つのメッセージ送信を実装したものです。４つの整数 (integer) の値は、m_values という配列に格納されていると仮定しています。どのメッセージを送信しているかを知るために、配列 m_counter の中のカウンタが必要になります。

この実装には２つの関数が含まれています。１つは、メッセージ eventStart に応答して最初の値を送信するもの、もう１つは、他の３つのメッセージを送信するために、event_schedule によってスケジュールされたものです。

void myEditor_eventStart(myEditor *x, t_object *receiver) { t_atom at; at.a_w.w_long = x->m_values[0]; /* 最初の値を送信 */ at.a_type = A_LONG; typedmess(receiver,x->m_event.e_message,1,&at); x->m_delay = (long)((double)x->m_event.e_duration/3.0); /* イベント間のインターバル（時間間隔）を計算 */ x->m_counter = 1; /* 次に送信する値 */ event_schedule(x,myEditor_tick,receiver,0L, x->m_delay,(long)L_DIEONSTOP); } void myEditor_tick(myEditor *x, t_object *receiver) { t_atom at; at.a_w.w_long = x->m_values[x->m_counter++]; /* 次の値を送信 */ at.a_type = A_LONG; typedmess(receiver,x->m_event.e_message,1,&at); if (x->m_counter < 4) /* 再スケジュール */ event_schedule(x,myEditor_tick,receiver,0L, x->m_delay, (long)L_DIEONSTOP); }

update

バインディング

宣言

このメッセージは、エディタが、タイムラインウィンドウ上に自分のデータを描画するために送信されます。タイムラインのコンテキストで送られる update メッセージと、パッチャーウィンドウで送られる update メッセージの違いは、アップデートされるウィンドウの領域を含む、更新する矩形領域 updateBox が渡されるという点です。あなたのイベント矩形領域の一部だけが updateBox と交差している場合、データの全てを再描画するのを避けることができ、それによってタイムラインウィンドウの描画をスピードアップします。あなたのオブジェクトが（QuickTime ムービーエディタのように）データをゆっくり描画する場合、updateBox に注意を払うことは特に重要です。あなたのオブジェクトのイベント矩形領域が、描画されるタイムラインウィンドウの完全に領域外にある場合、update メソッドは呼び出されません。

upadate メソッドが呼び出されると、イベントの 矩形領域（*e->e_rect、これは、Box の矩形領域ではなく、ポインタである点に注意して下さい。）は的確にオフセットされているため、その中に描画を行うことができます。しかし、矩形領域 や updateBox の外側に描画しないよう気をつけて下さい。矩形のフレームを描画する必要はありません。描画するのは内容だけです。矩形領域のサイズに基づいた内部の変数を計算する場合には、update メッセージ間で変更されるサイズのための準備をしておく必要があります。（例えば、ユーザによるズームイン、ズームアウトの場合）。通常、描画をする前に、update メソッドの中で矩形領域のサイズの変更を常にチェックしなければなりません。

info

バインディング

宣言

info メッセージにメソッドをバインドすると、オブジェクトが選択されている場合、自動的に Max メニューの GetInfo... が有効になります。一般的には、エディタに格納されているデータやエディタの表示のためのパラメータの状態をユーザが変更できるようにするダイアログボックスを表示させます。ダイアログボックスがあなたのイベントのアピアランスを変更した場合、event_spool を呼び出して、Timeline オブジェクトに再描画を行うよう告げなければなりません。

event_avoidRect

patcher_avoidRect と同様に、event_avoidRect は、ダイアログボックスの座標を変更して、可能な限り編集されるイベントの直下に配置します。エディタが info メソッドでダイアログを使う場合には、GetNewDialog を呼び出す前に、event_avoidRectを使います。

dblclick

バインディング

宣言

ユーザがイベント矩形領域の上でダブルクリックを行った時に、このメッセージがあなたのエディタに送られます。あなたのオブジェクトが編集するデータを補助ウィンドウに表示する場合、このメッセージに応答してウィンドウを表示させることができます。

idle

バインディング

宣言

idle メッセージは、カーソルがイベント内にある時に、それを追跡するために、あなたのオブジェクトに対して送られます。あなたは、pt によるカーソルの位置、または track_drawDragParamによるレジェンド（後述）の中の表示情報を変更することができます。idle メッセージを送る前に、Timeline オブジェクトは、、あなたのイベントのトラックの最上部ではなく、ウィンドウの最上部からの相対的な位置に、あなたのイベント矩形領域を調節します。

click

バインディング

宣言

あなたのイベント矩形領域の中でユーザがクリック、またはダブルクリックした時に、エディタはこのメッセージを受け取ります。click メッセージに応答して何をおこなうべきかということについては、多くの戦略があります。あなたのオブジェクトがテキストエディタならば、例えば、TEClick を呼び出すかもしれません。エディタ efunc のように、オブジェクトの内容を描画によって編集できるものであれば、パッチャーにおけるインターフェイスオブジェクトが行うと同様に、wind_drag を使って drag 関数を提供するでしょう。

click メッセージを送信する前に、Timeline オブジェクトは、あなたのイベント矩形領域を、トラックとの上端とではなく、ウィンドウの上端との比較によって調整します。しかし、drag 関数にオブジェクト内での連続したマウスの動きを取り扱わせている場合、イベント矩形領域の上端と下端は是正されません。スクリーンを反映してこの座標をリロケート（再配置）するためには、後述の関数 event_offsetRect を使います。この関数を通じて、イベントの位置に関する対話的処理やタイムラインレジェンド（後述）での描画のための関数を呼び出すことの有用性がわかるでしょう。

key

バインディング

宣言

selected

バインディング

宣言

エディタがこのメッセージを受け取った場合、あなたは上に掲げた基準に従って state をセットしなければなりません。データの一部分の選択が許可されない（efunc のようなもの）、または、常に論理的全体として編集する（ナンバーボックスのようなもの）エディタがあります。この場合には、常に state は 1 になります。

track_setport

標準のエディタメッセージのコンテキスト外で描画を行う場合に、この関数が必要になります。 track_setport は、wind_setport や patcher_setport と同様のものです。トラックがあれば、確実に、トラックのグラフポートで描画が行われます。track_setport が 0 を返した場合には、その時点で、あなたのイベントを含むタイムラインウィンドウが見えない状態になっていることを意味しているため、何も描画すべきではありません。ユーザがパッチャーのコンテキスト内で Timeline オブジェクトを作り、そのウィンドウを閉じている場合、この状況は十分に起こり得ることです。また、あなたのインスタンス生成関数の中でも track_setport をチェックしなければなりません。この関数が０以外の値を返した場合、描画やグラフポート関連の呼出し（TextWidth のようなもの）は安全に行うことができます。そうでない場合、あなたのエディタがこのイベントから最初の update メッセージを受け取るまで、この呼出しを待たせておく必要があります。描画が完了した時、track_setport から返された非０の値を、Macintosh の Setport ルーチンに渡します。

event_offsetRect

wind_drag から呼び出されたマウストラック関数の中や queue 関数の中のような、標準でない環境での描画を行う前に、ウィンドウの上端から相対的となるようにイベントの矩形領域のオフセットを行う必要があります。

event_offsetRect はこれを行い、イベント長方形領域をリストアするための Macintosh ルーチン OffsetRect の垂直座標として使う値を返します。以下は、event_offsetRect の典型的な使い方です。

short offset; offset = event_offsetRect((Event *)x); /* ここで描画を行います。 */ OffsetRect(x->m_event.e_rect, 0,-offset); /* リストアのために打ち消しを行います */

track_clipBegin

wind_drag から呼び出されたマウストラッキング関数が動作している間、あなたのイベント矩形領域を描画する前に、描画をカレントのトラック矩形領域内に制限することが必要です。その理由は、イベントが部分的にトラックの見えている部分の外側にあるかも知れないためです。これは、track_clipBegin と track_clipEnd を呼び出して、全ての描画で描画範囲を制限することによって行われます。eventStart メッセージによってセットされた queue 関数内のように、Timeline から上記のような直接のメッセージを受けることができない状況で描画を行う場合でも、track_clipBegin と track_clipEnd を使わなければなりません。既に述べた標準のメッセージセットの何れか（update、click 等）をあなたのエディタが受け取る場合には、すでにクリッピングは設定済みなため、これらの関数を用いる必要はありません。

track_clipEnd

個々のtrack_clipBegin の呼出しに対して track_clipEnd の呼出しが対応していない場合、タイムラインウィンドウ内で、怪しい描画の動作が起きることが知られています。

track_pixToMS

track_pixToMS は、トラックとピクセル間隔を与えると、タイムラインのその時点でののズームレベルに基づいて、このピクセル数に見合ったミリセカンドの値を返します。

track_MSToPix

track_MSToPix は、ミリセカンドで表される持続時間を与えると、タイムラインのその時点でのズームレベルに基づいて、この持続時間に見合ったピクセル数を返します。

track_posToMS

track_posToMS は、トラックと位置を表す x 座標を与えると、タイムラインのその時点でのズームレベルに基づいて、その位置に見合ったミリセカンドで表されるイベントタイムを返します。

track_MSToPos

track_MSToPos は、トラックとミリセカンドで表されるイベントタイムを与えると、タイムラインのその時点でのズームレベルに基づいて、その時間の値に見合ったタイムラインウィンドウ内の位置を表す座標を返します。

track_drawDragTime

この関数は、カレントの時間フォーマットに従った文字列に変換された２つの値を受け取り、タイムラインレジェンドに表示します。通常、これはイベント長方形領域がドラッグされる際に、始まりと終わりの時間を表示するために使われます。値 time1 は通常、移動させられるアイテムの左端の値とみなされ、time2 は右端の値と見なされます。１つの値だけを描画したい場合、track_drawTime を使うことができます。

track_drawDragParam

この関数は、イベント矩形領域内での編集動作に対応して変更されるパラメータのカレントの値を記述するために、タイムラインウィンドウのレジェンド（説明）部分に文字列を描画することを可能にします。efunc オブジェクトは、ドラッグされる点のカレントの X、Y の値を表示するためにこのルーチンを使います。

track_drawTime

この関数は、タイムラインウィンドウのレジェンド部分に、１つの時間の値を描画します。

track_eraseDragTime

この関数は、上記の３つの関数によって描画されたものを消去します。