artUserPaintCtx

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

概要

artUserPaintCtx([accopacity=boolean], [activeListChangedProc=string], [afterStrokeCmd=string], [alphaclamp=string], [alphaclamplower=float], [alphaclampupper=float], [attrSelected=string], [beforeStrokeCmd=string], [brushalignment=boolean], [brushfeedback=boolean], [clamp=string], [clamplower=float], [clampupper=float], [clear=boolean], [colorRamp=string], [colorfeedback=boolean], [colorrangelower=float], [colorrangeupper=float], [dataTypeIndex=int], [disablelighting=boolean], [dragSlider=string], [duringStrokeCmd=string], [exists=boolean], [expandfilename=boolean], [exportfilemode=string], [exportfilesave=string], [exportfilesizex=int], [exportfilesizey=int], [exportfiletype=string], [filterNodes=boolean], [finalizeCmd=string], [fullpaths=boolean], [getArrayAttrCommand=string], [getSurfaceCommand=string], [getValueCommand=string], [history=boolean], [image1=string], [image2=string], [image3=string], [importfileload=string], [importfilemode=string], [importreassign=boolean], [initializeCmd=string], [interactiveUpdate=boolean], [lowerradius=float], [mappressure=string], [maxvalue=float], [minvalue=float], [name=string], [objattrArray=string], [opacity=float], [outline=boolean], [outwhilepaint=boolean], [paintNodeArray=string], [paintattrselected=string], [paintmode=string], [profileShapeFile=string], [projective=boolean], [radius=float], [rampMaxColor=[float, float, float]], [rampMinColor=[float, float, float]], [reflection=boolean], [reflectionaxis=string], [selectedattroper=string], [setValueCommand=string], [showactive=boolean], [stampProfile=string], [surfaceConformedBrushVertices=boolean], [tablet=boolean], [tangentOutline=boolean], [toolCleanupCmd=string], [toolOffProc=string], [toolOnProc=string], [toolSetupCmd=string], [useColorRamp=boolean], [useMaxMinColor=boolean], [usepressure=boolean], [value=float], [whichTool=string])

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

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

