Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

artSetPaintCtx([accopacity=boolean], [afterStrokeCmd=string], [beforeStrokeCmd=string], [brushalignment=boolean], [brushfeedback=boolean], [clear=boolean], [dragSlider=string], [dynclonemode=boolean], [exists=boolean], [expandfilename=boolean], [exportaspectratio=float], [exportfilemode=string], [exportfilesave=string], [exportfilesizex=int], [exportfilesizey=int], [exportfiletype=string], [history=boolean], [image1=string], [image2=string], [image3=string], [importfileload=string], [importfilemode=string], [importreassign=boolean], [lastRecorderCmd=string], [lastStampName=string], [lowerradius=float], [makeStroke=uint], [mappressure=string], [name=string], [objectsetnames=string], [opacity=float], [outline=boolean], [outwhilepaint=boolean], [paintmode=string], [paintoperationtype=string], [pickColor=boolean], [pickValue=boolean], [playbackCursor=[float, float]], [playbackPressure=float], [preserveclonesource=boolean], [profileShapeFile=string], [projective=boolean], [radius=float], [record=boolean], [reflection=boolean], [reflectionaboutorigin=boolean], [reflectionaxis=string], [screenRadius=float], [selectclonesource=boolean], [setcolorfeedback=boolean], [setdisplaycvs=boolean], [setopertype=string], [settomodify=string], [showactive=boolean], [stampDepth=float], [stampProfile=string], [stampSpacing=float], [strokesmooth=string], [surfaceConformedBrushVertices=boolean], [tablet=boolean], [tangentOutline=boolean], [usepressure=boolean], [worldRadius=float])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

artSetPaintCtx is undoable, queryable, and editable.

This tool allows the user to modify the set membership (add, transfer, remove cvs) on nurbs surfaces using Maya Artisan's interface.

Return value

None

In query mode, return type is based on queried flag.

Flags

