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

概要

layerButton([annotation=string], [backgroundColor=[float, float, float]], [changeCommand=script], [color=[float, float, float]], [command=script], [current=boolean], [defineTemplate=string], [docTag=string], [doubleClickCommand=script], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [enableKeyboardFocus=boolean], [exists=boolean], [fullPathName=boolean], [height=int], [hideOnPlaybackCommand=script], [highlightColor=[float, float, float]], [identification=int], [isObscured=boolean], [label=string], [labelWidth=boolean], [layerHideOnPlayback=boolean], [layerState=string], [layerVisible=boolean], [manage=boolean], [name=string], [noBackground=boolean], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [renameCommand=string], [select=boolean], [statusBarMessage=string], [transparent=boolean], [typeCommand=script], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [visibleCommand=script], [width=int])

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

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

レイヤ バー ボタンが作成されます。レイヤ バー ボタンには、参照するレイヤの名前とカラー割当てを表すカラー サンプルが含まれます。レイヤ バーとレイヤ エディタ ウィンドウの構築に主に使用し、それぞれのリストの各レイヤでレイヤ バー ボタンが使用されます。

戻り値

stringコントロールへのフル パス名です。

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

関連

createDisplayLayer, editDisplayLayerGlobals, editDisplayLayerMembers

フラグ

annotation, backgroundColor, changeCommand, color, command, current, defineTemplate, docTag, doubleClickCommand, dragCallback, dropCallback, enable, enableBackground, enableKeyboardFocus, exists, fullPathName, height, hideOnPlaybackCommand, highlightColor, identification, isObscured, label, labelWidth, layerHideOnPlayback, layerState, layerVisible, manage, name, noBackground, numberOfPopupMenus, parent, popupMenuArray, preventOverride, renameCommand, select, statusBarMessage, transparent, typeCommand, useTemplate, visible, visibleChangeCommand, visibleCommand, width
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
annotation(ann) string createqueryedit
コントロールに文字列値で注釈を付けます。
backgroundColor(bgc) [float, float, float] createqueryedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。
backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
changeCommand(cc) script createedit
あらゆる種類の変更で呼び出すコマンドを設定します。
color(cl) [float, float, float] createedit
レイヤ カラー。正規化した実数を用いて、R、G、B の空間に指定します。
command(c) script createedit
シングル クリックでコールするコマンドを設定します。
current(cr) boolean createedit
現在のレイヤとして表示するようにこのボタンが設定されます。現在のレイヤは、ユーザが新しく作成したすべてのオブジェクトを追加できるレイヤです。NB:レイヤ ボタンをこの状態に設定しても、実際の現在のレイヤは影響されません。
defineTemplate(dt) string create
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに追加するモードに、コマンドのモードを変更します。 templateName が現在のテンプレートとして設定されていれば、その後コマンドが実行されるたびに、この引数が既定の引数として使用されます。
docTag(dtg) string createqueryedit
コントロールにドキュメンテーション フラグを追加します。ドキュメンテーション フラグは、ディレクトリ構造になっています。 (例: -dt render/multiLister/createNode/material)
doubleClickCommand(dcc) script createedit
ダブル クリックでコールするコマンドを設定します。
dragCallback(dgc) script createedit
中マウス ボタンを押すとコールされるコールバックを追加します。MEL バージョンのコールバックの書式は次のとおりです。

global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods)

proc はドロップ先に転送される文字配列を返します。規則により、配列の先頭文字列はユーザ設定可能なメッセージ タイプを表しています。アプリケーションで定義されたドラッグ元のコントロールは、このコールバックを無視する可能性があります。$mods で、キー モディファイアである CTRL と SHIFT をテストできます。 有効な値は、0 == モディファイアなし、1 == SHIFT、2 == CTRL、3 == CTRL + 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 createedit
ドラッグ＆ドロップ操作をドロップ位置で解放したときにコールされるコールバックを追加します。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'」)。

