dynPaintEditor

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

Synopsis

dynPaintEditor( editorName , [activeOnly=boolean], [autoSave=boolean], [camera=string], [canvasMode=boolean], [canvasUndo=boolean], [changeCommand=[string, string, string, string]], [clear=[float, float, float]], [control=boolean], [currentCanvasSize=boolean], [defineTemplate=string], [displayAppearance=string], [displayFog=boolean], [displayImage=int], [displayLights=string], [displayStyle=string], [displayTextures=boolean], [docTag=string], [doubleBuffer=boolean], [drawAxis=boolean], [drawContext=boolean], [exists=boolean], [fileName=string], [filter=string], [forceMainConnection=string], [highlightConnection=string], [iconGrab=boolean], [loadImage=string], [lockMainConnection=boolean], [mainListConnection=string], [menu=string], [nbImages=boolean], [newImage=[int, int, float, float, float]], [paintAll=float], [panel=string], [parent=string], [redrawLast=boolean], [refresh=boolean], [refreshMode=int], [removeAllImages=boolean], [removeImage=boolean], [rollImage=[float, float]], [saveAlpha=boolean], [saveBumpmap=string], [saveImage=boolean], [scaleBlue=float], [scaleGreen=float], [scaleRed=float], [selectionConnection=string], [singleBuffer=boolean], [snapShot=boolean], [stateString=boolean], [tileSize=int], [unParent=boolean], [undoCache=boolean], [unlockMainConnection=boolean], [updateMainConnection=boolean], [useTemplate=string], [wrap=[boolean, boolean]], [writeImage=string], [zoom=float])

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

dynPaintEditor is undoable, queryable, and editable.

Return value

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

Related

Flags

