checkBoxGrp

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

概要

checkBoxGrp( [groupName] , [adjustableColumn=int], [adjustableColumn2=int], [adjustableColumn3=int], [adjustableColumn4=int], [adjustableColumn5=int], [adjustableColumn6=int], [annotation=string], [backgroundColor=[float, float, float]], [changeCommand=script], [changeCommand1=script], [changeCommand2=script], [changeCommand3=script], [changeCommand4=script], [columnAlign=[int, string]], [columnAlign2=[string, string]], [columnAlign3=[string, string, string]], [columnAlign4=[string, string, string, string]], [columnAlign5=[string, string, string, string, string]], [columnAlign6=[string, string, string, string, string, string]], [columnAttach=[int, string, int]], [columnAttach2=[string, string]], [columnAttach3=[string, string, string]], [columnAttach4=[string, string, string, string]], [columnAttach5=[string, string, string, string, string]], [columnAttach6=[string, string, string, string, string, string]], [columnOffset2=[int, int]], [columnOffset3=[int, int, int]], [columnOffset4=[int, int, int, int]], [columnOffset5=[int, int, int, int, int]], [columnOffset6=[int, int, int, int, int, int]], [columnWidth=[int, int]], [columnWidth1=int], [columnWidth2=[int, int]], [columnWidth3=[int, int, int]], [columnWidth4=[int, int, int, int]], [columnWidth5=[int, int, int, int, int]], [columnWidth6=[int, int, int, int, int, int]], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [editable=boolean], [enable=boolean], [enable1=boolean], [enable2=boolean], [enable3=boolean], [enable4=boolean], [exists=boolean], [height=int], [isObscured=boolean], [label=string], [label1=string], [label2=string], [label3=string], [label4=string], [labelArray2=[string, string]], [labelArray3=[string, string, string]], [labelArray4=[string, string, string, string]], [manage=boolean], [numberOfCheckBoxes=int], [numberOfPopupMenus=boolean], [offCommand=script], [offCommand1=script], [offCommand2=script], [offCommand3=script], [offCommand4=script], [onCommand=script], [onCommand1=script], [onCommand2=script], [onCommand3=script], [onCommand4=script], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [rowAttach=[int, string, int]], [useTemplate=string], [value1=boolean], [value2=boolean], [value3=boolean], [value4=boolean], [valueArray2=[boolean, boolean]], [valueArray3=[boolean, boolean, boolean]], [valueArray4=[boolean, boolean, boolean, boolean]], [vertical=boolean], [visible=boolean], [width=int])

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

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

どのグループ コマンドを使用しても、カラム 1 から始まるカラムに個々のコントロールが配置されます。各コントロール（カラム）のレイアウトは、-cw/columnWidth、-co/columnOffset、-cat/columnAttach、-cal/columnAlign、-adj/adjustableColumn の各フラグを使用してカスタマイズできます。デフォルトでは、カラムはオフセットなしで左に揃えられ、幅は 100 ピクセルです。どのグループでも、1 つのカラムだけが調整できます。

このコマンドは、1 行に 1 から 4 までのチェック ボックスを作成します。 オプションのテキスト ラベルを持つことができます。

TelfBaseGrpCmd.cpp

戻り値

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

フラグ

