導入
ピンを作成し名前を付ける際、ユーザーフレンドリーなピンを作成するためのオプションが利用可能です。このドキュメントでは、特別なピン命名オプションとその実践的な活用方法について説明します。
ピンは、コンパウンド内で露出させるか、Pin Collectorを使用することで作成できます。
特別な命名オプション
ピンに名前を付ける際に利用できる5つの特別なオプションがあります：
ボタン名は、コントロールボードのパネルにボタン、トグル、またはドロップダウンボックスを作成できます。
リスト名（例：Name List、Submod List、Sm Seq List（Submod Sequence List））は、ピンの値にドロップダウンを表示します。選択された値（アイテム）に応じて、追加のピンを表示できます。
リストはコントロールボードとフローエディターの両方で機能します。
このドキュメントでは、これらのオプションをそれぞれ説明し、使用方法を詳細に解説します。
ボタン
ボタンはコントロールボードパネルにのみ表示されます。ピンコレクターまたはコンパウンドを使用して、コントロールボードに作成して追加できます。
テキストは、コントロールボード上のボタンに表示されるテキストを決定します:
トリガーボタン
トリガーボタンは █ トリガーピンデータタイプと組み合わせて機能します。
例えば、ビデオプレーヤーモジュールで動画を再生開始するためにこのようなボタンを使用できます：
コントロールボードに次のようなボタンが表示されます：
ボタンを押すと、動画の再生が開始されます。
オン/オフボタン
オン/オフボタンは、█ 論理ピンデータタイプと組み合わせて機能します。
例えば、モジュールのオン/オフを切り替えるためにこのようなボタンを使用できます：
これらのボタンには、オフとオンの2つの状態があります:
ラジオボタン
ラジオボタンは、█ 整数ピンデータタイプと動作します。
ラジオボタンは、一度に1つだけアクティブにできるボタンの列です。
注: ピンコレクターまたはコンパウンドにボタン名付きのピンを追加することで、パネルに複数のボタンをアクティブにできます。または、ビットフラグボタンを使用してください。
例えば、カメラのズームレベルを切り替えるためにこのようなボタンを使用できます:
注: 上記の例では最初のボタンにテキストを設定していません。これは、最初のボタンが0の整数値を返すため、上記の例では0の値を使用しないためです。返される整数値はValue列にも表示されます。テキストを空にすると、その値に対応するボタンは表示されません。
注：Switch Scalar モジュールは値 0 に対してスイッチスカラーを定義しないため、カメラ モジュールのズーム係数が 0 になります。
これにより、コントロール ボードにボタンの一列が表示されます：
ボタンを追加
+ と x を使用して、ボタンを追加、挿入、削除できます：
値の列でボタンをドラッグして位置を変更できます：
ビットフラグ ボタン
ビットフラグボタンは █ 整数ピンデータ型と組み合わせて使用されます。
ラジオボタンとは異なり、ビットフラグボタンは複数のボタンを同時にアクティブにできます。
各ボタンはビットを表し、インデックスは1から始まります。ビット値は値列に表示されます：
注意：ビットテストモジュールを使用すると、アクティブなボタンを1つずつ確認できます。ビットテストモジュールは、そのインデックスピンがアクティブなボタンの値と一致する場合にtrueを返します。
以下のアクティブなボタンは整数値13（1+4+8）を返します：
ビデオボタン
ビデオボタンは█ 整数ピンデータ型と組み合わせて使用されます。
ビデオボタンは、一度に1つだけアクティブにできるボタンの列です。
ビデオファイルをビデオボタンにドラッグアンドドロップできます：
これらのボタンは、ビデオボタンのピン（#$Name,）の下にある各ピンに対して自動的に生成されます。
これを行うには、これらのピンがファイルの場所を定義するピンに接続されている必要があります：
ピンは他のピンタイプによって中断されないようにし、すべての他のピンタイプはビデオピンの下に配置してください。
ビデオボタンのピンに追加された通常のボタンは、実際のビデオボタンの前に表示されます。
すべての通常のボタン（x）を削除し、最後のボタンにテキストを設定しない場合、ビデオボタンだけが表示されます。
ビデオボタンピンは、その順序に従って値を返します。最後に接続された通常のボタンの値も含まれます。
NOTE: 上記の論理でSwitch Video Miniモジュールを使用する場合、ビデオボタン前に通常のボタンが1つある場合、そのボタンはOFFボタンとして機能し、値0を返すため、動画は表示されません。
NOTE: ビデオボタンに画像をドラッグアンドドロップすることも可能です。ビデオピンは静止画像ピンとしても機能するためです。
NOTE: 任意のモジュールのファイル位置ピンを使用できます。例えば、テキストファイルモジュールのテキストファイルピンをビデオボタンピンに接続できます。
NOTE: ファイル エクスプローラー アプリケーションからファイルをドラッグアンドドロップでビデオ ボタンに配置することも可能です。
ボタン間の間隔を追加
Gap列を使用してボタンを間隔をあけて配置できます:
上記の Gap 値は、最初のボタン前に1単位、2番目のボタン前に3単位の間隔を空けます:
NOTE: ボタン名を使用する複数のピン之间にもこのような間隔を空けることができます。
ボタンにアイコンを追加する
アイコン▼を使用して、テキストの代わりにアイコンをボタンに表示できます：
例：オーディオ、一時停止、再生、再生中のアイコンが使用されています：
追加のユーザーアイコンライブラリフォルダーは、複合設定...に追加できます。
ライブラリは、複合内に存在するすべてのコントロールボードで利用可能です。
128x128ピクセル解像度のPNG形式の画像を使用することをおすすめします。
ボタンに選択パネルを追加
選択パネルは、ボタンを異なるコントロールボードパネルに関連付ける複雑な方法です。また、ユーザーにパネルを選択させるための方法でもあります。
ボタンが押され、その選択パネルがコントロールボード上のパネル名と一致する場合、そのパネルが選択されます。
例えば、以下のボタンの選択パネル：
そのボタンが押された際に、以下のコントロールボードパネルが選択されます：
これは、キーイングモニターボタンがカメラコンパウンドで機能する仕組みと同じです：
リスト
リストピンは、コントロールボードとフローエディターの両方に表示されます。
リストピンは、█ 整数ピンデータタイプと組み合わせて機能します。
名前リスト
名前リストは最もシンプルなドロップダウンリストです。
ドロップダウンリストに新しい項目を追加するには、+ を使用します:
ボタンとは異なり、リストの値は1から始まります。
したがって、この例でオプション1を選択すると、整数値1が返されます:
リストはコントロールボードやピンコレクターに限定されません。コンパウンドにこのようなピンを追加することも可能です:
サブモッドリスト
サブモッドリストは、ピンがコンパウンドに露出されている場合のみ機能します。
注：フローエディター内の他のノードと同様に、コンパウンドもコントロールボードに追加できます。
サブモッドリストのピンは、コンパウンド内のノードを選択し、その入力ピン値を編集する機能を提供します。これにより、選択した設定に該当するピンだけを表示し、異なる設定を選択した際に該当するピンを非表示にできます。
注：例えば、カメラコンパウンドのコントロールボードでキーヤーを選択する際、同じ種類のピン名が使用されます。これにより、使用中のキーヤーの種類に対応するキーヤー設定のみを表示し、他の種類のキーヤーの設定を表示しないことが可能です。このコンパウンドは[Common_Studio]:Compounds\Keyers\Keyer__All.xcompにあります。
次の例では、Nameピンを使用して3つのノード（Copy Scalar、Keyer_CleanPlateGenerator、およびPin Collector）を選択できます：
コンパウンドには選択可能な3つのノードが含まれており、これらはサブモジュール名で定義されています：
Sm Seq List
Sm Seq ListはSubmod Sequence Listの略です。Sm Seq Listのピンは、Submod Listと類似した動作をします。ただし、Sm Seq Listはリスト内の前のアイテムのピンも表示できます。
例えば、ここで3を選択すると、シーケンスセレクターには2や1を選択した際と同じピンが表示されます：
Sm Seq Listは、サブモジュールプレフィックスに基づいてノードのリストを作成します。ここでは「Mon 1」、「Mon 2」、「Mon 3」の複合体がリストに表示されます。これらはすべて「Mon 」で始まり、その後に番号が続くためです。Amount列は、これらのノードのうち何個を表示するかを決定します：
NOTE: 上記の例ではアイテムに名前が付けられていないため、Amountがアイテム名として使用されています。
NOTE: サブモジュールプレフィックス後のノード番号には空白が許されません。例えば、「Mon 2」が存在せず「Mon 1」と「Mon 3」のみの場合、「Mon 3」は選択されません。
Amountに-1を指定すると、その正確なアイテム名を持つノードのみが選択されます。サブモジュールプレフィックスは無視されます。他のノードのピンは表示されません。これは通常の Submod List の動作と類似しています:
リダイレクト
リダイレクトオプションを使用すると、ピンの値を同じタイプの他のピンにリダイレクトできます。これにより、複数のピンを同じ値で一括更新できます。
設定するには、ターゲットピンを次の形式で指定します:
「モジュール名」:「ピン名」
コンパウンド内のピンをリダイレクトするにはバックスラッシュ (\) を使用したパスを、コンパウンド外のリダイレクトには ..\ を使用します。そうでない場合、リダイレクト先のピンは同じコンパウンド内またはルートレベルにあるモジュールをターゲットにします。
ターゲットピンの必要なパスは、コンテキストメニューのコピーフルパスオプションを使用して簡単に取得できます：
ユニークな名前
各ピンにはユニークな名前が必要です。
例えば、以下の例ではピンを「In」または「Video」と名付けることはできません。これらの名前は既に使用されています。
「Video」をリネームする場合でも、ピン名は「Video」と異なる必要があります。そうでない場合、赤色でマークされます：
リスト名では、以下のフィールドが一意である必要があります：
特殊なピン名にはコンマを使用できません。コンマはフルピン名のマーカーとして使用されるためです。
注：ピンをリネームするには、フローエディターでピンを右クリックし、「リネーム..」を選択します。または、コントロールボードのボタンを右クリックし、「変更...」を選択します。
フルピン名
特殊ピン名は、すべてのボタンやリスト項目を定義するフルピン名を生成します：
このフルピン名は、オートピン名モジュールでピン名を動的に生成したい場合のみ使用されます。
