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

概要

cmdScrollFieldExecuter [-annotation string] [-appendText string] [-autoCloseBraces boolean] [-backgroundColor float float float] [-clear] [-commandCompletion boolean] [-copySelection] [-currentLine uint] [-cutSelection] [-defineTemplate string] [-docTag string] [-dragCallback script] [-dropCallback script] [-enable boolean] [-enableBackground boolean] [-enableKeyboardFocus boolean] [-execute] [-executeAll] [-exists] [-fileChangedCommand script] [-filename] [-filterKeyPress script] [-fullPathName] [-hasFocus] [-hasSelection] [-height int] [-highlightColor float float float] [-insertText string] [-isObscured] [-load] [-loadContents string] [-loadFile string] [-manage boolean] [-modificationChangedCommand script] [-modified] [-noBackground boolean] [-numberOfLines uint] [-numberOfPopupMenus] [-objectPathCompletion boolean] [-parent string] [-pasteSelection] [-popupMenuArray] [-preventOverride boolean] [-redo] [-removeStoredContents string] [-replaceAll string string] [-saveFile string] [-saveSelection string] [-saveSelectionToShelf] [-searchAndSelect] [-searchDown boolean] [-searchMatchCase boolean] [-searchString string] [-searchWraps boolean] [-select uint uint] [-selectAll] [-selectedText] [-showLineNumbers boolean] [-showTooltipHelp boolean] [-source] [-sourceType string] [-spacesPerTab uint] [-statusBarMessage string] [-storeContents string] [-tabsForIndent boolean] [-text string] [-textLength] [-undo] [-useTemplate string] [-visible boolean] [-visibleChangeCommand script] [-width int]

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

Maya に対してスクリプト コマンドを発行するために使用するスクリプト エディタ エクゼキュータ コントロールです。

戻り値

stringエクゼキュータ コントロールの名前

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

フラグ

annotation, appendText, autoCloseBraces, backgroundColor, clear, commandCompletion, copySelection, currentLine, cutSelection, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, enableKeyboardFocus, execute, executeAll, exists, fileChangedCommand, filename, filterKeyPress, fullPathName, hasFocus, hasSelection, height, highlightColor, insertText, isObscured, load, loadContents, loadFile, manage, modificationChangedCommand, modified, noBackground, numberOfLines, numberOfPopupMenus, objectPathCompletion, parent, pasteSelection, popupMenuArray, preventOverride, redo, removeStoredContents, replaceAll, saveFile, saveSelection, saveSelectionToShelf, searchAndSelect, searchDown, searchMatchCase, searchString, searchWraps, select, selectAll, selectedText, showLineNumbers, showTooltipHelp, source, sourceType, spacesPerTab, statusBarMessage, storeContents, tabsForIndent, text, textLength, undo, useTemplate, visible, visibleChangeCommand, width
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
-annotation(-ann) string createqueryedit
コントロールに文字列値で注釈を付けます。
-appendText(-at) string createedit
このフィールドの最後にテキストをアペンドします。
-autoCloseBraces(-acb) boolean createqueryedit
開き括弧の入力後、自動的に閉じ括弧を追加するか指定します。(既定 = オン)。
-backgroundColor(-bgc) float float float createqueryedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。
backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
-clear(-clr) createedit
フィールドをクリアします。
-commandCompletion(-cco) boolean createqueryedit
コマンド完了を有効化/無効化します。
-copySelection(-cp) createedit
このフィールドから現在の選択項目をコピーします。
-currentLine(-cl) uint createqueryedit
カーソルがある現在行を設定/返します。
-cutSelection(-ct) createedit
このフィールドから現在の選択項目をカットします。
-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]キーを押してコントロールに移動し、キーボードで値を選択することができます。有効でない場合は、マウスのみを使用できます。このフラグは通常、編集コントロールやリスト コントロールなどで既定で使用されるコントロールから、キーボード フォーカスのサポートをオフにするために使用されます。
-execute(-exc) createedit
現在の選択項目を実行します。項目が選択されていない場合、すべてのテキストを実行します。
-executeAll(-exa) createedit
すべてのテキストを実行します。
-exists(-ex) create
指定したオブジェクトが存在するかどうかを返します。他のフラグは無視されます。
-fileChangedCommand(-fcc) script createedit
このフィールドにファイルが含まれている場合にのみ有効です。ファイルが外部で修正、名前変更、またはディスクから削除されたときにいつでも呼び出されるスクリプト ファイルを設定します。MEL では、この関数には次のシグネチャが必要です:
proc fileChanged(string $file)
-filename(-fn) query
ロードまたは保存されたスクリプトのフル パス + ファイル名を返します。存在しない場合は、空の文字列を返します。
-filterKeyPress(-fkp) script createqueryedit
キーを押したときのイベントを処理するために呼び出すスクリプトを設定します。この関数には以下のシグニチャが必要です。
proc int filterKeyPress(int $modifiers, string $key)

