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

概要

gradientControl( [string] , [adaptiveScaling=boolean], [annotation=string], [attribute=name], [backgroundColor=[float, float, float]], [defineTemplate=string], [docTag=string], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [enableKeyboardFocus=boolean], [exists=boolean], [fullPathName=boolean], [height=int], [highlightColor=[float, float, float]], [isObscured=boolean], [manage=boolean], [noBackground=boolean], [numberOfControls=uint], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [refreshOnRelease=uint], [selectedColorControl=string], [selectedInterpControl=string], [selectedPositionControl=string], [staticNumberOfControls=boolean], [staticPositions=boolean], [statusBarMessage=string], [upperLimitControl=string], [useTemplate=string], [verticalLayout=boolean], [visible=boolean], [visibleChangeCommand=script], [width=int])

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

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

このコマンドは、指定したグラディエント アトリビュートを表示するコントロールを作成します。グラディエント アトリビュートは、適切な形と名前を持つ必要があります。これはマルチ アトリビュートであり、各エントリは次のような内容からなる複合アトリビュートです。
  1. カラー複合値または float 値(コントロールが自動的にいずれかを検出して、これに応じてランプまたはグラフを表示します)
  2. 位置: 単一の float アトリビュート
  3. 補間タイプ: enum
現在、ランプ構造の値を得るためのルーチン(補間付き)は、MEL では使用できません。これにより、エンド ユーザによるこのコントロールの使用が制限されます。MEL コマンド AEaddRampControl は、Attribute Editor テンプレートからこのコントロールをアトリビュートにアタッチするために使用します。

戻り値

string作成または修正されたポート名

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

フラグ

adaptiveScaling, annotation, attribute, backgroundColor, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, enableKeyboardFocus, exists, fullPathName, height, highlightColor, isObscured, manage, noBackground, numberOfControls, numberOfPopupMenus, parent, popupMenuArray, preventOverride, refreshOnRelease, selectedColorControl, selectedInterpControl, selectedPositionControl, staticNumberOfControls, staticPositions, statusBarMessage, upperLimitControl, useTemplate, verticalLayout, visible, visibleChangeCommand, width
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
adaptiveScaling(adaptiveScaling) boolean createqueryedit
ランプ ウィジェットの表示を垂直方向にスケールして、1.0 よりも大きな値に対応できます。adaptiveScaling が有効な場合は true、有効でない場合は false (既定)を返します。
annotation(ann) string createqueryedit
コントロールに文字列値で注釈を付けます。
attribute(at) name create
コントロールするグラディエント アトリビュートの名前を指定します。
backgroundColor(bgc) [float, float, float] createqueryedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0~1.0 です。
backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
defineTemplate(dt) string create
他の任意のフラグと引数を解析し、かつ引数で指定したコマンド テンプレートに追加するモードに、コマンドのモードを変更します。 templateName が現在のテンプレートとして設定されていれば、その後コマンドが実行されるたびに、この引数が既定の引数として使用されます。
docTag(dtg) string createqueryedit
コントロールにドキュメンテーション フラグを追加します。ドキュメンテーション フラグは、ディレクトリ構造になっています。 (例: -dt render/multiLister/createNode/material)
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]キーを押してコントロールに移動し、キーボードで値を選択することができます。有効でない場合は、マウスのみを使用できます。このフラグは通常、編集コントロールやリスト コントロールなどで既定で使用されるコントロールから、キーボード フォーカスのサポートをオフにするために使用されます。
exists(ex) boolean create
指定したオブジェクトが存在するかどうかを返します。他のフラグは無視されます。
fullPathName(fpn) boolean query
すべての親を含むウィジェットのフル パス名を返します。
height(h) int createqueryedit
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
highlightColor(hlc) [float, float, float] createqueryedit
コントロールのハイライト カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0~1.0 です。
isObscured(io) boolean query
コントロールが実際に表示されるかどうかを返します。コントロールは、次の場合に隠れた状態になります。非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、コントロールまたは親のレイアウトを制御できない場合、あるいはコントロールのウィンドウが非表示またはアイコン化されている場合。
manage(m) boolean createqueryedit
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。既定では、コントロールは管理できるように作成されます。
noBackground(nbg) boolean createedit
コントロールのバックグラウンドをクリア/リセットします。バックグラウンドは、true を渡すと一切描画されず、false を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
numberOfControls(nc) uint query
ランプ ウィジェットにあるコントロールの数を返します。
numberOfPopupMenus(npm) boolean query
このコントロールにアタッチされるポップアップ メニューの数を返します。
parent(p) string createquery
コントロールの親のレイアウトです。
popupMenuArray(pma) boolean query
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
preventOverride(po) boolean createqueryedit
true の場合、コントロールの右マウス ボタン メニューを使用したコントロール アトリビュートのオーバーライドは無効になります。
refreshOnRelease(ror) uint createqueryedit
ランプ ウィジェットをインタラクティブに編集しているときに、更新をディスパッチする方法を定義します。true に設定すると、更新は編集後にマウス ボタンを離した後にのみディスパッチされます。false (既定)に設定すると、更新は編集時(たとえば、ランプ カーブ ポイントの移動中)にインタラクティブにディスパッチされます。グローバル更新モードが「on release」に設定されていると、このオプションの効果が無効になることがあるので注意してください。
selectedColorControl(scc) string createedit
選択したカラーを編集するカラー コントロールの名前を指定します。
selectedInterpControl(sic) string createedit
選択した補間を編集する enum コントロールの名前を指定します。
selectedPositionControl(spc) string createedit
選択した位置を編集する float スライダの名前を指定します。
staticNumberOfControls(snc) boolean createqueryedit
「true」の場合、このフラグはランプ ウィジェットの対話を通じたランプ エントリ(コントロール ポイント)の作成/削除を無効にします。既定は false です。
staticPositions(sp) boolean createqueryedit
「true」の場合、このフラグはランプ エントリの位置のインタラクティブな変更を無効にします。既定は false です。
statusBarMessage(sbm) string createedit
マウスがコントロール上にある場合にステータス バーに表示する追加の文字列です。
upperLimitControl(ulc) string createqueryedit
ランプの表示の現在の上限を使用して更新されるテキスト コントロールの名前を指定します。このオプションは、adaptiveScaling が指定されている場合にのみ効果があります。
useTemplate(ut) string create
コマンドに、現在のものとは異なるコマンド テンプレートを使用するように強制します。
verticalLayout(vl) boolean createqueryedit
「true」の場合、コントロールは水平方向ではなく垂直方向になります。既定は「false」(水平)です。
visible(vis) boolean createqueryedit
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
visibleChangeCommand(vcc) script createqueryedit
コントロールの可視の状態が変更されたときに実行されるコマンドです。
width(w) int createqueryedit
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。

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

Python 例

import maya.cmds as cmds

# Create a ramp widget for the profileCurve attribute
#
cmds.window( title='Gradient Control For Attribute' )
objName = cmds.createNode('polySplitRing')
cmds.columnLayout()
cmds.gradientControl( at='%s.profileCurve' % objName )
cmds.showWindow()

# To add a ramp widget in the attribute editor, call the
# AEaddRampControl mel script.
#