accopacity, afterStrokeCmd, beforeStrokeCmd, brushalignment, brushfeedback, clear, dragSlider, dynclonemode, exists, expandfilename, exportaspectratio, exportfilemode, exportfilesave, exportfilesizex, exportfilesizey, exportfiletype, history, image1, image2, image3, importfileload, importfilemode, importreassign, lastRecorderCmd, lastStampName, lowerradius, makeStroke, mappressure, name, objectsetnames, opacity, outline, outwhilepaint, paintmode, paintoperationtype, pickColor, pickValue, playbackCursor, playbackPressure, preserveclonesource, profileShapeFile, projective, radius, record, reflection, reflectionaboutorigin, reflectionaxis, screenRadius, selectclonesource, setcolorfeedback, setdisplaycvs, setopertype, settomodify, showactive, stampDepth, stampProfile, stampSpacing, strokesmooth, surfaceConformedBrushVertices, tablet, tangentOutline, usepressure, worldRadius
Long name (short name) Argument types Properties
accopacity(aco) boolean createqueryedit
Sets opacity accumulation on/off. C: Default is false (Except for sculpt tool for which it is true by default). Q: When queried, it returns a boolean.
afterStrokeCmd(asc) string createqueryedit
The passed string is executed as a MEL command immediately after the end of a stroke. C: Default is no command. Q: When queried, it returns the current command
beforeStrokeCmd(bsc) string createqueryedit
The passed string is executed as a MEL command immediately before the start of a stroke. C: Default is no command. Q: When queried, it returns the current command
brushalignment(bra) boolean createqueryedit
Specifies the path brush alignemnt. If true, the brush will align to stroke path, otherwise it will align to up vector. C: Default is true. Q: When queried, it returns a boolean.
brushfeedback(brf) boolean createqueryedit
Specifies if the brush additional feedback should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
clear(clr) boolean createedit
Floods all cvs/vertices to the current value.
dragSlider(dsl) string createedit
Sets the current brush drag state for resizing or offsetting the brush (like the 'b' and 'm' default hotkeys). The string argument is one of: "radius", "lowradius", "opacity", "value", "depth", "displacement", "uvvector" or "none". C: Default is "none".
dynclonemode(dcm) boolean createqueryedit
Enable or disable dynamic clone mode.
exists(ex) boolean create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
expandfilename(eef) boolean createedit
If true, it will expand the name of the export file and concatenate it with the surface name. Otherwise it will take the name as it is. C: Default is true.
exportaspectratio(ear) float createqueryedit
Value of aspect ratio for export
exportfilemode(efm) string createqueryedit
Specifies the export channel.The valid entries here are: "alpha", "luminance", "rgb", "rgba". C: Default is "luminance/rgb". Q: When queried, it returns a string.
exportfilesave(esf) string edit
Exports the attribute map and saves to a specified file.
exportfilesizex(fsx) int createqueryedit
Specifies the width of the attribute map to export. C: Default width is 256. Q: When queried, it returns an integer.
exportfilesizey(fsy) int createqueryedit
Specifies the width of the attribute map to export. C: Default width is 256. Q: When queried, it returns an integer.
exportfiletype(eft) string createqueryedit
Specifies the image file format. It can be one of the following: "iff", "tiff", "jpeg", "alias", "rgb", "fit" "postScriptEPS", "softimage", "wavefrontRLA", "wavefrontEXP". C: default is tiff. Q: When queried, it returns a string.
history(ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
image1(i1) string createqueryedit
First of three possible icons representing the tool associated with the context.
image2(i2) string createqueryedit
Second of three possible icons representing the tool associated with the context.
image3(i3) string createqueryedit
Third of three possible icons representing the tool associated with the context.
importfileload(ifl) string edit
Load the attribute map a specified file.
importfilemode(ifm) string createqueryedit
Specifies the channel to import. The valid entries here are: "alpha", "luminance", "red", "green", "blue", and "rgb" C: Default is "alpha". Q: When queried, it returns a string.
importreassign(irm) boolean createqueryedit
Specifies if the multiply atrribute maps are to be reassigned while importing. Only maps previously exported from within Artisan can be reassigned. C: Default is FALSE. Q: When queried, it returns a boolean.
lastRecorderCmd(lrc) string createqueryedit
Value of last recorded command.
lastStampName(lsn) string createqueryedit
Value of the last stamp name.
lowerradius(lr) float createqueryedit
Sets the lower size of the brush (only apply on tablet).
makeStroke(mst) uint createqueryeditmultiuse
Stroke point values.
mappressure(mp) string createqueryedit
Sets the tablet pressure mapping when the table is used. There are three options: "Opacity" - the pressure is mapped to the opacity, "Radius" - the is mapped to modify the radius of the brush, "Both" - the pressure modifies both the opacity and the radius. C: Default is "Opacity". Q: When queried, it returns a string.
name(n) string create
If this is a tool command, name the tool appropriately.
objectsetnames(osn) string createqueryedit
Default name of object sets
opacity(op) float createqueryedit
Sets the brush opacity. C: Default is 1.0. Q: When queried, it returns a float.
outline(o) boolean createqueryedit
Specifies if the brush should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
outwhilepaint(owp) boolean createqueryedit
Specifies if the brush outline should be drawn while painting. C: Default is FALSE. Q: When queried, it returns a boolean.
paintmode(pm) string createqueryedit
Specifies the paint mode. There are two possibilities: "screen" and "tangent". C: Default is "screen". Q: When queried, it returns a string.
paintoperationtype(pot) string createqueryedit
Specifies the operation type used by the Paint Tool. Currently, we support the following paint modes: "Paint", "Smear", "Blur", "Erase" and "Clone". Default is "Paint".
pickColor(pcm) boolean createqueryedit
Set pick color mode on or off
pickValue(pv) boolean createqueryedit
Toggle for picking
playbackCursor(plc) [float, float] createqueryeditmultiuse
Values for the playback cursor.
playbackPressure(plp) float createqueryeditmultiuse
Valus for the playback pressure.
preserveclonesource(pcs) boolean createqueryedit
Whether or not to preserve a clone source.
profileShapeFile(psf) string queryedit
Passes a name of the image file for the stamp shape profile.
projective(prm) boolean createqueryedit
Specifies the projective paint mode. C: Default is 'false'. Q: When queried, it returns a boolean.
radius(r) float createqueryedit
Sets the size of the brush. C: Default is 1.0 cm. Q: When queried, it returns a float.
record(rec) boolean createqueryedit
Toggle on for recording.
reflection(rn) boolean createqueryedit
Specifies the reflection mode. C: Default is 'false'. Q: When queried, it returns a boolean.
reflectionaboutorigin(rno) boolean createqueryedit
Toggle on to reflect about the origin
reflectionaxis(ra) string createqueryedit
Specifies the reflection axis. There are three possibilities: "x", "y" and "z". C: Default is "x". Q: When queried, it returns a string.
screenRadius(scR) float createqueryedit
Brush radius on the screen
selectclonesource(scs) boolean createqueryedit
Toggle on to select the clone source
setcolorfeedback(scf) boolean createqueryedit
Specifies if the color feedback is on or off. C: Default is ON. Q: When queried, it returns a boolean.
setdisplaycvs(dcv) boolean createqueryedit
Specifies if the active cvs are displayed. C: Default is ON. Q: When queried, it returns a boolean.
setopertype(sot) string createqueryedit
Specifies the setEdit operation ("add", "transfer", "remove"). C: Default is "add". Q: When queried, it returns a string.
settomodify(stm) string createqueryedit
Specifies the name of the set to modify. Q: When queried, it returns a string.
showactive(sa) boolean createqueryedit
Sets on/off the display of the surface isoparms. C: Default is TRUE. Q: When queried, it returns a boolean.
stampDepth(stD) float createqueryedit
Depth of the stamps
stampProfile(stP) string createqueryedit
Sets the brush profile of the current stamp. Currently, the following profiles are supported: "gaussian", "poly", "solid" and "square". C: Default is gaussian. Q: When queried, it returns a string.
stampSpacing(stS) float createqueryedit
Specifies the stamp spacing. Default is 1.0.
strokesmooth(ssm) string createqueryedit
Stroke smoothing type name
surfaceConformedBrushVertices(scv) boolean createqueryedit
Enables/disables the the display of the effective brush area as affected vertices.
tablet(tab) boolean query
Returns true if the tablet device is present, false if it is absent
tangentOutline(to) boolean createqueryedit
Enables/disables the display of the brush circle tangent to the surface.
usepressure(up) boolean createqueryedit
Sets the tablet pressure on/off. C: Default is false. Q: When queried, it returns a boolean.
worldRadius(wlR) float createqueryedit
Radius in worldspace
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Create a new set membership paint context, then switch to it
cmds.artSetPaintCtx('artSetPaintCtx1')
cmds.setToolTo('artSetPaintCtx1')

# Set brush's radius to 2.0, lower radius to 0.5
cmds.artSetPaintCtx('artSetPaintCtx1', edit=True, r=2.0, lr=0.5)