shellField

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

概要

shellField( [string] , [annotation=string], [backgroundColor=[float, float, float]], [clear=boolean], [command=script], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [exists=boolean], [height=int], [isObscured=boolean], [manage=boolean], [numberOfHistoryLines=int], [numberOfPopupMenus=boolean], [numberOfSavedLines=int], [output=string], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [prompt=string], [useTemplate=string], [userInput=boolean], [visible=boolean], [width=int])

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

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

戻り値

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

フラグ

ロング ネーム（ショート ネーム）	引数型	プロパティ
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'」）。
prompt(pr)	string
プロンプト文字列です。
command(c)	script
Enter キーまたは Return キーが押されたときに実行するコマンド。 Enter キーまたは Return キーを押す前に「\」を使用した場合は、このコマンドは実行されません。この場合、次の行から入力を続行することができます。
clear(cl)	boolean
表示されたテキストをすべて消去し、フィールド上部のスクロールされたテキストもすべて削除します。フィールドをクリアしたあとは、空欄になってスクロール アップして前の行を見ることができなくなります。ただし、このフラグはコマンド ヒストリ バッファに影響を与えません。
userInput(ui)	boolean
ユーザ入力を単一の文字列値で返します。
output(out)	string
フィールドに文字列をエコーします。
numberOfSavedLines(nsl)	int
フィールドで記憶される行（スクロールされる行と現在表示されている行）の総数です。 この行数を超える行はすべて失われ、スクロールしても表示することはできません。有効な値は 1～32767 です。1 より小さい値は 1 とみなされます。同様に、32767 より大きな値は 32767 とみなされます。
numberOfHistoryLines(nhl)	int
コマンド ヒストリ バッファに保存される入力行数です。上下矢印キーを押すと、このバッファを 1 つずつ順番に選択することができます。有効な値は 0～32767 です。0 より小さい値は 0 とみなされます。同様に、32767 より大きな値は 32767 とみなされます。

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

Python 例

import maya.cmds as cmds

#    This proc will be called whenever return or enter is
#    pressed in the shell field.
#
def handleInput(shellField):
	#
	#    Echo the user's input.
	#
	input = cmds.shellField(shellField, query=True, userInput=True)
	echo = input + '\n'
	cmds.shellField(shellField, edit=True, output=echo)

#    Create a window containing a shell field and a couple buttons.
#    One button will clear the shell field, the other button will
#    close the window.
#
window = cmds.window(widthHeight=(300, 300) )
form = cmds.formLayout()
shellField = cmds.shellField()
clearButton = cmds.button(label='Clear')
closeButton = cmds.button(label='Close')

cmds.shellField(shellField, edit=True, command=('handleInput(\"' + shellField + '\")' ))
cmds.button(clearButton, edit=True, command=('cmds.cmdShell(\"' + shellField + '\", edit=True, clear=True)' ))
cmds.button(closeButton, edit=True, command=('cmds.deleteUI( \"' + window + '\", window=True )' ) )

cmds.formLayout( form, edit=True,
	attachForm=((shellField, 'top', 0), (shellField, 'left', 0), (shellField, 'right', 0),
				(clearButton, 'left', 0), (clearButton, 'bottom', 0),
				(closeButton, 'bottom', 0), (closeButton, 'right', 0)),
	attachControl=(shellField, 'bottom', 0, clearButton),
	attachNone=((clearButton, 'top'), (closeButton, 'top')),
	attachPosition=((clearButton, 'right', 0, 50), (closeButton, 'left', 0, 50)) )

cmds.showWindow( window )