workspaceControl

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

概要

workspaceControl( [name] , [checksPlugins=boolean], [close=boolean], [closeCommand=script], [collapse=boolean], [defineTemplate=string], [dockToControl=[string, string]], [dockToMainWindow=[string, boolean]], [dockToPanel=[string, string, boolean]], [duplicatable=boolean], [exists=boolean], [floating=boolean], [height=boolean], [heightProperty=string], [horizontal=boolean], [initCallback=string], [initialHeight=int], [initialWidth=int], [label=string], [loadImmediately=boolean], [minimumWidth=boolean], [r=boolean], [requiredControl=string], [requiredPlugin=string], [resizeHeight=int], [resizeWidth=int], [restore=boolean], [retain=boolean], [stateString=string], [tabPosition=[string, boolean]], [tabToControl=[string, int]], [uiScript=script], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [width=boolean], [widthProperty=string])

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

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

戻り値

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

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
checksPlugins(cp)	boolean
(uiScript によって定義された) UI がコード内の 1 つまたは複数のプラグインのロード状態を確認するのかどうかを設定します。プラグインの自動ロードが完了するまで UI はロードされません。既定は false です。
close(cl)	boolean
ワークスペース コントロールを閉じます。
closeCommand(cc)	script
ワークスペース コントロールを閉じたときに実行されるコマンドです。
collapse(clp)	boolean
ワークスペース コントロールのタブ ウィジェットの親を折り畳むか、または展開します。
defineTemplate(dt)	string
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに追加するモードに、コマンドのモードを変更します。 templateName が現在のテンプレートとして設定されていれば、その後コマンドが実行されるたびに、この引数が既定の引数として使用されます。
dockToControl(dtc)	[string, string]
このワークスペース コントロールを指定されたコントロールの横にドッキングします。1 番目の引数はコントロール名で、2 番目の引数はコントロールに対して相対的なドッキング位置です(有効値は「left」、「right」、「top」、「bottom」)。
dockToMainWindow(dtm)	[string, boolean]
このワークスペース コントロールをメイン ウィンドウにドッキングします。1 番目の引数はメイン ウィンドウの枠に沿ったドッキング位置です(有効値は「left」、「right」、「top」、「bottom」)。2 番目の引数は、ドッキング位置にある 1 番目のコントロールに対してコントロールをタブ化するかどうかを示します。
dockToPanel(dtp)	[string, string, boolean]
このワークスペース コントロールを指定されたワークスペースのドッキング パネルにドッキングします。1 番目の引数はパネル名で、2 番目の引数はパネルの枠に沿ったドッキング位置です(有効値は「left」、「right」、「top」、「bottom」)。3 番目の引数はドッキング位置にある 1 番目のコントロールに対してコントロールをタブ化するかどうかを示します。
duplicatable(dup)	boolean
このワークスペース コントロールを複製できるかどうかを制御します。 既定の複製状態は、パネルが固有かどうかによって制御されます。固有のパネルを複製またはコピーすることはできません。パネルなしのワークスペース コントロールも、このフラグを使用して複製可能に設定されている場合を除いて複製できません。
exists(ex)	boolean
指定したオブジェクトが存在するかどうかを返します。他のフラグは無視されます。
floating(fl)	boolean
ワークスペース コントロールがフロート状態であるかどうかを示します。
height(h)	boolean
コントロールの現在の高さを返す照会モード専用フラグです。
heightProperty(hp)	string
ワークスペース コントロールの高さプロパティを設定します。有効な値は、 固定(fixed) - サイズを手動で変更できず、最大化や動的なサイズ変更を行うときに余分なスペースは生じません。 優先(preferred) - サイズを手動で変更できますが、最大化や動的なサイズ変更を行うときに余分なスペースは生じません。 自由設定(free) - サイズを手動で変更でき、最大化や動的なサイズ変更を行うときに余分なスペースが生じます。 既定値: 自由設定(free) 照会モードの場合は、ワークスペース コントロールの現在の高さプロパティが返されます。
horizontal(hr)	boolean
コントロールの方向です。このフラグは既定では true になっており、ウィジェットは水平方向に表示されます。 注: 現在は、「Toolbox」および「Shelf」のみが垂直の方向をサポートしています。
initCallback(ic)	string
コントロールをレイアウトに追加するときに実行される MEL コマンドを追加します。このコマンドは MEL プロシージャである必要があり、workspaceControl 名と一緒にパラメータとして呼び出されます。MEL コマンドは次の形式にする必要があります。 global proc callbackName(string $workspaceControlName) コマンド名に「save」を追加した場合は、レイアウトの保存中に呼び出されます。 global proc callbackNameSave(string $workspaceControlName)
initialHeight(ih)	int
ワークスペース コントロールを最初に表示する際の初期の高さです。
initialWidth(iw)	int
ワークスペース コントロールを最初に表示する際の初期の幅です。
label(l)	string
ラベル テキストです。既定のラベルはワークスペース コントロールの名前です。
loadImmediately(li)	boolean
uiScript によって定義される UI をワークスペース コントロールの作成後すぐに構築するか(True)、またはコントロールが実際に表示されるまで遅らせるか(False)を設定します。既定は false です。
minimumWidth(mw)	boolean
コントロールの最小の幅を最初の幅に設定します。これは、初期幅のフラグとともに使用する必要があります。パラメータが false の場合、最小幅は 0 に設定されます。
r(r)	boolean
ワークスペース コントロール ウィジェットが表示されているかどうか、そしてフローティングになっているか、あるいはワークスペース領域の上部にあるかどうかを示します。
requiredControl(rc)	string
ワークスペース コントロールの名前で、このワークスペース コントロールを正しく機能させるために開いておく必要があります。必要なコントロールが開いていない場合、このワークスペース コントロールは作成されません。また、必要なコントロールを閉じると、このワークスペース コントロールも閉じます。
requiredPlugin(rp)	string
ワークスペース コントロールの UI を構築するためにロードする必要があるプラグインの名前です。
resizeHeight(rsh)	int
フローティング ワークスペース コントロールの高さを指定の値にサイズ変更します。
resizeWidth(rsw)	int
フローティング ワークスペース コントロールの幅を指定の値にサイズ変更します。
restore(rs)	boolean
次のルールに従ってコントロールを復元します。 折り畳まれているコントロールは展開されます。 非表示のコントロールは表示されます。 最小化されているコントロールは復元されます。 コントロールがタブ グループ内の非アクティブなタブである場合は、アクティブなタブになります。
retain(rt)	boolean
ワークスペース コントロールを閉じたときに維持するか(つまり、非表示にするのみ)、または削除するかを設定します。既定は true です。
stateString(ss)	string
コントロールの状態を含む文字列です。initCallback フラグと組み合わせて使用されます。
tabPosition(tp)	[string, boolean]
タブの位置を変更します。有効な値は「north」、「east」、 「west」です。boolean 値です。true に設定されている場合は、親ウィジェット内のすべてのコントロールのタブの位置を変更します。true に設定されていない場合は、現在のコントロールの位置が変更されます。コントロールにはタブ ウィジェットと異なる方向を指定できます。コントロール タブの位置がタブ ウィジェットの位置と異なる場合に、コントロールがタブ ウィジェット内の唯一のコントロールになると、タブの位置が変更されます。照会時はコントロール タブの位置のみが返され、タブ ウィジェットの位置は返されません。これらは異なることがあります。
tabToControl(ttc)	[string, int]
このワークスペース コントロールを指定のコントロールにタブ化します。1 番目の引数はコントロール名で、2 番目の引数は含まれているタブ ウィジェット内のインデックス位置です(無効値はアペンドを意味します)。
uiScript(ui)	script
指定したスクリプトが起動され、workspaceControl の UI が構築されます。これは必須フラグです。
useTemplate(ut)	string
コマンドに、現在のものとは異なるコマンド テンプレートを使用するように強制します。
visible(vis)	boolean
ワークスペース コントロールの可視の状態です。既定では、コントロールは表示されます。非可視として作成されたコントロールは、閉じた状態で作成されます。このコントロールを表示するには、コントロールを編集してフラグ floating または visible を true に設定します。
visibleChangeCommand(vcc)	script
ワークスペース コントロールの可視の状態が変更されたときに実行されるコマンドです。
width(w)	boolean
コントロールの現在の幅を返す照会モード専用フラグです。
widthProperty(wp)	string
ワークスペース コントロールの幅プロパティを設定します。有効な値は、 固定(fixed) - サイズを手動で変更できず、最大化や動的なサイズ変更を行うときに余分なスペースは生じません。 優先(preferred) - サイズを手動で変更できますが、最大化や動的なサイズ変更を行うときに余分なスペースは生じません。 自由設定(free) - サイズを手動で変更でき、最大化や動的なサイズ変更を行うときに余分なスペースが生じます。 既定値: 自由設定(free) 照会モードの場合は、ワークスペース コントロールの現在の幅プロパティが返されます。

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

Python 例

import maya.cmds as cmds

def createCustomWorkspaceControlUI(*args):
  cmds.columnLayout()
  cmds.button()
  cmds.button()
  cmds.button()

cmds.workspaceControl("myCustomWorkspaceControl", retain=False, floating=True, uiScript="createCustomWorkspaceControlUI()");