channelBox

ジャンプ先: 概要. 戻り値. フラグ. Python 例.

概要

channelBox( [string] , [annotation=string], [attrBgColor=[float, float, float]], [attrColor=[float, float, float]], [attrFilter=string], [attrRegex=string], [attributeEditorMode=boolean], [backgroundColor=[float, float, float]], [containerAtTop=boolean], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [enableLabelSelection=boolean], [execute=[string, boolean]], [exists=boolean], [fieldWidth=int], [fixedAttrList=[string,...]], [fullPathName=string], [height=int], [historyObjectList=boolean], [hyperbolic=boolean], [isObscured=boolean], [labelWidth=int], [longNames=boolean], [mainListConnection=string], [mainObjectList=boolean], [manage=boolean], [maxHeight=int], [maxWidth=int], [niceNames=boolean], [noBackground=boolean], [nodeRegex=string], [numberOfPopupMenus=boolean], [outputObjectList=boolean], [parent=string], [popupMenuArray=boolean], [precision=int], [preventOverride=boolean], [selectedHistoryAttributes=boolean], [selectedMainAttributes=boolean], [selectedOutputAttributes=boolean], [selectedShapeAttributes=boolean], [shapeObjectList=boolean], [showNamespace=boolean], [showTransforms=boolean], [speed=float], [takeFocus=boolean], [update=boolean], [useManips=string], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [width=int])

注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。

channelBox は、取り消し可能、照会可能、および編集可能です。

注: アトリビュート名のカラーを設定する場合、そのカラーは現在の Maya セッションでのみ有効です。後続の各セッションでは、チャネル ボックスにリスト表示されるアトリビュート名の既定のカラーが表示されます。チャネル ボックスに追加された後続アトリビュートはすべて、現在の Maya セッションでの以前の正規表現に影響されます。

戻り値

