移動先: 概要 戻り値 フラグ Python の例

概要

checkBox( [string] , [align=string], [annotation=string], [backgroundColor=[float, float, float]], [changeCommand=script], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [editable=boolean], [enable=boolean], [exists=boolean], [height=int], [isObscured=boolean], [label=string], [manage=boolean], [numberOfPopupMenus=boolean], [offCommand=script], [onCommand=script], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [recomputeSize=boolean], [useTemplate=string], [value=boolean], [visible=boolean], [width=int])

注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。

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

このコマンドは、チェック ボックスを作成します。チェック ボックスは、テキスト ラベルとオン/オフの状態を含む単純なコントロールです。コマンドは、次のイベントのいずれにでも、またすべてにでもアタッチすることができます。チェック ボックスをオンにしたとき、オフにしたとき、または単に状態が変化したとき。

戻り値

stringコントロールへのフル パス名です。

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

フラグ

align, annotation, backgroundColor, changeCommand, defineTemplate, docTag, dragCallback, dropCallback, editable, enable, exists, height, isObscured, label, manage, numberOfPopupMenus, offCommand, onCommand, parent, popupMenuArray, preventOverride, recomputeSize, useTemplate, value, visible, width
ロング ネーム(ショート ネーム) 引数型 プロパティ
exists(ex) boolean create
指定したオブジェクトが存在するかどうかによって、 true または false を返します。他のフラグは無視されます。
defineTemplate(dt) string create
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに 追加するモードに、コマンドのモードを変更します。 templateName がカレントのテンプレートとして設定されていれば、 その後コマンドが実行されるたびに、この引数がデフォルトの引数として使用されます。
useTemplate(ut) string create
コマンドに、カレント以外のコマンド テンプレートの使用を強制します。
parent(p) string createquery
コントロールの親のレイアウトです。
enable(en) boolean createqueryedit
コントロールの有効、無効です。デフォルトでは true に設定されていて、コントロールは有効になっています。false を指定すると コントロールはグレー表示になって無効になります。
width(w) int createqueryedit
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
height(h) int createqueryedit
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
visible(vis) boolean createqueryedit
コントロールの可視の状態です。デフォルトでは、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって 異なることに注意してください。
isObscured(io) boolean query
コントロールが実際に表示されるかどうかを返します。 コントロールは、次の場合に隠れた状態になります。 非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、 コントロールまたは親のレイアウトを制御できない場合、あるいは コントロールのウィンドウが非表示またはアイコン化されている場合。
manage(m) boolean createqueryedit
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。デフォルトでは、コントロールは管理できるように作成されます。
numberOfPopupMenus(npm) boolean query
このコントロールにアタッチされるポップアップ メニューの数を返します。
popupMenuArray(pma) boolean query
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
preventOverride(po) boolean createqueryedit
true の場合、コントロールのコントロールは親のレイアウトの条件によって無効にされ右マウス ボタン メニューを使用した コントロール アトリビュートのオーバーライドは無効です。
annotation(ann) string createqueryedit
コントロールに文字列値で注釈を付けます。
backgroundColor(bgc) [float, float, float] createedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0~1.0 です(Windows のみのフラグです)。
docTag(dtg) string createqueryedit
コントロールにドキュメンテーション フラグを追加します。ドキュメンテーション フラグは、 階層のようなディレクトリ構造になっています。 例: -dt render/multiLister/createNode/material
dragCallback(dgc) script createedit
中マウス ボタンを押すと呼び出されるコールバックを追加します。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 createedit
ドラッグ&ドロップ操作をドロップ位置で解放したときに呼び出されるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。

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

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

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

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'」)。

label(l) string createqueryedit
ラベル テキストです。デフォルトのラベルはコントロールの名前です。
value(v) boolean createqueryedit
チェック ボックスの状態です。
align(al) string createqueryedit
ラベル アラインメントです。アラインメントの値は、「left」、「right」、「center」です。アラインは、コントロールがラベル長よりも広い場合のみ意味を持ちます。 デフォルトでは、ラベルは「center」にアラインされます。
editable(ed) boolean createqueryedit
チェック ボックスの編集状態です。デフォルトでは、このフラグは true に設定され、チェック ボックスの値はクリックして変更することができます。false の場合は、チェック ボックスは「読み取り専用」になり、クリックできません。チェック ボックスの値は、-ed/editable フラグの状態に関わらず、-v/value フラグで常に変更できます。
recomputeSize(rs) boolean createqueryedit
true の場合、ラベルのサイズにぴったり合うようにコントロールのサイズが再計算されます。false の場合、コントロールのサイズは、ラベルのサイズを変更するときに固定されます。このフラグのデフォルトの値は true です。
onCommand(onc) script createedit
チェック ボックスがオンになったときに実行されるコマンドです。
offCommand(ofc) script createedit
チェック ボックスがオフになったときに実行されるコマンドです。
changeCommand(cc) script createedit
チェック ボックスの状態が変更された場合に実行されるコマンドです。 このフラグは、onCommand と offCommand と併用しないでください。つまり、changeCommand を使用してコールバックの内側でチェック ボックスの状態をテストするか、onCommand と offCommand を独立したコールバックとして使用してください。

: コマンドの作成モードで使用可能なフラグ : コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ : タプルまたはリストとして渡された複数の引数を持てるフラグ

Python の例

import maya.cmds as cmds

window = cmds.window('window', width=150)
cmds.columnLayout( adjustableColumn=True )
cmds.checkBox( label='Default' )
cmds.checkBox( label='Left', align='left' )
cmds.checkBox( label='Centre', align='center' )
cmds.checkBox( label='Right', align='right' )
cmds.showWindow( window )