モディファイア:ビット マスクは Shift がビット 1、Ctrl がビット 3、Alt がビット 4、Windows キーボードでは「Windows」キー、Mac キーボードではコマンド キーがビット 5 です。
キー:押下するキーを指定します。キーは単一の ASCII 文字または特殊なキーボード文字のキーワード文字列の 1 つです。例: Up、Down、Right、Left、Home、End、age_Up、Page_Down、Insert Return、Space F1 ～ F12 です。
この関数は、キー イベントが処理されたことを示す 1、または処理されなかったことを示す 0 を返します。

-fullPathName(-fpn) query
すべての親を含むウィジェットのフル パス名を返します。
-hasFocus(-hf) query
現在このコントロールにフォーカスがあるかどうかです。
-hasSelection(-hsl) query
現在、このコントロールに選択項目があるかどうかです。
-height(-h) int createqueryedit
コントロールの高さです。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
-highlightColor(-hlc) float float float createqueryedit
コントロールのハイライト カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0～1.0 です。
-insertText(-it) string createedit
指定したテキストをカーソルの位置に挿入し、現在選択されているテキストと置き換えます。選択範囲とカーソル位置は、select フラグを使用して設定できます。このフィールドの最後にテキストをアペンドします。
-isObscured(-io) query
コントロールが実際に表示されるかどうかを返します。コントロールは、次の場合に隠れた状態になります。非表示の場合、別のコントロールで(完全に、または部分的に)ブロックされた場合、コントロールまたは親のレイアウトを制御できない場合、あるいはコントロールのウィンドウが非表示またはアイコン化されている場合。
-load(-ld) createedit
このフィールドにロードするスクリプトを要求するプロンプトが表示されます。 ロードされたファイル名はこのエクゼキュータ フィールドに関連付けられ、保存によって直接ファイルに保存されます。
-loadContents(-ldc) string createedit
指定したファイル名のファイルの内容をこのフィールドにロードします。このファイル名のパスと拡張子は、内部で指定されます。このコマンドは、このエクゼキュータ フィールドのこれまでのインスタンスに今回の内容をロードすることのみを目的とします。
-loadFile(-ldf) string createedit
入力された文字列が完全に指定されたファイル パスである場合、ファイルの内容をこのフィールドにロードしようとします。文字列が空または有効ではない場合、このフィールドにロードするスクリプトを要求するプロンプトが表示されます。どちらの場合でも、ファイル名はこのエクゼキュータ フィールドに関連付けられ、保存によって直接ファイルに保存されます。
-manage(-m) boolean createqueryedit
コントロールの状態を管理します。管理されていないコントロールは表示されず、画面の領域も占有しません。既定では、コントロールは管理できるように作成されます。
-modificationChangedCommand(-mcc) script createedit
修正状態に影響を与える方法でこのフィールドの内容が変更されたときにいつでも呼び出されるスクリプトを設定します。MEL では、この関数には次のシグネチャが必要です:
proc modificationChanged(int $m)

$m が true である場合、このフィールドは変更されています。そうでない場合は false になります。