enable(en) boolean createqueryedit
コントロールの有効、無効です。既定では true に設定されていて、コントロールは有効になっています。false を指定するとコントロールはグレー表示になって無効になります。
enableBackground(ebg) boolean createqueryedit
コントロールのバックグラウンド カラーを有効にします。
enableKeyboardFocus(ekf) boolean createqueryedit
有効にすると、[Tab]キーを押してコントロールに移動し、キーボードまたはマウスで値を選択することができます。このフラグは通常、編集コントロールやリスト コントロールなどで既定で使用されるコントロールから、フォーカスのサポートをオフにするために使用されます。 無効にすると、テキスト フィールド内のテキストはマウスで選択できますが、コピーできません(Linuxで「中ボタンでクリックして貼り付け」が有効になっている場合を除く)。
exists(ex) boolean create
指定したオブジェクトが存在するかどうかを返します。他のフラグは無視されます。
fullPathName(fpn) boolean query
すべての親を含むウィジェットのフル パス名を返します。
height(h) int createqueryedit
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
hideOnPlaybackCommand(hpc) script createedit
レイヤ ボタンの「再生時に非表示」インジケータを押した場合にコールされるコマンド
highlightColor(hlc) [float, float, float] createqueryedit
コントロールのハイライト カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。
identification(id) int createqueryedit
レイヤに関連する整数識別番号。
isObscured(io) boolean query
コントロールが実際に表示されるかどうかを返します。コントロールは、次の場合に隠れた状態になります。非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、コントロールまたは親のレイアウトを制御できない場合、あるいはコントロールのウィンドウが非表示またはアイコン化されている場合。
label(l) string createqueryedit
ボタンのラベル テキストです。
labelWidth(lw) boolean query
ラベル部分とカラー スウォッチ部分のいずれがボタン クリックされたかを判定するするために、ラベル部分の幅を照会します。
layerHideOnPlayback(hp) boolean createqueryedit
再生時にレイヤが表示されているか非表示になっているかが示されます。
layerState(ls) string createqueryedit
レイヤの状態が記述されます。normal、template、reference のうちの、いずれかになります。
layerVisible(lv) boolean createqueryedit
レイヤが表示されているか非表示になっているかが示されます。
manage(m) boolean createqueryedit
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。既定では、コントロールは管理できるように作成されます。
name(n) string createquery
レイヤ名です。
noBackground(nbg) boolean createedit
コントロールのバックグラウンドをクリア/リセットします。バックグラウンドは、true を渡すと一切描画されず、false を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
numberOfPopupMenus(npm) boolean query
このコントロールにアタッチされるポップアップ メニューの数を返します。
parent(p) string createquery
コントロールの親のレイアウトです。
popupMenuArray(pma) boolean query
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
preventOverride(po) boolean createqueryedit
true の場合、コントロールの右マウス ボタン メニューを使用したコントロール アトリビュートのオーバーライドは無効になります。
renameCommand(rc) string createedit
レイヤの名前を変更した場合にコールされるようにコマンドが設定されます。文字列「#1」はコントロールの名前で置き換えられ、「#2」はレイヤの新しい名前で置き換えられます。
select(s) boolean createqueryedit
選択したレイヤとして表示するようにこのボタンを設定します。
statusBarMessage(sbm) string createedit
マウスがコントロール上にある場合にステータス バーに表示する追加の文字列です。
transparent(t) boolean createqueryedit
レイヤ カラーを表示するか透明にするかを指定します。
typeCommand(tc) script createedit
レイヤ ボタンのタイプ インジケータを押した場合にコールされるコマンド
useTemplate(ut) string create
コマンドに、現在のものとは異なるコマンド テンプレートを使用するように強制します。
visible(vis) boolean createqueryedit
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
visibleChangeCommand(vcc) script createqueryedit
コントロールの可視の状態が変更されたときに実行されるコマンドです。
visibleCommand(vc) script createedit
レイヤ ボタンの可視性インジケータを押した場合にコールされるコマンド
width(w) int createqueryedit
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
フラグはコマンドの作成モードで表示できます フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python 例

import maya.cmds as cmds

cmds.window()
cmds.columnLayout()
# Create a button for the default layer, colour it red and select it
b = cmds.layerButton(name='defaultLayer', cl=(1.0, 0.0, 0.0), s=True)
cmds.showWindow()

# Find out how wide the layer buttons are when created
width = cmds.layerButton(b ,q=True, labelWidth=True )