pymel.core.context.art3dPaintCtx

art3dPaintCtx(*args, **kwargs)

This is a tool context command for 3d Paint tool. In query mode, return type is based on queried flag.

Modifications:
  • converts a whitespace-separated string of names to a list of PyNode objects for flags: (query and (shapenames or shadernames))

Flags:

Long Name / Short Name Argument Types Properties
accopacity / aco bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 unicode  
   
alphablendmode / abm unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the blend mode used while painting RGB channel. Currently, we support the following blend modes: DefaultLightenDarkenDifferenceExclusionHard LightSoft LightMultiplyScreenOverlayConstantDefault is Default.
assigntxt / ast bool ../../../_images/edit.gif
  Sends a request to the tool to allocate and assign file textures to the specified attibute on the selected shaders.
attrnames / atn unicode  
   
beforeStrokeCmd / bsc unicode  
   
brushalignment / bra bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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.
brushdepth / bd float  
   
brushfeedback / brf bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies if the brush additional feedback should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
brushtype / brt unicode  
   
clear / clr bool ../../../_images/create.gif ../../../_images/edit.gif
  Floods all cvs/vertices to the current value.
commonattr / cat unicode ../../../_images/query.gif
  Returns a string with the names of all common to all the shaders paintable attributes and supported by the Paint Texture Tool.
dragSlider / dsl unicode ../../../_images/create.gif ../../../_images/edit.gif
  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, uvvectoror none. C: Default is none.
dynclonemode / dcm bool  
   
exists / ex bool ../../../_images/create.gif
  Returns true or false depending upon whether the specified object exists. Other flags are ignored.
expandfilename / eef bool ../../../_images/create.gif ../../../_images/edit.gif
  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  
   
exportfilemode / efm unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 unicode ../../../_images/edit.gif
  Exports the attribute map and saves to a specified file.
exportfilesizex / fsx int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the width of the attribute map to export. C: Default width is 256. Q: When queried, it returns an integer.
exportfilesizey / fsy int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the width of the attribute map to export. C: Default width is 256. Q: When queried, it returns an integer.
exportfiletype / eft unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the image file format. It can be one of the following: iff, tiff, jpeg, alias, rgb, fitpostScriptEPS, softimage, wavefrontRLA, wavefrontEXP. C: default is tiff. Q: When queried, it returns a string.
extendFillColor / efc bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  States if the painted textures will be automatically postprocessed on each stroke to fill in the background color. Default is true.
fileformat / eff unicode  
   
filetxtaspectratio / far float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the aspect ration of the texture width and height. Default is 1.
filetxtsizex / ftx int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the width of the texture. Default is 256.
filetxtsizey / fty int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the height of the texture. Default is 256.
floodOpacity / fop float  
   
floodall / fal bool  
   
floodselect / fsl bool  
   
history / ch bool ../../../_images/create.gif
  If this is a tool command, turn the construction history on for the tool in question.
image1 / i1 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  First of three possible icons representing the tool associated with the context.
image2 / i2 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Second of three possible icons representing the tool associated with the context.
image3 / i3 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Third of three possible icons representing the tool associated with the context.
importfileload / ifl unicode ../../../_images/edit.gif
  Load the attribute map a specified file.
importfilemode / ifm unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the channel to import. The valid entries here are: alpha, luminance, red, green, blue, and rgbC: Default is alpha. Q: When queried, it returns a string.
importreassign / irm bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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.
keepaspectratio / kar bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  States if the aspect ratio of the file texture sizes should remain constant. Default is true. boolean.
lastRecorderCmd / lrc unicode  
   
lastStampName / lsn unicode  
   
lowerradius / lr float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Sets the lower size of the brush (only apply on tablet).
makeStroke / mst int  
   
mappressure / mp unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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.
name / n unicode ../../../_images/create.gif
  If this is a tool command, name the tool appropriately.
opacity / op float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Sets the brush opacity. C: Default is 1.0. Q: When queried, it returns a float.
outline / o bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies if the brush should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
outwhilepaint / owp bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies if the brush outline should be drawn while painting. C: Default is FALSE. Q: When queried, it returns a boolean.
paintmode / pm unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the paint mode. There are two possibilities: screenand tangent. C: Default is screen. Q: When queried, it returns a string.
paintoperationtype / pot unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the operation type used by the Paint Tool. Currently, we support the following paint modes: Paint, Smear, Blur, Eraseand Clone. Default is Paint.
painttxtattr / pta unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the attribute on the shader which the user wants to paint. Currently, we support the following attributes: Color, Transparency, Ambient, Incandescence, BumpMap, Diffuse, TranslucenceEccentricitySpecularColor, Reflectivity, ReflectedColor, and user-defined float, float3, double, and double3 attributes. Default is Color.
painttxtattrname / ptn unicode ../../../_images/query.gif ../../../_images/edit.gif
  Returns a string with the names of all paintable attributes supported by the Paint Texture Tool.
