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

概要

formLayout( [string] , [annotation=string], [attachControl=[string, string, int, string]], [attachForm=[string, string, int]], [attachNone=[string, string]], [attachOppositeControl=[string, string, int, string]], [attachOppositeForm=[string, string, int]], [attachPosition=[string, string, int, int]], [backgroundColor=[float, float, float]], [childArray=boolean], [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], [numberOfChildren=boolean], [numberOfDivisions=int], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [statusBarMessage=string], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [width=int])

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

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

このコマンドはフォームのレイアウト コントロールを作成します。フォーム レイアウトでは、その直接の子であるコントロールの絶対的な位置決めと相対的な位置決めができます。

コントロールには、上、左、下と右の 4 つのエッジがあります。子の位置決めには、左右と上下の 2 つの方向しかありません。アタッチ フラグは、アタッチするエッジに名前を付ける引数(2 番目の引数)からアタッチメントの方向を取ります。子のいずれかのエッジまたはすべてのエッジをアタッチすることができます。アタッチするには次の 6 つの方法があります。

エッジの各アタッチメントには、コントロールを視覚的に区別するためのオフセットがある場合があります。

既定の位置決め関係は特にないため、フォームに子を表示させるには、少なくとも各方向に 1 つのエッジがアタッチされていなくてはなりません。

注: フラグ定義では、引数は次の規則に従います。

これらは多目的なフラグなので、1 回のコマンドでアタッチメントをいくつでも作成できます。

注: コントロールの依存関係がループを形成するようなコントロール アタッチメントは作成しないでください。例:

window;
string $form = `formLayout`;
string $btn1 = `button`;
string $btn2 = `button`;
string $btn3 = `button`;
formLayout -edit
-attachControl $btn2 "top" 2 $btn1
-attachControl $btn3 "top" 2 $btn2
-attachControl $btn1 "right" 2 $btn3 $form;
showWindow;

$btn2 は $btn1 に、$btn3 は $btn2 に、$btn1 は $btn3 にアタッチされます。つまり、$btn1 の配置は $btn3 に依存し、$btn3 は $btn2 の配置に、$btn2 は $btn1 の配置に依存します。最後のコントロール アタッチメントは、依存関係にループを形成します。

ランタイム エラーを避けるため、Maya ではこのアタッチメントを無視し、代わりに、スクリプト内に循環コントロール アタッチメントが検出されたことを警告します。

戻り値

stringコントロールのフル ネーム

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

フラグ

annotation, attachControl, attachForm, attachNone, attachOppositeControl, attachOppositeForm, attachPosition, backgroundColor, childArray, defineTemplate, docTag, dragCallback, dropCallback, enable, enableBackground, enableKeyboardFocus, exists, fullPathName, height, highlightColor, isObscured, manage, noBackground, numberOfChildren, numberOfDivisions, numberOfPopupMenus, parent, popupMenuArray, preventOverride, statusBarMessage, useTemplate, visible, visibleChangeCommand, width
ロング ネーム(ショート ネーム) 引数タイプ プロパティ
annotation(ann) string createqueryedit
コントロールに文字列値で注釈を付けます。
attachControl(ac) [string, string, int, string] createeditmultiuse
引数は次のとおりです。コントロール、エッジ、オフセット、コントロール。有効なエッジの値は以下のとおりです:「top」、「bottom」、「left」、または「right」です。別のコントロールにコントロールをアタッチします。
attachForm(af) [string, string, int] createeditmultiuse
引数は次のとおりです。コントロール、エッジ、オフセット。有効なエッジの値は、「top」、「bottom」、「left」、または「right」です。指定したコントロールをフォームにアタッチして、指定した量だけオフセットします。
attachNone(an) [string, string] createeditmultiuse
引数は次のとおりです。コントロール、エッジ。有効なエッジの値は、「top」、「bottom」、「left」、または「right」です。何にもコントロールをアタッチしません。
attachOppositeControl(aoc) [string, string, int, string] createeditmultiuse
引数は次のとおりです。コントロール、エッジ、オフセット、コントロール。有効なエッジの値は以下のとおりです:「top」、「bottom」、「left」、または「right」です。別のコントロールの反対側にコントロールをアタッチします。
attachOppositeForm(aof) [string, string, int] createeditmultiuse
引数は次のとおりです。コントロール、エッジ、オフセット。有効なエッジの値は、「top」、「bottom」、「left」、または「right」です。フォームの反対側にコントロールをアタッチします。
attachPosition(ap) [string, string, int, int] createeditmultiuse
引数は次のとおりです。コントロール、エッジ、オフセット、位置。有効なエッジの値は、「top」、「bottom」、「left」、または「right」です。フォームの位置にコントロールをアタッチします。
backgroundColor(bgc) [float, float, float] createqueryedit
コントロールのバックグラウンド カラーです。引数は、赤、緑、青のカラー成分に対応しています。それぞれの成分の値は、0.0~1.0 です。
backgroundColor を設定する場合、enableBackground を false に指定していない限り、バックグラウンドは自動的に有効になります。
childArray(ca) boolean query
レイアウトの直接の子の名前を文字配列で返します。
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 を渡すと描画されます。このフラグの状態は、このコントロールの子に継承されます。
numberOfChildren(nch) boolean query
レイアウトの直接の子の数を整数で返します。
numberOfDivisions(nd) int createqueryedit
フォームが水平と垂直に分割される数を指定します。0 より大きな数値である必要があります。
numberOfPopupMenus(npm) boolean query
このコントロールにアタッチされるポップアップ メニューの数を返します。
parent(p) string createquery
コントロールの親のレイアウトです。
popupMenuArray(pma) boolean query
このコントロールにアタッチされる全ポップアップ メニューの名前を返します。
preventOverride(po) boolean createqueryedit
true の場合、コントロールの右マウス ボタン メニューを使用したコントロール アトリビュートのオーバーライドは無効になります。
statusBarMessage(sbm) string createedit
マウスがコントロール上にある場合にステータス バーに表示する追加の文字列です。
useTemplate(ut) string create
コマンドに、現在のものとは異なるコマンド テンプレートを使用するように強制します。
visible(vis) boolean createqueryedit
コントロールの可視の状態です。既定では、コントロールは表示されます。コントロールの実際の外見も、その親レイアウトの可視の状態によって異なることに注意してください。
visibleChangeCommand(vcc) script createqueryedit
コントロールの可視の状態が変更されたときに実行されるコマンドです。
width(w) int createqueryedit
コントロールの幅を指定します。コントロールは親のレイアウトの条件によって無効にされない限り、このサイズを保持しようとします。

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

Python 例

import maya.cmds as cmds

window = cmds.window()
form = cmds.formLayout(numberOfDivisions=100)
b1 = cmds.button()
b2 = cmds.button()
column = cmds.columnLayout()
cmds.button()
cmds.button()
cmds.button()

cmds.formLayout( form, edit=True, attachForm=[(b1, 'top', 5), (b1, 'left', 5), (b2, 'left', 5), (b2, 'bottom', 5), (b2, 'right', 5), (column, 'top', 5), (column, 'right', 5) ], attachControl=[(b1, 'bottom', 5, b2), (column, 'bottom', 5, b2)], attachPosition=[(b1, 'right', 5, 75), (column, 'left', 0, 75)], attachNone=(b2, 'top') )

cmds.showWindow( window )