art3dPaintCtx

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

Synopsis

art3dPaintCtx([accopacity=boolean], [alphablendmode=string], [assigntxt=boolean], [brushalignment=boolean], [brushfeedback=boolean], [clear=boolean], [commonattr=string], [dragSlider=string], [exists=boolean], [expandfilename=boolean], [exportfilemode=string], [exportfilesave=string], [exportfilesizex=int], [exportfilesizey=int], [exportfiletype=string], [extendFillColor=boolean], [filetxtaspectratio=float], [filetxtsizex=int], [filetxtsizey=int], [history=boolean], [image1=string], [image2=string], [image3=string], [importfileload=string], [importfilemode=string], [importreassign=boolean], [keepaspectratio=boolean], [lowerradius=float], [mappressure=string], [name=string], [opacity=float], [outline=boolean], [outwhilepaint=boolean], [paintmode=string], [paintoperationtype=string], [painttxtattr=string], [painttxtattrname=string], [pfxScale=float], [pfxWidth=float], [profileShapeFile=string], [projective=boolean], [radius=float], [reflection=boolean], [reflectionaxis=string], [reloadtexfile=boolean], [resizeratio=float], [resizetxt=boolean], [saveTextureOnStroke=boolean], [saveonstroke=boolean], [savetexture=boolean], [shadernames=string], [shapenames=string], [showactive=boolean], [stampProfile=string], [stampSpacing=float], [surfaceConformedBrushVertices= boolean], [tablet=boolean], [tangentOutline=boolean], [usepressure=boolean])

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

art3dPaintCtx is undoable, queryable, and editable.

Return value

None

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

Flags

