ジャンプ先: 概要. 戻り値. フラグ. Python 例.
progressBar(
[string]
, [annotation=string], [backgroundColor=[float, float, float]], [beginProgress=boolean], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [endProgress=boolean], [exists=boolean], [fullPathName=string], [height=int], [isCancelled=boolean], [isInterruptable=boolean], [isMainProgressBar=boolean], [isObscured=boolean], [manage=boolean], [maxValue=int], [minValue=int], [noBackground=boolean], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [progress=int], [status=string], [step=int], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [width=int])
注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これはシノプシスに示されていません。
progressBar は、取り消し可能、照会可能、および編集可能です。
進行状況を視覚的に表す、プログレス バーのコントロールを作成します。
照会モードでは、戻り値のタイプは照会されたフラグに基づきます。
annotation, backgroundColor, beginProgress, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, endProgress, exists, fullPathName, height, isCancelled, isInterruptable, isMainProgressBar, isObscured, manage, maxValue, minValue, noBackground, numberOfPopupMenus, parent, popupMenuArray, preventOverride, progress, status, step, useTemplate, visible, visibleChangeCommand, width
| ロング ネーム(ショート ネーム) |
引数タイプ |
プロパティ |
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
|
|
|
すべての親を含むウィジェットのフル パス名を返します。
|
|
isCancelled(ic)
|
boolean
|
|
|
操作を解除しようとした場合、true を返します。その他の場合、false を返します。
|
|
progress(pr)
|
int
|
|
|
コントロールに現在表示される進捗状況です。値は常に最小値と最大値の間になり、既定値はコントロールが作成された時点の最小値です。
|
|
step(s)
|
int
|
|
|
指定した量の単位で -pr/progress の値を増分します。
|
|
minValue(min)
|
int
|
|
|
プログレス インジケータの最小値または「開始」値です。プログレス値が -min/minValue より小さい場合、プログレス値は最小に設定されます。既定値は 0 です。
|
|
maxValue(max)
|
int
|
|
|
プログレス インジケータの最大値または「終了」値です。プログレス値が -max/maxValue より大きい場合、プログレス値は最大に設定されます。既定値は 100 です。
|
|
isMainProgressBar(imp)
|
boolean
|
|
|
この progressBar を使用して、ファイルを開く/保存するなどすべての基本的な操作の進行状況を示すかどうかを決定します。
メインの progressBar の動作は、基本操作が継続している場合のみ表示されるため、大幅に異なります。
既定は false で、「メイン」のプログレス バーとして認識されるのは 1 つだけです。
|
|
status(st)
|
string
|
|
|
メイン プログレス バーに対してのみ有効
progressBar が表示されているときに、helpLine コントロールの内容を表示します。ヘルプ ラインを直接設定するかわりにこれを使うと、戻る前にグラフィックを強制的にリフレッシュします。
|
|
isInterruptable(ii)
|
boolean
|
|
|
メイン プログレス バーに対してのみ有効
isCancelled フラグを、操作のキャンセルの試行に対応させる場合に true を返します。これを true に設定すると、ユーザに対するヘルプ ライン表示メッセージにノートが追加され、操作をキャンセルできることが示されます。
|
|
beginProgress(bp)
|
boolean
|
|
|
メイン プログレス バーに対してのみ有効
メイン プログレス バーを表示します(通常はヘルプ ラインにあります)。これは通常、長さの計算を開始しようとするときに、MEL を通じて発行されます。
|
|
endProgress(ep)
|
boolean
|
|
|
メイン プログレス バーに対してのみ有効
メイン プログレス バーを非表示にします。他のフラグとは一緒に使用できません。これは通常、-ic/isCancelled フラグが設定された場合、もしくはプログレス値が最大値になった場合に、MEL を通じて発行されます。
|
|
|
フラグはコマンドの作成モードで表示できます
|
フラグはコマンドの編集モードで表示できます
|
|
フラグはコマンドの照会モードで表示できます
|
フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。
|
import maya.cmds as cmds
# Create a custom progressBar in a windows ...
window = cmds.window()
cmds.columnLayout()
progressControl = cmds.progressBar(maxValue=10, width=300)
cmds.button( label='Make Progress!', command='cmds.progressBar(progressControl, edit=True, step=1)' )
cmds.showWindow( window )
# Or, to use the progress bar in the main window ...
import maya.mel
gMainProgressBar = maya.mel.eval('$tmp = $gMainProgressBar')
cmds.progressBar( gMainProgressBar,
edit=True,
beginProgress=True,
isInterruptable=True,
status='Example Calculation ...',
maxValue=5000 )
for i in range(5000) :
if cmds.progressBar(gMainProgressBar, query=True, isCancelled=True ) :
break
cmds.progressBar(gMainProgressBar, edit=True, step=1)
cmds.progressBar(gMainProgressBar, edit=True, endProgress=True)