pymel.core.effects.dynPaintEditor

dynPaintEditor(*args, **kwargs)

Create a editor window that can be painted into

Flags:

Long Name / Short Name Argument Types Properties
activeOnly / ao bool ../../../_images/query.gif ../../../_images/edit.gif
  For Scene mode, this determines if only the active strokes will be refreshed.
autoSave / autoSave bool ../../../_images/query.gif ../../../_images/edit.gif
  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 unicode ../../../_images/query.gif ../../../_images/edit.gif
  Sets the name of the camera which the Paint Effects panel looks through.
canvasMode / cm bool ../../../_images/query.gif ../../../_images/edit.gif
  Sets the Paint Effects panel into Canvas mode if true.
canvasUndo / cu bool ../../../_images/edit.gif
  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 unicode, unicode, unicode, unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Parameters: First string: commandSecond string: editorNameThird string: editorCmdFourth string: updateFuncCall 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 reason1: scale color2: buffer (single/double)3: axis 4: image displayed5: image saved in memory
clear / cl float, float, float ../../../_images/edit.gif
  Clears the buffer (if in Canvas mode) to the floating point values (R,G,B).
control / ctl bool ../../../_images/query.gif
  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 NONEif no control is present.
currentCanvasSize / ccs bool ../../../_images/query.gif
  In Query mode, this returns the (X,Y) resolution of the current canvas.
defineTemplate / dt unicode ../../../_images/create.gif
  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 unicode ../../../_images/query.gif ../../../_images/edit.gif
  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 boundingBoxare valid for the interactive mode.
displayFog / dfg bool ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/query.gif ../../../_images/edit.gif
  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/saveImageflag.
displayLights / dsl unicode ../../../_images/query.gif ../../../_images/edit.gif
  Sets the lighting for shaded mode. Possible values are selected, active, all, default.
displayStyle / dst unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Set the mode to display the image. Valid values are: colorto display the basic RGB imagemaskto display the mask channellumto display the luminance of the image
displayTextures / dtx bool ../../../_images/query.gif ../../../_images/edit.gif
  Turns on or off display of textures in shaded mode
docTag / dtg unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Attaches a tag to the editor.
doubleBuffer / dbf bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Set the display in double buffer mode
drawAxis / da bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Set or query whether the axis will be drawn.
drawContext / drc bool ../../../_images/query.gif
  Returns the name of the context.
exists / ex bool ../../../_images/create.gif
  Returns whether the specified object exists or not. Other flags are ignored.
fastUpdate / fu int  
   
fileName / fil unicode ../../../_images/query.gif ../../../_images/edit.gif
  This sets the file to which the canvas will be saved.
filter / f unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 bool ../../../_images/edit.gif
  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 unicode ../../../_images/edit.gif
  load an image from disk and set it as the current Editor Image
lockMainConnection / lck bool ../../../_images/create.gif ../../../_images/edit.gif
  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 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 unicode ../../../_images/create.gif
  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 bool ../../../_images/query.gif
  returns the number of images
newImage / ni int, int, float, float, float ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/edit.gif
  Redraws the buffer in current refresh mode.
panel / pnl unicode ../../../_images/create.gif ../../../_images/query.gif
  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 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
redrawLast / rl bool ../../../_images/edit.gif
  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 bool ../../../_images/edit.gif
  requests a refresh of the current Editor Image.
refreshMode / rmd int ../../../_images/query.gif ../../../_images/edit.gif
  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 bool ../../../_images/edit.gif
  remove all the Editor Images from the Editor Image Stack
removeImage / ri bool ../../../_images/edit.gif
  remove the current Editor Image from the Editor Image Stack
rollImage / rig float, float ../../../_images/edit.gif
  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 bool ../../../_images/query.gif ../../../_images/edit.gif
  For Canvas mode, this determines if the alpha will be saved when storing the canvas to a disk file.
saveBumpmap / sbm unicode ../../../_images/query.gif ../../../_images/edit.gif
  Saves the current buffer as a bump map to the specified file.
saveImage / si bool ../../../_images/edit.gif
  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/displayImageflag.
scaleBlue / sb float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  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 bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
  Set the display in single buffer mode
snapShot / snp bool ../../../_images/edit.gif
  Takes a snapshot of the current camera view.
stateString / sts bool ../../../_images/query.gif
  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.
swap / swp int  
   
tileSize / ts int ../../../_images/edit.gif
  Sets the size of the tile for the hardware texture redraw of the display buffer.
unParent / up bool ../../../_images/create.gif ../../../_images/edit.gif
  Specifies that the editor should be removed from its layout. This cannot be used in query mode.
undoCache / uc bool ../../../_images/edit.gif
  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 bool ../../../_images/create.gif ../../../_images/edit.gif
  Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection / upd bool ../../../_images/create.gif ../../../_images/edit.gif
  Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
useTemplate / ut unicode ../../../_images/create.gif
  Force the command to use a command template other than the current one.
wrap / wr bool, bool ../../../_images/query.gif ../../../_images/edit.gif
  For Canvas mode, should the buffer wrap in U, and V (respectively) when painting.
writeImage / wi unicode ../../../_images/edit.gif
  write the current Editor Image to disk
zoom / zm float ../../../_images/query.gif ../../../_images/edit.gif
  Zooms the Canvas image by the specified value. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.dynPaintEditor

Example:

import pymel.core as pm

pm.dynPaintEditor( 'editor' )

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