Long name (short name)	Argument types	Properties
exists(ex)	boolean
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
image1(i1)	string
image2(i2)	string
image3(i3)	string
Contexts support up to three icons that represent the tool associated with the context.
history(ch)	boolean
If this is a tool command, turn the construction history on for the tool in question.
name(n)	string
If this is a tool command, name the tool appropriately.
dragSlider(dsl)	string
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".
opacity(op)	float
Sets the brush opacity. C: Default is 1.0. Q: When queried, it returns a float.
accopacity(aco)	boolean
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.
radius(r)	float
Sets the size of the brush. C: Default is 1.0 cm. Q: When queried, it returns a float.
lowerradius(lr)	float
Sets the lower size of the brush (only apply on tablet).
stampProfile(stP)	string
Sets the brush profile of the current stamp. Currently, the following profiles are supported: "gaussian", "soft", "solid" and "square". C: Default is gaussian. Q: When queried, it returns a string.
profileShapeFile(psf)	string
Passes a name of the image file for the stamp shape profile.
brushalignment(bra)	boolean
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.
clear(clr)	boolean
Floods all cvs/vertices to the current value.
usepressure(up)	boolean
Sets the tablet pressure on/off. C: Default is false. Q: When queried, it returns a boolean.
mappressure(mp)	string
Sets the tablet pressure mapping when the table is used. There are four options: "none" - the pressure has no effect, "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 "none". Q: When queried, it returns a string.
outline(o)	boolean
Specifies if the brush should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
outwhilepaint(owp)	boolean
Specifies if the brush outline should be drawn while painting. C: Default is FALSE. Q: When queried, it returns a boolean.
brushfeedback(brf)	boolean
Specifies if the brush additional feedback should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
showactive(sa)	boolean
Sets on/off the display of the surface isoparms. C: Default is TRUE. Q: When queried, it returns a boolean.
paintmode(pm)	string
Specifies the paint mode. There are two possibilities: "screen" and "tangent". C: Default is "screen". Q: When queried, it returns a string.
projective(prm)	boolean
Specifies the projective paint mode. C: Default is 'false'. Q: When queried, it returns a boolean.
reflection(rn)	boolean
Specifies the reflection mode. C: Default is 'false'. Q: When queried, it returns a boolean.
reflectionaxis(ra)	string
Specifies the reflection axis. There are three possibilities: "x", "y" and "z". C: Default is "x". Q: When queried, it returns a string.
importfileload(ifl)	string
Load the attribute map a specified file.
importreassign(irm)	boolean
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.
importfilemode(ifm)	string
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.
expandfilename(eef)	boolean
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.
exportfilesave(esf)	string
Exports the attribute map and saves to a specified file.
exportfilemode(efm)	string
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.
exportfilesizex(fsx)	int
Specifies the width of the attribute map to export. C: Default width is 256. Q: When queried, it returns an integer.
exportfilesizey(fsy)	int
Specifies the width of the attribute map to export. C: Default width is 256. Q: When queried, it returns an integer.
exportfiletype(eft)	string
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.
tablet(tab)	boolean
Returns true if the tablet device is present, false if it is absent
surfaceConformedBrushVertices( scv)	boolean
Enables/disables the the display of the effective brush area as affected vertices.
tangentOutline(to)	boolean
Enables/disables the display of the brush circle tangent to the surface.
painttxtattr(pta)	string
Specifies the attribute on the shader which the user wants to paint. Currently, we support the following attributes: "Color", "Transparency", "Ambient", "Incandescence", "BumpMap", "Diffuse", "Translucence" "Eccentricity" "SpecularColor", "Reflectivity", "ReflectedColor". Default is "Color".
paintoperationtype(pot)	string
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".
alphablendmode(abm)	string
Specifies the blend mode used while painting RGB channel. Currently, we support the following blend modes: "Default" "Lighten" "Darken" "Difference" "Exclusion" "Hard Light" "Soft Light" "Multiply" "Screen" "Overlay" Default is "Default".
stampSpacing(stS)	float
Specifies the stamp spacing. Default is 1.0.
pfxScale(psc)	float
Specifies the scale for Paint Effect brushes.
pfxWidth(pwd)	float
Specifies the width for Paint Effect brushes.
filetxtsizex(ftx)	int
Specifies the width of the texture. Default is 256.
filetxtsizey(fty)	int
Specifies the height of the texture. Default is 256.
keepaspectratio(kar)	boolean
States if the aspect ratio of the file texture sizes should remain constant. Default is true. boolean.
filetxtaspectratio(far)	float
Specifies the aspect ration of the texture width and height. Default is 1.
assigntxt(ast)	boolean
Sends a request to the tool to allocate and assign file textures to the specified attibute on the selected shaders.
reloadtexfile(rtf)	boolean
Sends a request to the tool to reload the texture from the disc.
savetexture(stx)	boolean
Sends a request to the tool to save the texture to the disc.
saveonstroke(sos)	boolean
States if the temporary texture will be automatically saved on each stroke. Default is false.
saveTextureOnStroke(sts)	boolean
States if the original texture will be automatically saved on each stroke. Default is false.
extendFillColor(efc)	boolean
States if the painted textures will be automatically postprocessed on each stroke to fill in the background color. Default is true.
resizeratio(rr)	float
Specifies the scale by which to resize the current textures.
resizetxt(rft)	boolean
Sends a request to the tool to resize all the currently in use textures.
shapenames(shn)	string
Returns a string with the names of all surfaces which are being painted on.
shadernames(hnm)	string
Returns a string with the names of all shaders assigned to selected surfaces.
painttxtattrname(ptn)	string
Returns a string with the names of all paintable attributes supported by the Paint Texture Tool.
commonattr(cat)	string
Returns a string with the names of all common to all the shaders paintable attributes and supported by the Paint Texture Tool.

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 3d paint context, then switch to it
cmds.art3dPaintCtx('art3dPaintCtx1')
cmds.setToolTo('art3dPaintCtx1')

# Set art3dPaintCtx1's radius to 2.0, lowerradius to 0.5
cmds.art3dPaintCtx('art3dPaintCtx1', edit=True, r=2.0, lr=0.5)