Long name (short name)	Argument types	Properties
activeOnly(ao)	boolean
For Scene mode, this determines if only the active strokes will be refreshed.
autoSave(autoSave)	boolean
For Canvas mode, this determines if the buffer will be saved to a disk file after every stroke. Good for painting textures and viewing the results in shaded display in the model view.
camera(cam)	string
Sets the name of the camera which the Paint Effects panel looks through.
canvasMode(cm)	boolean
Sets the Paint Effects panel into Canvas mode if true.
canvasUndo(cu)	boolean
Does a fast undo in Canvas mode. This is a special undo because we are not using any history when we paint in Canvas mode so we provide a single level undo for the Canvas.
changeCommand(cc)	[string, string, string, string]
Parameters: First string: command Second string: editorName Third string: editorCmd Fourth string: updateFunc Call the command when something changes in the editor The command should have this prototype : command(string $editor, string $editorCmd, string $updateFunc, int $reason) The possible reasons could be : 0: no particular reason 1: scale color 2: buffer (single/double) 3: axis 4: image displayed 5: image saved in memory
clear(cl)	[float, float, float]
Clears the buffer (if in Canvas mode) to the floating point values (R,G,B).
control(ctl)	boolean
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible for an editor to exist without a control. The query will return "NONE" if no control is present.
currentCanvasSize(ccs)	boolean
In Query mode, this returns the (X,Y) resolution of the current canvas.
defineTemplate(dt)	string
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
displayAppearance(dsa)	string
Sets the display appearance of the model panel. Possible values are "wireframe", "points", "boundingBox", "smoothShaded", "flatShaded". This flag may be used with the -interactive and -default flags. Note that only "wireframe", "points", and "boundingBox" are valid for the interactive mode.
displayFog(dfg)	boolean
For Scene mode, this determines if fog will be displayed in the Paint Effects panel when refreshing the scene. If fog is on, but this is off, fog will only be drawn on the strokes, not the rest of the scene.
displayImage(di)	int
Set a particular image in the Editor Image Stack as the current Editor Image. Images are added to the Editor Image Stack using the "si/saveImage" flag.
displayLights(dsl)	string
Sets the lighting for shaded mode. Possible values are "selected", "active", "all", "default".
displayStyle(dst)	string
Set the mode to display the image. Valid values are: "color" to display the basic RGB image "mask" to display the mask channel "lum" to display the luminance of the image
displayTextures(dtx)	boolean
Turns on or off display of textures in shaded mode
docTag(dtg)	string
Attaches a tag to the editor.
doubleBuffer(dbf)	boolean
Set the display in double buffer mode
drawAxis(da)	boolean
Set or query whether the axis will be drawn.
drawContext(drc)	boolean
Returns the name of the context.
exists(ex)	boolean
Returns whether the specified object exists or not. Other flags are ignored.
fileName(fil)	string
This sets the file to which the canvas will be saved.
filter(f)	string
Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the main list of the editor.
forceMainConnection(fmc)	string
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
highlightConnection(hlc)	string
Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all editors have a highlight list. For those that do, it is a secondary selection list.
iconGrab(ig)	boolean
This puts the Paint Effects panel into Grab Icon mode where the user is expected to drag out a section of the screen to be made into an icon.
loadImage(li)	string
load an image from disk and set it as the current Editor Image
lockMainConnection(lck)	boolean
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor. Further changes to the original mainConnection are ignored.
mainListConnection(mlc)	string
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.
menu(mn)	string
Sets the name of the script used to build a menu in the editor. The script takes the editor name as an argument.
nbImages(nim)	boolean
returns the number of images
newImage(ni)	[int, int, float, float, float]
Starts a new image in edit mode, setting the resolution to the integer values (X,Y) and clearing the buffer to the floating point values (R,G,B). In Query mode, this returns the (X,Y) resolution of the current Image.
paintAll(pa)	float
Redraws the buffer in current refresh mode.
panel(pnl)	string
Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is deleted.
parent(p)	string
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
redrawLast(rl)	boolean
Redraws the last stroke again. Useful when it's brush has just changed. This feature does a fast undo and redraws the stroke again.
refresh(ref)	boolean
requests a refresh of the current Editor Image.
refreshMode(rmd)	int
Sets the refresh mode to the specified value. 0 - Do not draw strokes on refresh, 1 - Redraw strokes in wireframe mode, 2 - Redraw strokes in final rendered mode.
removeAllImages(ra)	boolean
remove all the Editor Images from the Editor Image Stack
removeImage(ri)	boolean
remove the current Editor Image from the Editor Image Stack
rollImage(rig)	[float, float]
In Canvas mode, this rolls the image by the floating point values (X,Y). X and Y are between 0 (no roll) and 1 (full roll). A value of .5 rolls the image 50% (ie. the border moves to the center of the screen.
saveAlpha(sa)	boolean
For Canvas mode, this determines if the alpha will be saved when storing the canvas to a disk file.
saveBumpmap(sbm)	string
Saves the current buffer as a bump map to the specified file.
saveImage(si)	boolean
save the current Editor Image to memory. Saved Editor Images are stored in an Editor Image Stack. The most recently saved image is stored in position 0, the second most recently saved image in position 1, and so on... To set the current Editor Image to a previously saved image use the "di/displayImage" flag.
scaleBlue(sb)	float
Define the scaling factor for the blue component in the View. The default value is 1 and can be between -1000 to +1000
scaleGreen(sg)	float
Define the scaling factor for the green component in the View. The default value is 1 and can be between -1000 to +1000
scaleRed(sr)	float
Define the scaling factor for the red component in the View. The default value is 1 and can be between -1000 to +1000
selectionConnection(slc)	string
Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes changes, the editor updates to show the changes.
singleBuffer(sbf)	boolean
Set the display in single buffer mode
snapShot(snp)	boolean
Takes a snapshot of the current camera view.
stateString(sts)	boolean
Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.
tileSize(ts)	int
Sets the size of the tile for the hardware texture redraw of the display buffer.
unParent(up)	boolean
Specifies that the editor should be removed from its layout. This cannot be used in query mode.
undoCache(uc)	boolean
By default the last image is cached for undo. If this is set false, then undoing will be disabled in canvas mode and undo in scene mode will force a full refresh. Less memory will be used if this is set false before the first clear or refresh of the current scene.
unlockMainConnection(ulk)	boolean
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection(upd)	boolean
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
useTemplate(ut)	string
Force the command to use a command template other than the current one.
wrap(wr)	[boolean, boolean]
For Canvas mode, should the buffer wrap in U, and V (respectively) when painting.
writeImage(wi)	string
write the current Editor Image to disk
zoom(zm)	float
Zooms the Canvas image by the specified value.

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

cmds.dynPaintEditor( 'editor' )

cmds.dynPaintEditor( 'editor', e=True, ni=(640, 480, 1.0, 0.5, 0.2) )