pymel.core.context.artSelectCtx

artSelectCtx(*args, **kwargs)

This command is used to select/deselect/toggle components on selected surfaces using a brush interface (Maya Artisan). Since, it selects components of the surface, it only works in the component mode. In query mode, return type is based on queried flag.

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.
addselection (ads) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

If true, each new stroke adds cvs to the active list. If false, each stroke replaces the previous selection. C: Default is true. Q: When queried, it returns a boole

afterStrokeCmd (asc) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 commandFlag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

beforeStrokeCmd (bsc) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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) 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.

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.
clear (clr) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Floods all cvs/vertices to the current value.
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”, “uvvector” or “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”, “fit” “postScriptEPS”, “softimage”, “wavefrontRLA”, “wavefrontEXP”. C: default is tiff. Q: When queried, it returns a string.

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
   
image2 (i2) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
   
image3 (i3) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Contexts support up to three icons that represent 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 “rgb” C: 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.

importthreshold (ift) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the threshold for the import of the attribute maps. C: Default is 0.5. Q: When queried, it returns a float.
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: “screen” and “tangent”. C: Default is “screen”. Q: When queried, it returns a string.
paintoperationtype (pot) unicode  
   
pickColor (pcm) bool  
   
pickValue (pv) bool  
   
playbackCursor (plc) float, float  
   
playbackPressure (plp) float  
   
preserveclonesource (pcs) bool  
   
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”, “y” and “z”. C: Default is “x”. Q: When queried, it returns a string.
screenRadius (scR) float  
   
selectall (sal) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Selects all vertices/egdes/faces/uvs.
selectclonesource (scs) bool  
   
selectop (sop) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the selection operation (“select”, “unselect”, “toggle”). C: Default is “select”. Q: When queried, it returns a string.
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.
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”, “solid” and “square”. C: Default is gaussian. Q: When queried, it returns a string.

stampSpacing (stS) float  
   
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.
toggleall (tal) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Toggle all vertices/egdes/faces/uvs.
unselectall (ual) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Unselects all vertices/egdes/faces/uvs.
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.
worldRadius (wlR) float  
   

Derived from mel command maya.cmds.artSelectCtx

Example:

import pymel.core as pm

# Create a new select context, then switch to it
pm.artSelectCtx('artSelectCtx1')
# Result: u'artSelectCtx1' #
pm.setToolTo('artSelectCtx1')

# Set brush's radius to 2.0, lower radius to 0.5
pm.artSelectCtx('artSelectCtx1', edit=True, r=2.0, lr=0.5)
# Result: u'artSelectCtx1' #

Previous topic

pymel.core.context.artPuttyCtx

Next topic

pymel.core.context.artSetPaintCtx

Core

Core Modules

Other Modules

This Page