toolButton コマンド

概要

toolButton [-allowMultipleTools boolean] [-annotation string] [-backgroundColor float float float] [-changeCommand script] [-collection string] [-defineTemplate string] [-docTag string] [-doubleClickCommand script] [-dragCallback script] [-dropCallback script] [-enable boolean] [-exists] [-height int] [-image1 string] [-image2 string] [-image3 string] [-imageOverlayLabel string] [-isObscured] [-manage boolean] [-numberOfPopupMenus] [-offCommand script] [-onCommand script] [-parent string] [-popupIndicatorVisible boolean] [-popupMenuArray] [-preventOverride boolean] [-select] [-style string] [-tool string] [-toolArray] [-toolCount] [-toolImage1 string string] [-toolImage2 string string] [-toolImage3 string string] [-useTemplate string] [-visible boolean] [-width int] [string]

toolButton は「元に戻す」が可能、「照会」が可能、「編集」が可能です。

cl/collection が使用されていない場合、toolButton を作成し、最後に作成されたツールボタンコレクションに追加します。さらに、指定したツールを配置し、コントロールが選択した時点で有効にします。

デフォルトでは、このコントロールは一度に 1 つのツールのみを扱います。t/tool フラグを使用して新しいツールをコネクトすると、以前にアタッチしたツールが単純にオーバーライドされます。amt/allowMultipleTools フラグを使用すると、このコントロールを使用して複数のツールをアタッチできます。ただし、コントロール内でカレントになるのは、1 つのツールのみです。他のツールにアクセスするには、右マウスボタンを押して、このコントロールに関連づけられたツールをすべて含むポップアップメニューを表示します。piv/popupIndicatorVisible フラグを設定すると、追加のツールがこのコントロールにアタッチされていることを示すため、コントロール上に小さな矢印が描かれます。

戻り値

string

作成された toolButton の名前。

戻り値の型は照会モードでは照会フラグが基になります。

フラグ

allowMultipleTools, annotation, backgroundColor, changeCommand, collection, defineTemplate, docTag, doubleClickCommand, dragCallback, dropCallback, enable, exists, height, image1, image2, image3, imageOverlayLabel, isObscured, manage, numberOfPopupMenus, offCommand, onCommand, parent, popupIndicatorVisible, popupMenuArray, preventOverride, select, style, tool, toolArray, toolCount, toolImage1, toolImage2, toolImage3, useTemplate, visible, width

ロングネーム（ショートネーム） 引数型 プロパティ

-exists(-ex)

指定したオブジェクトが存在するかどうかによって、 true または false を返します。他のフラグは無視されます。

-defineTemplate(-dt) string

他の任意のフラグと引数を解析し、かつ引数で指定したコマンドテンプレートに追加するモードに、コマンドのモードを変更します。 templateName がカレントのテンプレートとして設定されていれば、その後コマンドが実行されるたびに、この引数がデフォルトの引数として使用されます。

-useTemplate(-ut) string

コマンドに、カレント以外のコマンドテンプレートの使用を強制します。

-parent(-p) string

コントロールの親のレイアウトです。

-enable(-en) boolean

コントロールの有効、無効です。デフォルトでは true に設定されていて、コントロールは有効になっています。false を指定するとコントロールはグレー表示になって無効になります。

-width(-w) int

コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。

-height(-h) int

コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。

-visible(-vis) boolean

コントロールの可視の状態です。デフォルトでは、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。

-isObscured(-io)

コントロールが実際に表示されるかどうかを返します。コントロールは、次の場合に隠れた状態になります。非表示の場合、別のコントロールで（完全に、または部分的に）ブロックされた場合、コントロールまたは親のレイアウトを制御できない場合、あるいはコントロールのウィンドウが非表示またはアイコン化されている場合。

-manage(-m) boolean

コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。デフォルトでは、コントロールは管理できるように作成されます。

-numberOfPopupMenus(-npm)

このコントロールにアタッチされるポップアップメニューの数を返します。

-popupMenuArray(-pma)

このコントロールにアタッチされる全ポップアップメニューの名前を返します。

-preventOverride(-po) boolean

true の場合、コントロールのコントロールは親のレイアウトの条件によって無効にされ右マウスボタンメニューを使用したコントロールアトリビュートのオーバーライドは無効です。

-annotation(-ann) string

コントロールに文字列値で注釈を付けます。

-backgroundColor(-bgc) float float float

コントロールのバックグラウンドカラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です（Windows のみのフラグです）。

-docTag(-dtg) string

コントロールにドキュメンテーションフラグを追加します。ドキュメンテーションフラグは、階層のようなディレクトリ構造になっています。例: -dt render/multiLister/createNode/material

-dragCallback(-dgc) script

中マウスボタンを押すと呼び出されるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。

global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods)

proc はドロップ先に転送される文字配列を返します。規則により、配列の先頭文字列はユーザ設定可能なメッセージタイプを表しています。アプリケーションで定義されたドラッグ元のコントロールは、このコールバックを無視する可能性があります。$mods で、キーモディファイアである CTL と SHIFT をテストできます。有効な値は、0 == モディファイアなし、1 == SHIFT、2 == CTL、3 == CTL + SHIFT です。

Python でも同様ですが、コールバックの指定方法が 2 つあります。お勧めの方法は、引数として Python 関数オブジェクトを渡すことです。この場合、Python コールバックの書式は次のようになります。

def callbackName( dragControl, x, y, modifiers ):

この引数の値は、上記の MEL バージョンの引数と同じです。

