移動先: 概要 戻り値 フラグ. Python 例.
nodeIconButton(
[string]
, [align=string], [annotation=string], [backgroundColor=[float, float, float]], [command=script], [defineTemplate=string], [disabledImage=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [exists=boolean], [font=string], [height=int], [image=string], [image1=string], [image2=string], [image3=string], [imageOverlayLabel=string], [isObscured=boolean], [label=string], [labelOffset=int], [manage=boolean], [marginHeight=uint], [marginWidth=uint], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [style=string], [useTemplate=string], [visible=boolean], [width=int])
注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。
nodeIconButton は 「元に戻す」が可能、「照会」が可能、「編集」が可能 です。
このコントロールは、アイコン イメージを最大 3 つまで、ディスプレイ スタイルを最大 4 つまでサポートします。カレント スタイルが指定されている場合、表示されるアイコン イメージは、
コントロールのカレント サイズに最適なイメージです。
このコマンドはボタンを作成します。このボタンはいろいろなアイコンで表示可能で、テキスト ラベルは付けても付けなくても支障ありません。ボタンをその他のコントロール（たとえばハイパーシェード）にドラッグ＆ドロップすると、コマンドが実行され、返される文字列はドロップされたノードの名前として使用されます。
戻り値の型は照会モードでは照会フラグが基になります。
align, annotation, backgroundColor, command, defineTemplate, disabledImage, docTag, dragCallback, dropCallback, enable, exists, font, height, image, image1, image2, image3, imageOverlayLabel, isObscured, label, labelOffset, manage, marginHeight, marginWidth, numberOfPopupMenus, parent, popupMenuArray, preventOverride, style, useTemplate, visible, 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
|
|
|
コントロールの可視の状態です。デフォルトでは、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって
異なることに注意してください。
|
|
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'」）。
|
|
image1(i1)
|
string
|
|
|
|
image2(i2)
|
string
|
|
|
|
image3(i3)
|
string
|
|
|
このコントロールは、3 つのアイコンをサポートしています。コントロールのカレント サイズに最適なアイコンが表示されます。
|
|
image(i)
|
string
|
|
|
サイズの異なるイメージがなければ、
このフラグをコントロールのイメージに使用できます。
|
|
disabledImage(di)
|
string
|
|
|
ボタンが無効になっているときに使用されるイメージです。イメージのサイズは、-i/image フラグで指定したイメージのサイズと
同じである必要があります。
これは Windows 専用のフラグです。
|
|
imageOverlayLabel(iol)
|
string
|
|
|
イメージの前面に表示される短い文字列（5 文字）のラベルです。
|
|
label(l)
|
string
|
|
|
|
style(st)
|
string
|
|
|
コントロールの描画スタイルです。有効なスタイルは、「iconOnly」、「textOnly」、「iconAndTextHorizontal」、「iconAndTextVertical」、と「iconAndTextCentered」です。注: 「iconAndTextCentered」は、Windows 上でのみ使用可能です。
|
|
align(al)
|
string
|
|
|
ラベル アラインメントです。アラインメントの値は、「left」、「right」、「center」です。デフォルトでは、ラベルは「center」にアラインされます。
現在は、-st/style が「iconAndTextCentered」に設定されている場合にのみ使用可能です。
|
|
labelOffset(lo)
|
int
|
|
|
ラベル オフセットです。デフォルトは 0 です。
現在は、-st/style が「iconAndTextCentered」に設定されている場合にのみ使用可能です。
|
|
marginWidth(mw)
|
uint
|
|
|
コントロール コンテンツの両側にあるピクセル数。
デフォルト値は 1 ピクセルです。
|
|
marginHeight(mh)
|
uint
|
|
|
コントロール コンテンツの上下にあるピクセル数。
デフォルト値は 1 ピクセルです。
|
|
font(fn)
|
string
|
|
|
テキストのフォントです。有効な値は、「boldLabelFont」、「smallBoldLabelFont」、「tinyBoldLabelFont」、「plainLabelFont」、「smallPlainLabelFont」、「obliqueLabelFont」、「smallObliqueLabelFont」、「fixedWidthFont」、「smallFixedWidthFont」です。
|
|
command(c)
|
script
|
|
|
コントロールを押したときに実行されるコマンドです。このコマンドは、ノードのドラッグ＆ドロップを可能にする文字列を返します。
|
|
|
: コマンドの作成モードで使用可能なフラグ
|
: コマンドの編集モードで使用可能なフラグ
|
|
: コマンドの照会モードで使用可能なフラグ
|
: タプルまたはリストとして渡された複数の引数を持てるフラグ
|
import maya.cmds as cmds
window = cmds.window( )
cmds.columnLayout( adjustableColumn=True )
cmds.nodeIconButton( style='textOnly', command='cmds.shadingNode("lambert", asShader=True)', label='lambert' )
cmds.nodeIconButton( style='iconOnly', command='cmds.sphere()', image1='sphere.xpm' )
cmds.nodeIconButton( style='iconAndTextHorizontal', command='cmds.spotLight()', image1='spotlight.xpm', label='Spot Light' )
cmds.showWindow( window )