pfxScale / psc float ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the scale for Paint Effect brushes.
pfxWidth / pwd float ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the width for Paint Effect brushes.
pickColor / pcm bool  
   
pickValue / pv bool  
   
playbackCursor / plc float, float  
   
playbackPressure / plp float  
   
preserveclonesource / pcs bool  
   
pressureMapping1 / pm1 int  
   
pressureMapping2 / pm2 int  
   
pressureMapping3 / pm3 int  
   
pressureMax1 / px1 float  
   
pressureMax2 / px2 float  
   
pressureMax3 / px3 float  
   
pressureMin1 / ps1 float  
   
pressureMin2 / ps2 float  
   
pressureMin3 / ps3 float  
   
profileShapeFile / psf unicode ../../../_images/query.gif ../../../_images/edit.gif
  Passes a name of the image file for the stamp shape profile.
projective / prm bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the projective paint mode. C: Default is ‘false’. Q: When queried, it returns a boolean.
radius / r float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Sets the size of the brush. C: Default is 1.0 cm. Q: When queried, it returns a float.
record / rec bool  
   
reflection / rn bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the reflection mode. C: Default is ‘false’. Q: When queried, it returns a boolean.
reflectionaboutorigin / rno bool  
   
reflectionaxis / ra unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the reflection axis. There are three possibilities: x, yand z. C: Default is x. Q: When queried, it returns a string.
reloadtexfile / rtf bool ../../../_images/edit.gif
  Sends a request to the tool to reload the texture from the disc.
resizeratio / rr float ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the scale by which to resize the current textures.
resizetxt / rft bool ../../../_images/edit.gif
  Sends a request to the tool to resize all the currently in use textures.
rgbcolor / rgb float, float, float  
   
rgbflood / fc float, float, float  
   
saveTextureOnStroke / sts bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  States if the original texture will be automatically saved on each stroke. Default is false.
saveonstroke / sos bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  States if the temporary texture will be automatically saved on each stroke. Default is false.
savetexture / stx bool ../../../_images/edit.gif
  Sends a request to the tool to save the texture to the disc.
screenRadius / scR float  
   
selectclonesource / scs bool  
   
shadernames / hnm unicode ../../../_images/query.gif
  Returns a string with the names of all shaders assigned to selected surfaces.
shapeattr / spa bool ../../../_images/query.gif ../../../_images/edit.gif
  States if the attribute to paint is an attribute of the shape and not the shader. Default is false.
shapenames / shn unicode ../../../_images/query.gif
  Returns a string with the names of all surfaces which are being painted on.
showactive / sa bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Sets on/off the display of the surface isoparms. C: Default is TRUE. Q: When queried, it returns a boolean.
soloAsDiffuse / sod bool ../../../_images/query.gif ../../../_images/edit.gif
  States if the currently paintable texture will be rendered as as diffuse texture in the viewport. Default is false.
stampDepth / stD float  
   
stampProfile / stP unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Sets the brush profile of the current stamp. Currently, the following profiles are supported: gaussian, soft, solidand square. C: Default is gaussian. Q: When queried, it returns a string.
stampSpacing / stS float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the stamp spacing. Default is 1.0.
strokesmooth / ssm unicode  
   
surfaceConformedBrushVertices / scv bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Enables/disables the the display of the effective brush area as affected vertices.
tablet / tab bool ../../../_images/query.gif
  Returns true if the tablet device is present, false if it is absent
tangentOutline / to bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Enables/disables the display of the brush circle tangent to the surface.
textureFilenames / tfn bool ../../../_images/query.gif
  Returns a string array with the names of all the painted file textures.
updateEraseTex / uet bool  
   
usepressure / up bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Sets the tablet pressure on/off. C: Default is false. Q: When queried, it returns a boolean. Flag can have multiple arguments, passed either as a tuple or a list.
worldRadius / wlR float  
   

Derived from mel command maya.cmds.art3dPaintCtx

Example:

import pymel.core as pm

# Create a new 3d paint context, then switch to it
pm.art3dPaintCtx('art3dPaintCtx1')
# Result: u'art3dPaintCtx1' #
pm.setToolTo('art3dPaintCtx1')

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