Python でコールバックを指定するもう 1 つの方法では、実行する文字列を指定します。この場合、Python の標準的なフォーマット演算子を介して文字列に値が代入されます。このフォーマットの値は、キー「dragControl」、「x」、「y」、「modifiers」と共に辞書で渡されます。dragControl の値は文字列で、その他の値は整数です（コールバック文字列の例:「print '%(dragControl)s %(x)d %(y)d %(modifiers)d'」）。

-dropCallback(-dpc) script

ドラッグ＆ドロップ操作をドロップ位置で解放したときに呼び出されるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。

global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type)

proc は、ドラッグ元から転送される文字配列を受け取ります。 msgs 配列の先頭文字列はユーザ定義のメッセージタイプを表します。アプリケーションで定義されたドロップ先のコントロールでは、このコールバックが無視されることがあります。$type の値は、1 == 移動、2 == コピー、3 == リンクのいずれかです。

def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ):

この引数の値は、上記の MEL バージョンの引数と同じです。

Python でコールバックを指定するもう 1 つの方法では、実行する文字列を指定します。この場合、Python の標準的なフォーマット演算子を介して文字列に値が代入されます。このフォーマットの値は、キー「dragControl」、「dropControl」、「messages」、「x」、「y」、「type」と共に辞書で渡されます。dragControl の値は文字列で、その他の値は整数です（コールバック文字列の例:「print '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'」）。

-image1(-i1) string

-image2(-i2) string

-image3(-i3) string

このコントロールは 3 つの画像をサポートします。現在のコントロールのサイズにもっとも合う画像が表示されます。このフラグは、この画像を現在のツールに適用します。

-imageOverlayLabel(-iol) string

アイコンの上に表示される短い文字列（5 文字）のラベルです。

-toolImage1(-ti1) string string

-toolImage2(-ti2) string string

-toolImage3(-ti3) string string

このコントロールは 3 つの画像をサポートします。現在のコントロールのサイズにもっとも合う画像が表示されます。このフラグは、この画像を指定したツールに適用します。最初の引数はツールの名前、2 番目は画像の名前です。照会すると、1 組のツールアイコンの配列が返されます。

-style(-st) string

コントロールの描画スタイルです。有効な値は、「iconOnly」、「textOnly」、「iconAndTextHorizontal」、「iconAndTextVertical」です。

-onCommand(-onc) script

コントロールをオンにしたときに実行されるコマンドです。

-offCommand(-ofc) script

コントロールをオフにしたときに実行されるコマンドです。

-changeCommand(-cc) script

コントロールの状態を変更したときに実行されるコマンドです。このフラグは、onCommand と offCommand と併用しないでください。changeCommand を使用してコールバックの内側でコントロールの状態をテストするか、onCommand と offCommand を独立したコールバックとして使用してください。

-collection(-cl) string

ツールボタンをツールコレクションに明示的に追加します。

-doubleClickCommand(-dcc) script

コントロールをダブルクリックしたときに実行されるコマンドです。

-select(-sl)

このボタンを選択します。また、このフラグはコントロールの選択状態を照会します。

-tool(-t) string

ツールの名前をボタンにアタッチします。すでにこのボタンに指定したツールがアタッチされている場合は、そのツールが選択されます。このフラグへの照会は現在のツールを返します。このフラグは、2 つ以上のツールをアタッチするために 2 回以上指定されることがあります。

-allowMultipleTools(-amt) boolean

このコントロールで 2 つ以上のツールをアタッチできるかどうかを示します。デフォルトでは、このコントロールには 1 つのツールしかアタッチできません。このフラグを true にすると、複数のツールを追加することが可能になります。ただし、カレントになり表示されるのは、一度に 1 つのツールだけです。全ツールを見るには、右マウスボタンにをクリックして表示されるポップアップメニューを使用します。

-toolCount(-tc)

照会すると、toolButton コントロールにアタッチされたツールの数が返されます。

-toolArray(-ta)

照会すると、toolButton コントロールにアタッチされた全ツールの名前が返されます。

-popupIndicatorVisible(-piv) boolean

このフラグを編集して、ポップアップツールインディケータの可視性を設定することができます。このインディケータはボタン右上に表示されるシンプルな画像で、多くの場合、そのツールはこのコントロールに関連付けられています。このフラグはデフォルトでは照会可能で、true になっています。

: コマンドの作成モードで使用可能なフラグ	: コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ	: 1 つのコマンドで複数回使用可能なフラグ

MEL 例

  window;
      columnLayout;
      toolCollection;
      toolButton
          -tool       selectSuperContext
          -toolImage1 selectSuperContext "aselect.xpm";
      toolButton
          -tool       moveSuperContext
          -toolImage1 moveSuperContext "move_M.xpm";
      toolButton
          -tool       scaleSuperContext
          -toolImage1 scaleSuperContext  "scale_M.xpm";
  showWindow;

// example showing how to create tool buttons for artisan tools
  //
  // create the contexts
  $selectCtx = `artSelectCtx` ;
  $puttyCtx = `artPuttyCtx` ;
  $setPaintCtx = `artSetPaintCtx` ;
  window;
      gridLayout;
      toolCollection;
      // create the tool buttons using the contexts returned
      toolButton
          -amt true
          -piv true
          -doubleClickCommand toolPropertyWindow
          -tool $selectCtx
          -tool $puttyCtx
          -tool $setPaintCtx
          -toolImage1 $selectCtx "artSelect.xpm"
          -toolImage2 $puttyCtx "putty.xpm"
          -toolImage3 $setPaintCtx "paintSetMembership.xpm"
          selectTool2;
  showWindow;

コマンド (MEL)	Python バージョン
toolButton	カテゴリ: ウィンドウ, コントロール