ロング ネーム（ショート ネーム）	引数型	プロパティ
exists(ex)	boolean
指定したオブジェクトが存在するかどうかによって、 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)	boolean
コントロールが実際に表示されるかどうかを返します。 コントロールは、次の場合に隠れた状態になります。 非表示の場合、別のコントロールで（完全に、または部分的に）ブロックされた場合、 コントロールまたは親のレイアウトを制御できない場合、あるいは コントロールのウィンドウが非表示またはアイコン化されている場合。
manage(m)	boolean
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。デフォルトでは、コントロールは管理できるように作成されます。
numberOfPopupMenus(npm)	boolean
このコントロールにアタッチされるポップアップ メニューの数を返します。
popupMenuArray(pma)	boolean
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
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 == リンクのいずれかです。 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'」）。
columnWidth(cw)	[int, int]
引数は、カラム番号、カラム幅です。 指定したカラムの幅を設定します。ここで、最初のパラメータがカラム（インデックスは 1 から始まる）を指定し、2 つめのパラメータが幅を指定します。
columnWidth1(cw1)	int
第 1 カラムの幅を設定します。カラムがちょうど 1 つではない場合は、無視されます。
columnWidth2(cw2)	[int, int]
2 つのカラムの幅を設定します。カラムがちょうど 2 つではない場合は、無視されます。
columnWidth3(cw3)	[int, int, int]
3 つのカラムすべての幅を設定します。カラムがちょうど 3 つではない場合は、無視されます。
columnWidth4(cw4)	[int, int, int, int]
4 つのカラムすべての幅を設定します。カラムがちょうど 4 つではない場合は、無視されます。
columnWidth5(cw5)	[int, int, int, int, int]
5 つのカラムすべての幅を設定します。カラムがちょうど 5 つではない場合は、無視されます。
columnWidth6(cw6)	[int, int, int, int, int, int]
6 つのカラムすべての幅を設定します。カラムがちょうど 6 つではない場合は、無視されます。
columnAttach(cat)	[int, string, int]
引数は、カラム番号、アタッチメント タイプ、オフセットです。 指定可能なアタッチメントは、「left」、「right」、または「both」です。 カラムのアタッチメント タイプとオフセットを指定します。
columnAttach2(ct2)	[string, string]
2 つのカラムのアタッチメント タイプを設定します。カラムがちょうど 2 つではない場合は、無視されます。有効な値は「left」、「right」、「both」です。
columnAttach3(ct3)	[string, string, string]
3 つのカラムすべてのアタッチメント タイプを設定します。カラムがちょうど 3 つではない場合は、無視されます。有効な値は「left」、「right」、「both」です。
columnAttach4(ct4)	[string, string, string, string]
4 つのカラムすべてのアタッチメント タイプを設定します。カラムがちょうど 4 つではない場合は、無視されます。有効な値は「left」、「right」、「both」です。
columnAttach5(ct5)	[string, string, string, string, string]
5 つのカラムすべてのアタッチメント タイプを設定します。カラムがちょうど 5 つではない場合は、無視されます。有効な値は「left」、「right」、「both」です。
columnAttach6(ct6)	[string, string, string, string, string, string]
6 つのカラムすべてのアタッチメント タイプを設定します。カラムがちょうど 6 つではない場合は、無視されます。有効な値は「left」、「right」、「both」です。
columnOffset2(co2)	[int, int]
このフラグは -columnAttach2 フラグと併用します。そのフラグを併用しない場合、このフラグは無視されます。2 つのカラムのオフセットを設定します。適用されるオフセットは、-columnAttach2 フラグで指定したアタッチメントに基づいています。カラムがちょうど 2 つではない場合は、無視されます。
columnOffset3(co3)	[int, int, int]
このフラグは -columnAttach3 フラグと併用します。そのフラグを併用しない場合、このフラグは無視されます。3 つのカラムのオフセットを設定します。適用されるオフセットは、-columnAttach3 フラグで指定したアタッチメントに基づいています。カラムがちょうど 3 つではない場合は、無視されます。
columnOffset4(co4)	[int, int, int, int]
このフラグは -columnAttach4 フラグと併用します。そのフラグを併用しない場合、このフラグは無視されます。4 つのカラムのオフセットを設定します。適用されるオフセットは、-columnAttach4 フラグで指定したアタッチメントに基づいています。カラムがちょうど 4 つではない場合、このフラグは無視されます。
columnOffset5(co5)	[int, int, int, int, int]
このフラグは -columnAttach5 フラグと併用します。そのフラグを併用しない場合、このフラグは無視されます。5 つのカラムのオフセットを設定します。適用されるオフセットは、-columnAttach5 フラグで指定したアタッチメントに基づいています。カラムがちょうど 5 つではない場合は、無視されます。
columnOffset6(co6)	[int, int, int, int, int, int]
このフラグは -columnAttach6 フラグと併用します。そのフラグを併用しない場合、このフラグは無視されます。6 つのカラムのオフセットを設定します。適用されるオフセットは、-columnAttach6 フラグで指定したアタッチメントに基づいています。カラムがちょうど 6 つではない場合は、無視されます。
rowAttach(rat)	[int, string, int]
引数は、カラム、アタッチメント タイプ、オフセットです。 指定可能なアタッチメントは、「top」、「bottom」、または「both」です。 行全体のアタッチメント タイプとオフセットを指定します。
columnAlign(cal)	[int, string]
引数は、カラム番号、アラインメント タイプです。 指定可能なアライメントは、「left」、「right」、または「center」です。 指定したカラムのアラインメント タイプを設定します。
columnAlign2(cl2)	[string, string]
2 つのカラムのテキスト アラインメントを設定します。カラムがちょうど 2 つではない場合は、無視されます。有効な値は「left」、「right」、「center」です。
columnAlign3(cl3)	[string, string, string]
3 つのカラムすべてのテキスト アラインメントを設定します。カラムがちょうど 3 つではない場合は、無視されます。有効な値は「left」、「right」、「center」です。
columnAlign4(cl4)	[string, string, string, string]
4 つのカラムすべてのテキスト アラインメントを設定します。カラムがちょうど 4 つではない場合は、無視されます。有効な値は「left」、「right」、「center」です。
columnAlign5(cl5)	[string, string, string, string, string]
5 つのカラムすべてのテキスト アラインメントを設定します。カラムがちょうど 5 つではない場合は、無視されます。有効な値は「left」、「right」、「center」です。
columnAlign6(cl6)	[string, string, string, string, string, string]
6 つのカラムすべてのテキスト アラインメントを設定します。カラムがちょうど 6 つではない場合は、無視されます。有効な値は「left」、「right」、「center」です。
adjustableColumn(adj)	int
親のレイアウトのサイズ変更に従ってサイズを変化させるカラムを指定します。カラムの値は 1 から始まるインデックスです。0 を指定して、以前はサイズ調整可能であったカラムをオフに切り替えることもできます。
adjustableColumn2(ad2)	int
親のレイアウトのサイズ変更に従ってサイズを変化させるカラムを指定します。カラムがちょうど 2 つではない場合は、無視されます。
adjustableColumn3(ad3)	int
親のレイアウトのサイズ変更に従ってカラム サイズを変化させるカラムを指定します。カラムがちょうど 3 つではない場合は、無視されます。
adjustableColumn4(ad4)	int
親のレイアウトのサイズ変更に従ってサイズを変化させるカラムを指定します。カラムがちょうど 4 つではない場合、このフラグは無視されます。
adjustableColumn5(ad5)	int
親のレイアウトのサイズ変更に従ってサイズを変化させるカラムを指定します。カラムがちょうど 5 つではない場合は、無視されます。
adjustableColumn6(ad6)	int
親のレイアウトのサイズ変更に従ってサイズを変化させるカラムを指定します。カラムがちょうど 6 つではない場合は、無視されます。
numberOfCheckBoxes(ncb)	int
グループ（1 - 4）のチェック ボックスの数です。
label(l)	string
作成時に存在している場合、グループと一緒にオプションのテキスト ラベルが作成されます。文字列でラベル テキストを指定します。
label1(l1)	string
label2(l2)	string
label3(l3)	string
label4(l4)	string
グループの各チェック ボックスのラベル文字列を指定します。
labelArray2(la2)	[string, string]
labelArray3(la3)	[string, string, string]
labelArray4(la4)	[string, string, string, string]
単一のフラグで複数のラベルを指定します。ラジオ ボタンの数が一致しない場合、これらのフラグは無視されます。
value1(v1)	boolean
value2(v2)	boolean
value3(v3)	boolean
value4(v4)	boolean
グループの各チェック ボックスの値です。
valueArray2(va2)	[boolean, boolean]
valueArray3(va3)	[boolean, boolean, boolean]
valueArray4(va4)	[boolean, boolean, boolean, boolean]
1 つのフラグに複数の値を指定します。チェック ボックスの数が一致しない場合、これらのフラグは無視されます。
changeCommand(cc)	script
グループの状態が変更されたときに実行されるコマンドです。 このフラグは、onCommand と offCommand と併用しないでください。つまり、changeCommand を使用してコールバックの内側でチェック ボックスの状態をテストするか、onCommand と offCommand を独立したコールバックとして使用してください。
changeCommand1(cc1)	script
changeCommand2(cc2)	script
changeCommand3(cc3)	script
changeCommand4(cc4)	script
各チェック ボックスに、changed state コマンドを指定します。
onCommand(onc)	script
チェック ボックスがオンの場合に実行されるコマンドです。
onCommand1(on1)	script
onCommand2(on2)	script
onCommand3(on3)	script
onCommand4(on4)	script
各チェック ボックスの on コマンドです。
offCommand(ofc)	script
チェック ボックスがオフの場合に実行されるコマンドです。
offCommand1(of1)	script
offCommand2(of2)	script
offCommand3(of3)	script
offCommand4(of4)	script
各チェック ボックスの off コマンドです。
enable1(en1)	boolean
enable2(en2)	boolean
enable3(en3)	boolean
enable4(en4)	boolean
各チェック ボックスの有効な状態です。
editable(ed)	boolean
グループの編集状態です。デフォルトでは、このフラグは true に設定され、チェック ボックスをクリックして変更することができます。false の場合、チェック ボックスは「読み取り専用」になり、クリックできません。チェック ボックスの値は、-ed/editable フラグの状態に関わらず、-v/value フラグで常に変更できます。
vertical(vr)	boolean
このグループ内のチェック ボックス コントロールの向きが横（デフォルト）か縦かの情報です。

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

Python の例

import maya.cmds as cmds

exampleWindow = cmds.window()
cmds.columnLayout()
cmds.checkBoxGrp( numberOfCheckBoxes=3, label='Three Buttons', labelArray3=['One', 'Two', 'Three'] )
cmds.checkBoxGrp( numberOfCheckBoxes=4, label='Four Buttons', labelArray4=['I', 'II', 'III', 'IV'] )
cmds.showWindow( exampleWindow )