pymel.core.uitypes.DynPaintEditor

class DynPaintEditor

class counterpart of mel function dynPaintEditor

Create a editor window that can be painted into

canvasUndo(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

clear(val=True, **kwargs)

Clears the buffer (if in Canvas mode) to the floating point values (R,G,B).

Derived from mel command maya.cmds.dynPaintEditor

getActiveOnly(**kwargs)

For Scene mode, this determines if only the active strokes will be refreshed.

Derived from mel command maya.cmds.dynPaintEditor

getAutoSave(**kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

getCamera(**kwargs)

Sets the name of the camera which the Paint Effects panel looks through.

Derived from mel command maya.cmds.dynPaintEditor

getCanvasMode(**kwargs)

Sets the Paint Effects panel into Canvas mode if true.

Derived from mel command maya.cmds.dynPaintEditor

getChangeCommand(**kwargs)

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: axis4: image displayed5: image saved in memory

Derived from mel command maya.cmds.dynPaintEditor

getControl(**kwargs)

Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible, at times, for an editor to exist without a control. This flag returns “NONE” if no control is present.

Derived from mel command maya.cmds.dynPaintEditor

getCurrentCanvasSize(**kwargs)

In Query mode, this returns the (X,Y) resolution of the current canvas.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.dynPaintEditor

getDisplayAppearance(**kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

getDisplayFog(**kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

getDisplayImage(**kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

getDisplayLights(**kwargs)

Sets the lighting for shaded mode. Possible values are “selected”, “active”, “all”, “default”.

Derived from mel command maya.cmds.dynPaintEditor

getDisplayStyle(**kwargs)

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

Derived from mel command maya.cmds.dynPaintEditor

getDisplayTextures(**kwargs)

Turns on or off display of textures in shaded mode

Derived from mel command maya.cmds.dynPaintEditor

getDocTag(**kwargs)

Attaches a tag to the Maya editor.

Derived from mel command maya.cmds.dynPaintEditor

getDoubleBuffer(**kwargs)

Set the display in double buffer mode

Derived from mel command maya.cmds.dynPaintEditor

getDrawContext(**kwargs)

Returns the name of the context.

Derived from mel command maya.cmds.dynPaintEditor

getFileName(**kwargs)

This sets the file to which the canvas will be saved.

Derived from mel command maya.cmds.dynPaintEditor

getFilter(**kwargs)

Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.

Derived from mel command maya.cmds.dynPaintEditor

getForceMainConnection(**kwargs)

Specifies the name of a selectionConnection object which 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.

Derived from mel command maya.cmds.dynPaintEditor

getHighlightConnection(**kwargs)

Specifies the name of a selectionConnection object which 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.

Derived from mel command maya.cmds.dynPaintEditor

getMainListConnection(**kwargs)

Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.

Derived from mel command maya.cmds.dynPaintEditor

getNbImages(**kwargs)

returns the number of images

Derived from mel command maya.cmds.dynPaintEditor

getNewImage(**kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

getPanel(**kwargs)

Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor doesn’t belong to a panel it will be deleted when the window that it is in is deleted.

Derived from mel command maya.cmds.dynPaintEditor

getRefreshMode(**kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

getSaveAlpha(**kwargs)

For Canvas mode, this determines if the alpha will be saved when storing the canvas to a disk file.

Derived from mel command maya.cmds.dynPaintEditor

getSaveBumpmap(**kwargs)

Saves the current buffer as a bump map to the specified file.

Derived from mel command maya.cmds.dynPaintEditor

getScaleBlue(**kwargs)

Define the scaling factor for the blue component in the View. The default value is 1 and can be between -1000 to +1000

Derived from mel command maya.cmds.dynPaintEditor

getScaleGreen(**kwargs)

Define the scaling factor for the green component in the View. The default value is 1 and can be between -1000 to +1000

Derived from mel command maya.cmds.dynPaintEditor

getScaleRed(**kwargs)

Define the scaling factor for the red component in the View. The default value is 1 and can be between -1000 to +1000

Derived from mel command maya.cmds.dynPaintEditor

getSelectionConnection(**kwargs)

Specifies the name of a selectionConnection object which 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 change.

Derived from mel command maya.cmds.dynPaintEditor

getSingleBuffer(**kwargs)

Set the display in single buffer mode

Derived from mel command maya.cmds.dynPaintEditor

getStateString(**kwargs)

Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.

Derived from mel command maya.cmds.dynPaintEditor

getWrap(**kwargs)

For Canvas mode, should the buffer wrap in U, and V (respectively) when painting.

Derived from mel command maya.cmds.dynPaintEditor

getZoom(**kwargs)

Zooms the Canvas image by the specified value.

Derived from mel command maya.cmds.dynPaintEditor

iconGrab(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

loadImage(val=True, **kwargs)

load an image from disk and set it as the current Editor Image

Derived from mel command maya.cmds.dynPaintEditor

lockMainConnection(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

paintAll(val=True, **kwargs)

Redraws the buffer in current refresh mode.

Derived from mel command maya.cmds.dynPaintEditor

redrawLast(val=True, **kwargs)

Redraws the last stroke again. Useful when it’s brush has just changed. This feature does a fast undo and redraws the stroke again.

Derived from mel command maya.cmds.dynPaintEditor

removeAllImages(val=True, **kwargs)

remove all the Editor Images from the Editor Image Stack

Derived from mel command maya.cmds.dynPaintEditor

removeImage(val=True, **kwargs)

remove the current Editor Image from the Editor Image Stack

Derived from mel command maya.cmds.dynPaintEditor

rollImage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

saveImage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

setActiveOnly(val=True, **kwargs)

For Scene mode, this determines if only the active strokes will be refreshed.

Derived from mel command maya.cmds.dynPaintEditor

setAutoSave(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

setCamera(val=True, **kwargs)

Sets the name of the camera which the Paint Effects panel looks through.

Derived from mel command maya.cmds.dynPaintEditor

setCanvasMode(val=True, **kwargs)

Sets the Paint Effects panel into Canvas mode if true.

Derived from mel command maya.cmds.dynPaintEditor

setChangeCommand(val=True, **kwargs)

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: axis4: image displayed5: image saved in memory

Derived from mel command maya.cmds.dynPaintEditor

setDisplayAppearance(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

setDisplayFog(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

setDisplayImage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

setDisplayLights(val=True, **kwargs)

Sets the lighting for shaded mode. Possible values are “selected”, “active”, “all”, “default”.

Derived from mel command maya.cmds.dynPaintEditor

setDisplayStyle(val=True, **kwargs)

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

Derived from mel command maya.cmds.dynPaintEditor

setDisplayTextures(val=True, **kwargs)

Turns on or off display of textures in shaded mode

Derived from mel command maya.cmds.dynPaintEditor

setDocTag(val=True, **kwargs)

Attaches a tag to the Maya editor.

Derived from mel command maya.cmds.dynPaintEditor

setDoubleBuffer(val=True, **kwargs)

Set the display in double buffer mode

Derived from mel command maya.cmds.dynPaintEditor

setFileName(val=True, **kwargs)

This sets the file to which the canvas will be saved.

Derived from mel command maya.cmds.dynPaintEditor

setFilter(val=True, **kwargs)

Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.

Derived from mel command maya.cmds.dynPaintEditor

setForceMainConnection(val=True, **kwargs)

Specifies the name of a selectionConnection object which 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.

Derived from mel command maya.cmds.dynPaintEditor

setHighlightConnection(val=True, **kwargs)

Specifies the name of a selectionConnection object which 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.

Derived from mel command maya.cmds.dynPaintEditor

setMainListConnection(val=True, **kwargs)

Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.

Derived from mel command maya.cmds.dynPaintEditor

setNewImage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

setParent(val=True, **kwargs)

Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.

Derived from mel command maya.cmds.dynPaintEditor

setRefreshMode(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

setSaveAlpha(val=True, **kwargs)

For Canvas mode, this determines if the alpha will be saved when storing the canvas to a disk file.

Derived from mel command maya.cmds.dynPaintEditor

setSaveBumpmap(val=True, **kwargs)

Saves the current buffer as a bump map to the specified file.

Derived from mel command maya.cmds.dynPaintEditor

setScaleBlue(val=True, **kwargs)

Define the scaling factor for the blue component in the View. The default value is 1 and can be between -1000 to +1000

Derived from mel command maya.cmds.dynPaintEditor

setScaleGreen(val=True, **kwargs)

Define the scaling factor for the green component in the View. The default value is 1 and can be between -1000 to +1000

Derived from mel command maya.cmds.dynPaintEditor

setScaleRed(val=True, **kwargs)

Define the scaling factor for the red component in the View. The default value is 1 and can be between -1000 to +1000

Derived from mel command maya.cmds.dynPaintEditor

setSelectionConnection(val=True, **kwargs)

Specifies the name of a selectionConnection object which 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 change.

Derived from mel command maya.cmds.dynPaintEditor

setSingleBuffer(val=True, **kwargs)

Set the display in single buffer mode

Derived from mel command maya.cmds.dynPaintEditor

setWrap(val=True, **kwargs)

For Canvas mode, should the buffer wrap in U, and V (respectively) when painting.

Derived from mel command maya.cmds.dynPaintEditor

setZoom(val=True, **kwargs)

Zooms the Canvas image by the specified value.

Derived from mel command maya.cmds.dynPaintEditor

snapShot(val=True, **kwargs)

Takes a snapshot of the current camera view.

Derived from mel command maya.cmds.dynPaintEditor

tileSize(val=True, **kwargs)

Sets the size of the tile for the hardware texture redraw of the display buffer.

Derived from mel command maya.cmds.dynPaintEditor

unParent(val=True, **kwargs)

Specifies that the editor should be removed from its layout. This cannot be used with query.

Derived from mel command maya.cmds.dynPaintEditor

undoCache(val=True, **kwargs)

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.

Derived from mel command maya.cmds.dynPaintEditor

unlockMainConnection(val=True, **kwargs)

Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.

Derived from mel command maya.cmds.dynPaintEditor

updateMainConnection(val=True, **kwargs)

Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.

Derived from mel command maya.cmds.dynPaintEditor

writeImage(val=True, **kwargs)

write the current Editor Image to disk

Derived from mel command maya.cmds.dynPaintEditor