照会モードでは、戻り値のタイプは照会されたフラグに基づきます。

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
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
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
visibleChangeCommand(vcc)	script
コントロールの可視の状態が変更されたときに実行されるコマンドです。
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 です。 backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
noBackground(nbg)	boolean
コントロールのバックグラウンドをクリア/リセットします。バックグラウンドは、true を渡すと一切描画されず、false を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
enableBackground(ebg)	boolean
コントロールのバックグラウンド カラーを有効にします。
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'」)。
fullPathName(fpn)	string
すべての親を含むウィジェットのフル パス名を返します。
precision(pre)	int
浮動小数値のチャネルで表示される、小数点の右側の桁数を制御します。既定は 3 です。照会すると、整数を返します。
longNames(ln)	boolean
インタフェースでアトリビュートにロング ネームまたはショート ネームのどちらを使用するかを制御します。-niceName フラグが設定されている場合、このフラグは無視されることに注意してください。既定はショート ネームです。照会すると boolean を返します。
niceNames(nn)	boolean
アトリビュート名をもっとユーザフレンドリーで読みやすい表示にするかどうかを制御します。オンの場合、longNames フラグは無視されます。これがオフの場合、アトリビュート名は、longNames フラグに応じてロング ネームまたはショート ネームで表示されます。既定はオンです。照会すると boolean を返します。
attributeEditorMode(aem)	boolean
アトリビュート エディタ(Attribute Editor)で使用されるチャネル ボックス(Channel Box)に表示される内容を変更します。既定は false です。照会すると boolean を返します。
enableLabelSelection(els)	boolean
-attributeEditorMode と一緒に使用する場合、channelBox のアトリビュートの選択を有効にします。既定は false です。照会すると boolean を返します。
maxWidth(mw)	int
チャネルボックスの幅を制限するために使用される、オプションのフラグです。
maxHeight(mh)	int
チャネルボックスの高さを制限するために使用される、オプションのフラグです。
labelWidth(lw)	int
チャネルボックスに表示されるラベルに割り当てられる幅を修正するために使用される、オプションのフラグです。
fieldWidth(fw)	int
チャネルボックスに表示されるフィールドに割り当てられる幅を修正するために使用される、オプションのフラグです。
showTransforms(st)	boolean
このコントロールでトランスフォーム アトリビュートのみを表示するか、またはほかのアトリビュートすべてを表示するかを制御するコントロールです。既定は false です。照会すると boolean を返します。
mainObjectList(mol)	boolean
文字列リストを返します。このリストは、チャネル ボックスの一番上の(メイン)セクションに表示されるオブジェクトと同じタイプの、オブジェクトすべての名前を示します。
shapeObjectList(sol)	boolean
文字列リストを返します。このリストは、チャネル ボックスの真中の(シェイプ)セクションに表示されるオブジェクトと同じタイプの、メイン オブジェク トリストにあるオブジェクトに関連付けられた、シェイプすべての名前を示します。
historyObjectList(hol)	boolean
文字列リストを返します。このリストは、チャネル ボックスの入力セクションに表示されるノードと同じタイプの、メイン オブジェクト リストにあるオブジェクトに関連付けられた、INPUT ノードすべての名前を示します。
outputObjectList(ool)	boolean
文字列リストを返します。このリストは、チャネル ボックスの出力セクションに表示されるノードと同じタイプの、メイン オブジェクト リストにあるオブジェクトに関連付けられた、OUTPUT ノードすべての名前を示します。
selectedMainAttributes(sma)	boolean
文字列リストを返します。このリストは、チャネル ボックスの一番上のセクションにある選択したアトリビュートすべての名前を示します。
selectedShapeAttributes(ssa)	boolean
文字列リストを返します。このリストは、チャネル ボックスの真中(シェイプ)セクションにある選択したアトリビュートすべての名前を示します。
selectedHistoryAttributes(sha)	boolean
文字列リストを返します。このリストは、チャネル ボックスの入力セクションにある選択したアトリビュートすべての名前を示します。
selectedOutputAttributes(soa)	boolean
文字列リストを返します。このリストは、チャネル ボックスの出力セクションにある選択したアトリビュートすべての名前を示します。
execute(exe)	[string, boolean]
チャネル ボックスのセルごと(または、ブーリアン引数が TRUE の場合、選択したセルごと)、またはコマンド文字列を一度即座に実行し、選択したオブジェクトを合わせます(つまり、セルの値を変更すると、すべてのオブジェクトが影響を受けます)。コマンドが実行される前に、「#A」はアトリビュート名に、「#N」はノード名に、「#P」はノードのフル パス名にそれぞれ置き換えられます。
mainListConnection(mlc)	string
エディタがコンテンツのソースとして使用する selectionConnection オブジェクトの名前を指定します。チャネル ボックスは、selectionConnection オブジェクトにある(最後の)項目のみを表示します。NULL 文字列("")を指定すると、チャネル ボックスはアクティブ リストでの既定の動作に戻ります。
fixedAttrList(fal)	[string,...]
強制的にチャネル ボックスに指定した名前、順序でのみアトリビュートを表示させます。空のリストが指定した場合、チャネル ボックスはキー設定可能なアトリビュートすべてをリストする既定の動作に戻ります。
useManips(mnp)	string
チャネル ボックスのフィールドまたはラベルをクリックすると、ツールが、3D ビューでドラッグした場合に値を変更できるマニピュレータに切り替わります。このフラグはマニピュレータの種類を制御します。有効な値は、「none」(なし)、「invisible」(何も表示されないがウィンドウでドラッグすると選択したアトリビュートがすべて調整される)、と「standard」(通常のマニピュレータで示される、スケール、回転、移動を除き、非表示と同じ)です。
takeFocus(tf)	boolean
可能な場合、チャネル ボックスで、キーボードが切り替わります。
hyperbolic(hyp)	boolean
マウスのドラッグ距離をリニアまたは双曲線スケール関数として解釈するかどうかを定義します。既定では、hyperbolic が false として設定されます。
speed(spd)	float
マウスのドラッグ距離に基づいて、アトリビュートを変更するスピードを制御します。slow/medium/fast の通常の設定は、それぞれ 0.1/1.0/10.0 です。既定は 1.0 です。
showNamespace(sn)	boolean
オブジェクトが root namespace ではない場合、オブジェクトのネームスペースが表示されるかどうか制御します。
attrColor(ac)	[float, float, float]
特定のアトリビュート名のフォアグラウンド テキスト カラーをコントロールします。このテキストのカラーリングは、nodeRegex フラグに対するノード名の選択にも依存します。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。attrRegex を指定しない場合、正規表現については「*」を仮定します。同じ考え方が、フラグ nodeRegex にも適用されます。注: 名前が変更されたノードでは、チャネル ボックス内のノード名のカラーリングが影響されます。
attrBgColor(bc)	[float, float, float]
特定のアトリビュート名のバックグラウンド テキスト カラーをコントロールします。フォアグラウンド カラーのオプションと同様、このテキストのカラーリングは、nodeRegex フラグに対するノード名の選択にも依存します。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。attrRegex を指定しない場合、正規表現については「*」を仮定します。同じ考え方が、フラグ nodeRegex にも適用されます。注: 名前が変更されたノードでは、チャネル ボックス内のノード名のカラーリングが影響されます。
nodeRegex(nr)	string
有効な正規表現を使用して、フォアグラウンド テキスト カラーリングのためにどのノード名のアトリビュートを選択するようにするかを指定します。nodeRegex を指定しない場合、正規表現については「*」を仮定します。同じ考え方が、フラグ attrRegex にも適用されます。attrColor フラグを指定する必要があります。注: この正規表現は、大文字と小文字を区別せずに扱われます。注: 名前空間内のノードは、名前空間内に存在しないかのように正規表現が適用されます。
attrRegex(ar)	string
有効な正規表現を使用して、フォアグラウンド テキスト カラーリングのためにどのアトリビュート名を選択するかを指定します。attrRegex を指定しない場合、正規表現については「*」を仮定します。同じ考え方が、フラグ nodeRegex にも適用されます。attrColor フラグを指定する必要があります。注: この正規表現は、大文字と小文字を区別せずに扱われます
update(u)	boolean
このフラグを使用して、表示プリファレンスを変更した後などに、チャネル ボックス表示の更新を強制できます。
attrFilter(af)	string
このチャネル ボックスに配置する項目フィルタ オブジェクトの名前を指定します。これによって、表示されるアトリビュートがフィルタされます。「0」のフィルタを使用すると、フィルタをリセットできます。
containerAtTop(cat)	boolean
このフラグは、コンテナ内のノードが選択されたときに、コンテナをチャネル ボックスの上に描くかどうかを指定します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python 例

import maya.cmds as cmds

cmds.window()
cmds.formLayout( 'form' )
cmds.channelBox( 'dave' )
cmds.formLayout( 'form', e=True, af=(('dave', 'top', 0), ('dave', 'left', 0), ('dave', 'right', 0), ('dave', 'bottom', 0)) )
cmds.showWindow()

// Color all attributes names, which have an attribute name
// beginning with "T", white for all current and future objects
// in the current Maya session

cmds.channelBox( 'cb1', attrRegex='T*', attrColor=(1.0, 1.0, 1.0), attrBgColor=(0.0, 0.0, 0.0) )
cmds.channelBox( 'cb1', e=True, nodeRegex='D*', attrRegex='A*', attrColor=(0, 0, 0) )