-modified(-mod) queryedit
フィールドが変更されたかどうかを設定または返します。
-noBackground(-nbg) boolean createedit
コントロールのバックグラウンドをクリア/リセットします。バックグラウンドは、true を渡すと一切描画されず、false を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
-numberOfLines(-nl) uint query
文書の総行数を返します。
-numberOfPopupMenus(-npm) query
このコントロールにアタッチされるポップアップ メニューの数を返します。
-objectPathCompletion(-opc) boolean createqueryedit
パス完了を有効化/無効化します。
-parent(-p) string createquery
コントロールの親のレイアウトです。
-pasteSelection(-pst) createedit
現在のキャレット位置で、このフィールドにテキストをペーストします。
-popupMenuArray(-pma) query
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
-preventOverride(-po) boolean createqueryedit
true の場合、コントロールの右マウス ボタン メニューを使用したコントロール アトリビュートのオーバーライドは無効になります。
-redo(-rd) createedit
最後の操作をやり直します。
-removeStoredContents(-rsc) string createedit
指定したファイル名で格納されているこのフィールドの内容を除去します。ファイルのパスと拡張子は、内部で指定されます。このコマンドは、このエクゼキュータ フィールドにこれまで格納された内容を除去することのみを目的とします。
-replaceAll(-rpa) string string createedit
フィールド テキスト内の最初の文字列のすべてのインスタンスを 2 番目の文字列に置き換えます。この操作で大文字小文字を区別するかどうかは 
-searchMatchCase
フラグで設定します。
-saveFile(-svf) string createedit
このフィールドのスクリプトの内容全体を指定したファイル パスに直接保存します。
-saveSelection(-sv) string createedit
現在の選択項目をファイルに保存することを求めるプロンプトを表示します。指定した文字列の前に既定のファイル名プロンプトが追加されます。
-saveSelectionToShelf(-svs) createedit
現在の選択項目をシェルフの項目に保存することを求めるプロンプトを表示します。
-searchAndSelect(-sas) query
指定した検索オプションを使用して指定した検索文字列を検索(と選択)します。
-searchDown(-sd) boolean createqueryedit
カーソルの上下どちらを検索するかを指定します。
-searchMatchCase(-smc) boolean createqueryedit
検索で大文字/小文字を区別するかどうかを指定します。
-searchString(-ss) string createqueryedit
検索する文字列を指定します。
-searchWraps(-sw) boolean createqueryedit
検索の先頭に戻るかどうかを指定します。
-select(-sl) uint uint createedit
指定範囲内のテキストを選択します。
-selectAll(-sla) createedit
すべてのテキストを選択します。
-selectedText(-slt) query
現在の選択範囲内のテキストです。
-showLineNumbers(-sln) boolean createqueryedit
行番号カラムを表示/非表示にします。
-showTooltipHelp(-sth) boolean createqueryedit
コマンド実行ウィンドウのツール ヒントを有効化/無効化します。
-source(-src) createedit
ソース スクリプトを要求するプロンプトが表示されます(ロードせずに実行)。
-sourceType(-st) string createquery
このコマンド エクゼキュータ フィールドのソース タイプを設定します。有効な値は「mel」(既定で有効)と「python」です。
-spacesPerTab(-spt) uint createqueryedit
1 つのタブ位置に相当するスペースの数を指定します(既定＝4)。
-statusBarMessage(-sbm) string createedit
マウスがコントロール上にある場合にステータス バーに表示する追加の文字列です。
-storeContents(-stc) string createedit
ファイル パスの完全な文字列が指定された場合は、このフィールドの内容がそのパスに格納されます。不完全なパス名の場合は、提供された文字列はファイル名のみに使用され、-loadContents および -removeStoredContents フラグの場合と同じように、内部で生成されたファイルのパスと拡張子が使用されます。いずれにしても、指定した名前が既に存在する場合は、固有のファイル名が新たに生成されます。完了時には、保存したファイルのファイル名を返します。完了しなかった場合は、空の文字列を返します。
-tabsForIndent(-tfi) boolean createqueryedit
インデントの際にタブ記号を表示するかどうかを指定します(既定 = オン)。
-text(-t) string createqueryedit
フィールド テキストを指定した文字列に置き換えます。
-textLength(-tl) query
このテキスト フィールドの文字数です。
-undo(-ud) createedit
最後の操作を元に戻します。
-useTemplate(-ut) string create
コマンドに、現在のものとは異なるコマンド テンプレートを使用するように強制します。
-visible(-vis) boolean createqueryedit
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
-visibleChangeCommand(-vcc) script createqueryedit
コントロールの可視の状態が変更されたときに実行されるコマンドです。
-width(-w) int createqueryedit
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。
フラグはコマンドの作成モードで表示できます フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます コマンド内でフラグを複数回使用できます。

MEL 例

// this will create a tiny window with a Mel command executer.
window;
    columnLayout;
        cmdScrollFieldExecuter -width 200 -height 100;
showWindow;
// this will create a tiny window with a Python command executer.
window;
    columnLayout;
        cmdScrollFieldExecuter -width 200 -height 100 -sourceType python;
showWindow;