artSetPaintCtx

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

Synopsis

artSetPaintCtx [-accopacity boolean] [-brushalignment boolean] [-brushfeedback boolean] [-clear] [-dragSlider string] [-exists] [-expandfilename boolean] [-exportfilemode string] [-exportfilesave string] [-exportfilesizex int] [-exportfilesizey int] [-exportfiletype string] [-history boolean] [-image1 string] [-image2 string] [-image3 string] [-importfileload string] [-importfilemode string] [-importreassign boolean] [-lowerradius float] [-mappressure string] [-name string] [-opacity float] [-outline boolean] [-outwhilepaint boolean] [-paintmode string] [-profileShapeFile string] [-projective boolean] [-radius float] [-reflection boolean] [-reflectionaxis string] [-setcolorfeedback boolean] [-setdisplaycvs boolean] [-setopertype string] [-settomodify string] [-showactive boolean] [-stampProfile string] [-surfaceConformedBrushVertices boolean] [-tablet] [-tangentOutline boolean] [-usepressure boolean]

artSetPaintCtx 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
-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.
-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.
-brushfeedback(-brf)	boolean
Specifies if the brush additional feedback should be drawn. C: Default is TRUE. Q: When queried, it returns a boolean.
-clear(-clr)
Floods all cvs/vertices to the current value.
-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".
-exists(-ex)
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
-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.
-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.
-exportfilesave(-esf)	string
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)	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.
-history(-ch)	boolean
If this is a tool command, turn the construction history on for the tool in question.
-image1(-i1)	string
First of three possible icons representing the tool associated with the context.
-image2(-i2)	string
Second of three possible icons representing the tool associated with the context.
-image3(-i3)	string
Third of three possible icons representing the tool associated with the context.
-importfileload(-ifl)	string
Load the attribute map a specified file.
-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.
-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.
-lowerradius(-lr)	float
Sets the lower size of the brush (only apply on tablet).
-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.
-name(-n)	string
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)	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.
-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.
-profileShapeFile(-psf)	string
Passes a name of the image file for the stamp shape profile.
-projective(-prm)	boolean
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.
-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.
-setcolorfeedback(-scf)	boolean
Specifies if the color feedback is on or off. C: Default is ON. Q: When queried, it returns a boolean.
-setdisplaycvs(-dcv)	boolean
Specifies if the active cvs are displayed. C: Default is ON. Q: When queried, it returns a boolean.
-setopertype(-sot)	string
Specifies the setEdit operation ("add", "transfer", "remove"). C: Default is "add". Q: When queried, it returns a string.
-settomodify(-stm)	string
Specifies the name of the set to modify. Q: When queried, it returns a string.
-showactive(-sa)	boolean
Sets on/off the display of the surface isoparms. C: Default is TRUE. Q: When queried, it returns a boolean.
-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.
-surfaceConformedBrushVertices(-scv)	boolean
Enables/disables the the display of the effective brush area as affected vertices.
-tablet(-tab)
Returns true if the tablet device is present, false if it is absent
-tangentOutline(-to)	boolean
Enables/disables the display of the brush circle tangent to the surface.
-usepressure(-up)	boolean
Sets the tablet pressure on/off. C: Default is false. Q: When queried, it returns a boolean.

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 be used more than once in a command.

MEL examples

// Create a new set membership paint context, then switch to it
artSetPaintCtx artSetPaintCtx1;
setToolTo artSetPaintCtx1;

// Set brush's radius to 2.0, lower radius to 0.5
artSetPaintCtx -e -r 2.0 -lr 0.5 artSetPaintCtx1;