戻り値

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

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
exists(ex)	boolean
指定したオブジェクトが存在するかどうかによって、true または false を返します。他のフラグは無視されます。
image1(i1)	string
image2(i2)	string
image3(i3)	string
コンテキストは、コンテキストに関連付けられている ツールを表すアイコンを 3 つまでサポートします。
history(ch)	boolean
ツール コマンドの場合、対象となるツールの コンストラクション ヒストリをオンにします。
name(n)	string
これがツール コマンドの場合、ツールに適切に名前を付けます。
dragSlider(dsl)	string
(既定のホットキーの 'b' と 'm' のように)ブラシをサイズ変更したりオフセットしたりするため、現在のブラシのドラッグ状態を設定します。文字列引数は次のいずれかです。「radius」、「lowradius」、「opacity」、「value」、「depth」、「displacement」、「uvvector」、または「none」。C: 既定は「none」です。
opacity(op)	float
ブラシの不透明度を設定します。C: 既定は 1.0 です。Q: 照会すると float を返します。
accopacity(aco)	boolean
不透明度の塗り重ねをオンまたはオフに設定します。C: 既定は false です(既定が true のスカルプト ツールを除く)。Q: 照会すると boolean を返します。
radius(r)	float
ブラシのサイズを設定します。C: 既定は 1.0 cm です。Q: 照会すると float を返します。
lowerradius(lr)	float
ブラシの下限サイズを設定します(タブレットにのみ適用されます)。
stampProfile(stP)	string
現在のスタンプのブラシ プロファイルを設定します。 現在、次のプロファイルがサポートされています。「gaussian」、「soft」、「solid」または「square」。C: 既定は「gaussian」です。Q: 照会すると string を返します。
profileShapeFile(psf)	string
スタンプ シェイプのプロファイルにイメージ ファイルの名前を渡します。
brushalignment(bra)	boolean
パス ブラシの位置合わせを指定します。true の場合はストローク パスに位置合わせ、false の場合はアップ ベクトルに位置合わせます。C: 既定は true です。Q: 照会すると boolean を返します。
clear(clr)	boolean
CV/頂点のすべてを現在値に塗り潰します。
usepressure(up)	boolean
タブレット圧力をオンまたはオフに設定します。C: 既定は false です。Q: 照会すると boolean を返します。
mappressure(mp)	string
タブレットを使用するときのタブレット圧力のマッピングを設定します。次の 4 つの選択肢があります: 「none」- 圧力に影響がない、「opacity」- 圧力が不透明度にマップされる、「radius」- 圧力がブラシ半径を修正するようマップされる、「both」- 圧力が不透明度と半径の両方を修正する。C: 既定は「none」です。Q: 照会すると string を返します。
outline(o)	boolean
ブラシを描画するかどうかを指定します。C: 既定は true です。Q: 照会すると boolean を返します。
outwhilepaint(owp)	boolean
ペイント時にブラシの輪郭を描画するかどうかを指定します。C: 既定は false です。Q: 照会すると boolean を返します。
brushfeedback(brf)	boolean
ブラシの追加のフィードバックを描画するかどうかを指定します。C: 既定は true です。Q: 照会すると boolean を返します。
showactive(sa)	boolean
サーフェス アイソパラムの表示をオンまたはオフに設定します。C: 既定は true です。Q: 照会すると boolean を返します。
paintmode(pm)	string
ペイント モードを指定します。次の 2 つの選択肢があります: 「screen」または「tangent」。C: 既定は「screen」です。Q: 照会すると string を返します。
projective(prm)	boolean
投影ペイント モードを指定します。C: 既定は false です。Q: 照会すると boolean を返します。
reflection(rn)	boolean
反射モードを指定します。C: 既定は false です。Q: 照会すると boolean を返します。
reflectionaxis(ra)	string
反射軸を指定します。次の 3 つの選択肢があります: 「x」、「y」、「z」。C: 既定は「x」です。Q: 照会すると string を返します。
importfileload(ifl)	string
指定したファイルのアトリビュート マップをロードします。
importreassign(irm)	boolean
読み込む時に複数のアトリビュート マップを再割り当てするかどうかを指定します。再割り当てできるマップは、以前にアーティザン(Artisan)から書き出されたマップだけです。C: 既定は false です。Q: 照会すると boolean を返します。
importfilemode(ifm)	string
読み込むチャネルを指定します。有効なエントリは以下のとおりです: 「alpha」、「luminance」、「red」、「green」、「blue」、「rgb」 C: 既定は「alpha」です。Q: 照会すると string を返します。
expandfilename(eef)	boolean
true の場合、書き出しファイルの名前を拡張し、サーフェス名と連結します。false の場合、名前をそのまま受け取ります。C: 既定は true です。
exportfilesave(esf)	string
アトリビュート マップを書き出し、指定したファイルに保存します。
exportfilemode(efm)	string
書き出しチャネルを指定します。有効なエントリは以下のとおりです: 「alpha」、「luminance」、「rgb」、「rgba」。C: 既定は「luminance/rgb」です。Q: 照会すると string を返します。
exportfilesizex(fsx)	int
書き出すアトリビュート マップの幅を指定します。C:既定幅は 256 です。Q: 照会すると integer を返します。
exportfilesizey(fsy)	int
書き出すアトリビュート マップの幅を指定します。C:既定幅は 256 です。Q: 照会すると integer を返します。
exportfiletype(eft)	string
イメージ ファイル フォーマットを指定します。次のいずれかを指定できます: 「iff」、「tiff」、「jpeg」、「alias」、「rgb」、「fit」、「postScriptEPS」、「softimage」、「wavefrontRLA」、「wavefrontEXP」。C: 既定は「tiff」です。Q: 照会すると string を返します。
tablet(tab)	boolean
タブレット デバイスが存在する場合は true を、存在しない場合は false を返します。
surfaceConformedBrushVertices(scv)	boolean
影響を受ける頂点として、有効なブラシ領域の表示を有効化/無効化します。
tangentOutline(to)	boolean
サーフェスへのブラシ円接線の表示を有効化/無効化します。
selectedattroper(sao)	string
ウェイト編集操作を設定します。次の 4 つのウェイト編集操作があります: 「absolute」の場合、ウェイト値は現在のウェイトで置き換えられます。「additive」の場合、現在のウェイトにウェイト値が足されます。「scale」の場合、ウェイト値に現在のウェイトが掛けられます。「smooth」の場合、ウェイト値は現在のウェイトで割られます。C: 既定は「absolute」です。Q: 照会すると string を返します。
filterNodes(fon)	boolean
ノード フィルタを設定します。
value(val)	float
各アトリビュートの値を指定します。C: 既定は 0.0 です。Q: 照会すると float を返します。
minvalue(miv)	float
各アトリビュートの最小値を指定します。C: 既定は 0.0 です。Q: 照会すると float を返します。
maxvalue(mxv)	float
各アトリビュートの最大値を指定します。C: 既定は 1.0 です。Q: 照会すると float を返します。
useColorRamp(ucr)	boolean
ユーザ定義のカラー ランプを使用して値をカラーにマッピングするかどうかを指定します。これがオフの場合、既定のグレースケール フィードバックを使用します。
colorRamp(cr)	string
ユーザ定義のカラー ランプを使用した、値のカラーへのマッピングを許可します。
useMaxMinColor(umc)	boolean
範囲外のカラーを使用するべきかどうかを指定します。詳細については、rampMinColor、rampMaxColor フラグを参照してください。
rampMinColor(rmc)	[float, float, float]
値が最小値以下の場合に、特別のカラーを使用するように定義します。
rampMaxColor(rxc)	[float, float, float]
値が最大値以上の場合に、特別のカラーを使用するように定義します。
clamp(cl)	string
ウェイト値に上限、下限を設定するかどうかを指定します。次の 4 つの選択肢があります。「none」- クランプをまったく実行しません。「lower」- 下限にのみ合わせてクランプします。「upper」- 上限にのみ合わせてクランプします。「both」- 上限、下限両方に合わせてクランプします。C: 既定は「none」です。Q: 照会すると string を返します。
clamplower(cll)	float
値の下限を指定します。C: 既定は 0.0 です。Q: 照会すると float を返します。
clampupper(clu)	float
値の上限を指定します。C: 既定は 1.0 です。Q: 照会すると float を返します。
alphaclamp(alc)	string
ウェイト値を上限、下限にアルファ クランプするかどうかを指定します。次の 4 つの選択肢があります。「none」- クランプをまったく実行しません。「lower」- 下限にのみ合わせてクランプします。「upper」- 上限にのみ合わせてクランプします。「both」- 上限、下限両方に合わせてクランプします。C: 既定は「none」です。Q: 照会すると string を返します。
alphaclamplower(acl)	float
アルファ値の下限を指定します。C: 既定は 0.0 です。Q: 照会すると float を返します。
alphaclampupper(acu)	float
アルファ値の上限を指定します。C: 既定は 1.0 です。Q: 照会すると float を返します。
dataTypeIndex(dti)	int
選択したペイント可能なアトリビュートが vectorArray のときに、ペイントするフィールドを指定します。
colorfeedback(cf)	boolean
カラー フィードバックの表示をオンまたはオフに設定します。C: 既定は false です。Q: 照会すると boolean を返します。
disablelighting(dl)	boolean
カラー フィードバックがオンの場合、このフラグによって、影響を受けるサーフェスのライティングを無効にするかどうかが決まります。C: 既定は false です。Q: 照会すると boolean を返します。
colorrangelower(crl)	float
カラー フィードバック モードがオンのときに黒にマップする値を指定します。C: 既定は 0.0 です。Q: 照会すると float を返します。
colorrangeupper(cru)	float
カラー フィードバック モードがオンのときに最大カラーにマップする値を指定します。C: 既定は 1.0 です。Q: 照会すると float を返します。
interactiveUpdate(iu)	boolean
ペイントされた値をアトリビュートに転送する頻度を指定します。TRUE: 「継続的」に(1 つのストロークにつき何度も)転送します。FALSE: ストロークの最後(マウス ボタンが放されたとき)にのみ転送します。C: 既定は true です。Q: 照会すると boolean を返します。
paintNodeArray(pna)	string
ペイント可能なノードの配列です。Q: 照会すると string を返します。
objattrArray(oaa)	string
ペイント可能なすべてのアトリビュートの配列です。配列の各要素は、次の情報を含む文字列です。NodeType.NodeName.AttributeName。MenuType *MenuType: メニュー項目(UI)のタイプ(レベル)です。Q: 照会すると string を返します。
attrSelected(asl)	string
現在選択されているアトリビュートの名前を返します。Q: 照会すると string を返します。
paintattrselected(pas)	string
選択したペイント可能なアトリビュートの配列です。配列の各要素は、次の情報を含む文字列です。NodeType.NodeName.AttributeName。
beforeStrokeCmd(bsc)	string
渡された文字列はストロークの開始直前に MEL コマンドとして実行されます。C: 既定は、コマンドなしです。Q: 照会すると現在のコマンドを返します。
duringStrokeCmd(dsk)	string
マウスでドラッグする度に、渡された文字列はストローク時に MEL コマンドとして実行されます。C: 既定は、コマンドなしです。Q: 照会すると現在のコマンドを返します。
afterStrokeCmd(asc)	string
渡された文字列はストロークの終了直前に MEL コマンドとして実行されます。C: 既定は、コマンドなしです。Q: 照会すると現在のコマンドを返します。
whichTool(wst)	string
この文字列は、アーティザン コンテキストで使用されるツールの名前を定義します。たとえば、「artClothPaint」のように指定します。照会モードでは、指定したコンテキストのツール名が返されます。注: MEL の動作方法の理由から、引数を取るフラグを指定するときには、必ず、-query フラグを最後に指定してください。
activeListChangedProc(alp)	string
アクティブ リストが変更されたときに必ず起動される MEL コマンドを含む文字列を取ります。シーンでオブジェクトを選択または選択解除したときに、たとえば、UI を更新する必要があるなど、いくつかの状況が考えられます。照会モードでは、現在登録されている MEL コマンドの名前が返されます。何も定義されていない場合は空の文字列になります。
toolOnProc(top)	string
このツールがオンになったときに必ず起動される MEL プロシージャの名前を表す文字列を取ります。たとえば、クロス ペイント ツールがオンになったとき、クロスは「clothPaintToolOn」を起動します。ツールがアクティブになったときに特別な機能が必要となる場合はこのコールバックを定義します。toolOnProc を実装した場合は toolOffProc も実装したくなるでしょう(-toolOffProc フラグを参照)。照会モードでは、現在登録されている MEL コマンドの名前が返されます。何も定義されていない場合は空の文字列になります。
toolOffProc(tfp)	string
このツールがオフになったときに必ず起動される MEL プロシージャの名前を表す文字列を取ります。たとえば、クロス ペイント ツールがオンになったとき、クロスは「clothPaintToolOff」を起動します。ツールが非アクティブになったときに特別な機能が必要となる場合はこのコールバックを定義します。toolOffProc を実装した場合は toolOnProc も実装したくなるでしょう(-toolOnProc フラグを参照)。照会モードでは、現在登録されている MEL コマンドの名前が返されます。何も定義されていない場合は空の文字列になります。
toolSetupCmd(tsc)	string
選択した各サーフェスで最初のクリックが受け付けられたときに一度ずつコールされる Mel スクリプト/プロシージャの名前を指定します。Q: 照会すると string を返します。
toolCleanupCmd(tcc)	string
このツールを終了するとコールされる MEL スクリプト/プロシージャの名前を指定します。Q: 照会すると string を返します。
initializeCmd(ic)	string
各ストロークの最初にコールされる MEL スクリプト/プロシージャの名前を指定します。Q: 照会すると string を返します。
finalizeCmd(fc)	string
各ストロークの最後にコールされる MEL スクリプト/プロシージャの名前を指定します。Q: 照会すると string を返します。
getValueCommand(gvc)	string
スクリプト可能なペイント ツールによってサーフェス上の値が必要とされるたびにコールされる MEL スクリプト/プロシージャの名前を指定します。Q: 照会すると string を返します。
setValueCommand(svc)	string
サーフェス上の値が変更されるたびにコールされる MEL スクリプト/プロシージャの名前を指定します。Q: 照会すると string を返します。
getSurfaceCommand(gsc)	string
アーティザンがセレクション リストを処理するたびに、セレクション リストのディペンデンシー ノードごとに 1 回ずつコールされる MEL スクリプト/プロシージャの名前を指定します。ペイントするサーフェスの名前が返されます。Q: 照会すると string を返します。
getArrayAttrCommand(gac)	string
ペイントするために選択されているサーフェスごとに 1 回ずつコールされる MEL スクリプト/プロシージャの名前を指定します。このプロシージャでは、一部のディペンデンシー ノードの二重配列アトリビュートを参照する名前のリストとして解釈される文字列が返されます。Q: 照会すると string を返します。
fullpaths(fp)	boolean
スクリプトにサーフェス名を渡すときにフル パス名を使用するかどうかを指定します。false の場合、サーフェス名だけが渡されます。C: 既定は false です。Q: 照会すると boolean を返します。

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

Python 例

import maya.cmds as cmds

# create the context
cmds.artUserPaintCtx('artUserPaintCtx')
# set the init mel script
cmds.artUserPaintCtx( 'artUserPaintCtx', e=True, ic='spherePaint' )