optionVar

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

概要

optionVar([arraySize=string], [category=string], [clearArray=string], [clearStash=string], [default=boolean], [exists=string], [floatArray=string], [floatValue=[string, float]], [floatValue2=[string, float, float]], [floatValue3=[string, float, float, float]], [floatValue4=[string, float, float, float, float]], [floatValueAppend=[string, float]], [init=boolean], [intArray=string], [intValue=[string, int]], [intValue2=[string, int, int]], [intValue3=[string, int, int, int]], [intValue4=[string, int, int, int, int]], [intValueAppend=[string, int]], [list=boolean], [listCategories=boolean], [listModified=boolean], [prefFile=string], [remove=string], [removeFromArray=[string, int]], [stash=string], [stringArray=string], [stringValue=[string, string]], [stringValueAppend=[string, string]], [transient=boolean], [unstash=string], [version=int])

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

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

戻り値

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

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
arraySize(arraySize)	string
「string」という配列のサイズを返します。そのような変数がない場合は、0 を返します。変数が配列でない場合は、1 を返します。
category(cat)	string
指定した変数のカテゴリを設定します。このフラグを list/listModified フラグと組み合わせて、指定したカテゴリのすべての変数を取得することもできます。
clearArray(ca)	string
「string」という配列がある場合、空に設定されます。空の配列は保存されません。
clearStash(cs)	string
変数のバックアップ コピーをクリアします。
default(d)	boolean
変数の現在値および既定値は、指定した値に設定されます。このフラグを照会フラグと組み合わせて既定値を取得したり、exists フラグと組み合わせて既定値が指定されているかどうかを判断したりすることもできます。また、list/listModifed フラグと一緒に使用して、既定値を持つ変数をリストすることもできます。
exists(ex)	string
「string」という変数が存在する場合は 1 を、なければ 0 を返します。default/transient フラグを使用して、既定値を持つ変数または一時的な変数をリストすることができます。これを使用する場合、その他のフラグはすべて無視されます(照会の方が優先度が高い)。
floatArray(fa)	string
「string」という名前の新しい空の float 配列変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
floatValue(fv)	[string, float]
float 値「float」の「string」という新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
floatValue2(fv2)	[string, float, float]
2 要素の float 配列を使用して、「string」という名前の新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
floatValue3(fv3)	[string, float, float, float]
3 要素の float 配列を使用して、「string」という名前の新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
floatValue4(fv4)	[string, float, float, float, float]
4 要素の float 配列を使用して、「string」という名前の新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
floatValueAppend(fva)	[string, float]
「string」という浮動小数点数配列の末尾に、この値を追加します。このような配列がない場合は作成されます。この名前の浮動小数点数がすでに存在している場合は、配列の最初の要素になります。その他のタイプの値が存在する場合、すべて上書きされます。
init(ini)	boolean
変数を初期化またはリセットするために使用されます。フラグが true に設定されているか、変数が存在しない場合、変数の現在の値および既定値は指定した値に設定されます。フラグが false に設定されている場合、既定値のみが設定され、現在の値は変更されません。
intArray(ia)	string
「string」という名前の新しい空の int 配列変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
intValue(iv)	[string, int]
整数値「int」の「string」という新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
intValue2(iv2)	[string, int, int]
2 要素の int 配列を使用して、「string」という名前の新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
intValue3(iv3)	[string, int, int, int]
3 要素の int 配列を使用して、「string」という名前の新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
intValue4(iv4)	[string, int, int, int, int]
4 要素の int 配列を使用して、「string」という名前の新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
intValueAppend(iva)	[string, int]
「string」という整数の配列の末尾に、この値を追加します。このような配列がない場合は作成されます。この名前の整数値がすでに存在している場合は、配列の最初の要素になります。その他のタイプの値が存在する場合、すべて上書きされます。
list(l)	boolean
これは、定義された変数名すべての一覧を返します。category フラグを使用して指定したカテゴリの変数をリストでき、default/transient フラグを使用して、既定値を持つ変数または一時的な変数をリストすることができます。これを使用する場合、その他のフラグはすべて無視されます(照会および exists フラグの方が優先度が高い)。
listCategories(lc)	boolean
これは、定義された変数カテゴリすべての一覧を返します。これを使用する場合、その他のフラグはすべて無視されます(照会および exists フラグの方が優先度が高い)。
listModified(lm)	boolean
既定値から変更されたすべての変数のリストを返します。既定値を持つ変数にリストをフィルタするために default フラグを使用しない限り、既定値を持たない変数も返されます。category フラグを使用して、カテゴリ別にリストをフィルタすることもできます。これを使用する場合、その他のフラグはすべて無視されます(照会および exists フラグの方が優先度が高い)。
prefFile(pf)	string
フラグはカテゴリと一緒に使用する必要があります。基本設定を保存するときに、指定したカテゴリの optionVars を保存する必要がある場所を指定します。
remove(rm)	string
あれば、「string」という変数を除去します。 注: 同一のコマンドで -r およびその他の(-sv、-iv、-fv)フラグが使用されている場合、値を設定する前にすべての除去が行われます。
removeFromArray(rfa)	[string, int]
「string」という配列の番号付きの要素「int」を除去します。それ以降はすべてシャッフルされます。
stash(st)	string
変数のバックアップ コピーを作成します。
stringArray(sa)	string
「string」という名前の新しい空の string 配列変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
stringValue(sv)	[string, string]
1 番目の文字列を 2 番目の文字列で指定した値で使用した名前の新しい変数を作成します。この名前の変数がすでに存在する場合は、新しい値で上書きされます(タイプに関係なく)。
stringValueAppend(sva)	[string, string]
1 番目の文字列の名前の文字配列の末尾に、2 番目の文字列で指定した値を追加します。このような配列がない場合は作成されます。この名前の文字列値がすでに存在している場合は、配列の最初の要素になります。その他のタイプの値が存在する場合、すべて上書きされます。
transient(t)	boolean
指定した変数がセッション間で保持されないことを示します。このフラグを -exists と組み合わせて、変数が一時的かどうかを判断することもできます。
unstash(us)	string
バックアップコピーから変数を復元します。
version(v)	int
互換性のないプリファレンス ファイルに関する警告を表示する、プリファレンス バージョン番号

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

Python 例

import maya.cmds as cmds

cmds.optionVar( iv=('defaultTriangles', 4), sv=('defaultFileName', 'buffalo.maya') )
cmds.optionVar( exists='defaultTriangles' )
# Result: 1 #
cmds.optionVar( q='defaultFileName' )
# Result: buffalo.maya #
cmds.optionVar( list=True )
cmds.optionVar( remove='defaultTriangles' )
cmds.optionVar( exists='defaultTriangles' )
# Result: 0 #