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
`accopacity` / `aco`		bool
	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
	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
	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`		unicode
	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
	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
	Specifies if the brush additional feedback should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
`clear` / `clr`		bool
	Floods all cvs/vertices to the current value.
`dragSlider` / `dsl`		unicode
	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
	Enable or disable dynamic clone mode.
`exists` / `ex`		bool
	Returns true or false depending upon whether the specified object exists. Other flags are ignored.
`expandfilename` / `eef`		bool
	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
	Value of aspect ratio for export
`exportfilemode` / `efm`		unicode
	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
	Exports the attribute map and saves to a specified file.
`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`		unicode
	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.
`history` / `ch`		bool
	If this is a tool command, turn the construction history on for the tool in question.
`image1` / `i1`		unicode
	First of three possible icons representing the tool associated with the context.
`image2` / `i2`		unicode
	Second of three possible icons representing the tool associated with the context.
`image3` / `i3`		unicode
	Third of three possible icons representing the tool associated with the context.
`importfileload` / `ifl`		unicode
	Load the attribute map a specified file.
`importfilemode` / `ifm`		unicode
	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
	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
	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
	Value of last recorded command.
`lastStampName` / `lsn`		unicode
	Value of the last stamp name.
`lowerradius` / `lr`		float
	Sets the lower size of the brush (only apply on tablet).
`makeStroke` / `mst`		int
	Stroke point values.
`mappressure` / `mp`		unicode
	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
	If this is a tool command, name the tool appropriately.
`opacity` / `op`		float
	Sets the brush opacity. C: Default is 1.0. Q: When queried, it returns a float.
`outline` / `o`		bool
	Specifies if the brush should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
`outwhilepaint` / `owp`		bool
	Specifies if the brush outline should be drawn while painting. C: Default is FALSE. Q: When queried, it returns a boolean.
`paintmode` / `pm`		unicode
	Specifies the paint mode. There are two possibilities: screenand tangent. C: Default is screen. Q: When queried, it returns a string.
`paintoperationtype` / `pot`		unicode
	Specifies the operation type used by the Paint Tool. Currently, we support the following paint modes: Paint, Smear, Blur, Eraseand Clone. Default is Paint.
`pickColor` / `pcm`		bool
	Set pick color mode on or off
`pickValue` / `pv`		bool
	Toggle for picking
`playbackCursor` / `plc`		float, float
	Values for the playback cursor.
`playbackPressure` / `plp`		float
	Valus for the playback pressure.
`preserveclonesource` / `pcs`		bool
	Whether or not to preserve a clone source.
`profileShapeFile` / `psf`		unicode
	Passes a name of the image file for the stamp shape profile.
`projective` / `prm`		bool
	Specifies the projective paint mode. C: Default is ‘false’. 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.
`record` / `rec`		bool
	Toggle on for recording.
`reflection` / `rn`		bool
	Specifies the reflection mode. C: Default is ‘false’. Q: When queried, it returns a boolean.
`reflectionaboutorigin` / `rno`		bool
	Toggle on to reflect about the origin
`reflectionaxis` / `ra`		unicode
	Specifies the reflection axis. There are three possibilities: x, yand z. C: Default is x. Q: When queried, it returns a string.
`screenRadius` / `scR`		float
	Brush radius on the screen
`selectall` / `sal`		bool
	Selects all vertices/egdes/faces/uvs.
`selectclonesource` / `scs`		bool
	Toggle on to select the clone source
`selectop` / `sop`		unicode
	Specifies the selection operation (select, unselect, toggle). C: Default is select. Q: When queried, it returns a string.
`showactive` / `sa`		bool
	Sets on/off the display of the surface isoparms. C: Default is TRUE. Q: When queried, it returns a boolean.
`stampDepth` / `stD`		float
	Depth of the stamps
`stampProfile` / `stP`		unicode
	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
	Specifies the stamp spacing. Default is 1.0.
`strokesmooth` / `ssm`		unicode
	Stroke smoothing type name
`surfaceConformedBrushVertices` / `scv`		bool
	Enables/disables the the display of the effective brush area as affected vertices.
`tablet` / `tab`		bool
	Returns true if the tablet device is present, false if it is absent
`tangentOutline` / `to`		bool
	Enables/disables the display of the brush circle tangent to the surface.
`toggleall` / `tal`		bool
	Toggle all vertices/egdes/faces/uvs.
`unselectall` / `ual`		bool
	Unselects all vertices/egdes/faces/uvs.
`usepressure` / `up`		bool
	Sets the tablet pressure on/off. C: Default is false. Q: When queried, it returns a boolean.
`worldRadius` / `wlR`		float
	Radius in worldspace Flag can have multiple arguments, passed either as a tuple or a list.

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' #