pymel.core.uitypes.RenderWindowEditor

class RenderWindowEditor

class counterpart of mel function renderWindowEditor

Create a editor window that can receive the result of the rendering process

colorManage(val=True, **kwargs)

When used with the writeImage flag, causes the written image to be color-managed using the settings from the view color manager attached to the view.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.renderWindowEditor

getAutoResize(**kwargs)

Lets the render view editor automatically resize the viewport or not.

Derived from mel command maya.cmds.renderWindowEditor

getBlendMode(**kwargs)

Sets the blend mode for the render view. New image sent to the render view will be blended with the previous image in the render view, and the composited image will appear.

Derived from mel command maya.cmds.renderWindowEditor

getCaption(**kwargs)

Sets the caption which appears at the bottom of the render view.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

getClear(**kwargs)

Clear the image with the given color at the given resolution. Argumnets are respecively: width height red green blue.

Derived from mel command maya.cmds.renderWindowEditor

getCompDisplay(**kwargs)

0 : disable compositing.1 : displays the composited image immediately.For example, when foreground layer tile is sent to the render view window, the composited tile is displayed in the render view window, and the original foreground layer tile is not displayed.2 : display the un-composited image, and keep the composited image for the future command.For example, when foreground layer tile is sent to the render view window, the original foreground layer tile is not displayed, and the composited tile is stored in a buffer.3 : show the current composited image. If there is a composited image in the buffer, display it.

Derived from mel command maya.cmds.renderWindowEditor

getCompImageFile(**kwargs)

Open the given image file and blend with the buffer as if the image was just rendered.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

getCurrentCamera(**kwargs)

Get or set the current camera. (used when redoing last render)

Derived from mel command maya.cmds.renderWindowEditor

getCurrentCameraRig(**kwargs)

Get or set the current camera rig name. If a camera rig is specified, it will be used when redoing the last render as opposed to the currentCamera value, as the currentCamera value will hold the child camera last used for rendering the camera rig.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

getDisplayImageViewCount(**kwargs)

Query the number of views stored for a given image in the Editor Image Stack. This is not the same as querying using “viewImageCount” which returns the number of views for the current rendered image.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

getDocTag(**kwargs)

Attaches a tag to the Maya editor.

Derived from mel command maya.cmds.renderWindowEditor

getDoubleBuffer(**kwargs)

Set the display in double buffer mode

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

getFrameImage(**kwargs)

Frames the image inside the window.

Derived from mel command maya.cmds.renderWindowEditor

getFrameRegion(**kwargs)

Frames the region inside the window.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

getMarquee(**kwargs)

The arguments define the four corners of a rectangle: top left bottom right. The rectangle defines a marquee for the render computation.

Derived from mel command maya.cmds.renderWindowEditor

getNbImages(**kwargs)

returns the number of images

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

getPcaption(**kwargs)

Get or set the permanent caption which appears under the image that is currently showing in the render editor.

Derived from mel command maya.cmds.renderWindowEditor

getRealSize(**kwargs)

Display the image with a one to one pixel match.

Derived from mel command maya.cmds.renderWindowEditor

getResetRegion(**kwargs)

Forces a reset of any marquee/region.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

getShowRegion(**kwargs)

Shows the current region at the given resolution. The two parameters define the width and height.

Derived from mel command maya.cmds.renderWindowEditor

getSingleBuffer(**kwargs)

Set the display in single buffer mode

Derived from mel command maya.cmds.renderWindowEditor

getSnapshot(**kwargs)

Makes a copy of the camera of the model editor at the given size. First argument is the editor name, second is the width, third is the height.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

getStereo(**kwargs)

Puts the editor into stereo image mode. The effective resolution of the output image is twice the size of the horizontal size. The orientation of the images can be set using the stereoOrientation flag.

Derived from mel command maya.cmds.renderWindowEditor

getStereoImageOrientation(**kwargs)

Specifies the orientation of stereo camera renders. The first argument specifies the orientation value for the firstleft image and the second argument specifies the orientation value for the right image. The orientation values are ‘normal’, the image appears as seen throught he camera, or ‘mirrored’, the image is mirrored horizontally.

Derived from mel command maya.cmds.renderWindowEditor

getStereoMode(**kwargs)

Specifies how the image is displayed in the view. By default the stereo is rendered with a side by side image. The rendered image is a single image that is twice the size of a normal image, ‘both’. Users can also choose to display as ‘redcyan’, ‘redcyanlum’, ‘leftonly’, ‘rightonly’, or ‘stereo’. both - displays both the left and right redcyan - displays the images as a red/cyan pair. redcyanlum - displays the luminance of the images as a red/cyan pair. leftonly - displays the left side only rightonly - displays the right side only stereo - mode that supports Crystal Eyes(tm) or Zscreen (tm) renders

Derived from mel command maya.cmds.renderWindowEditor

getToggle(**kwargs)

Turns the ground plane display on/off.

Derived from mel command maya.cmds.renderWindowEditor

getViewImageCount(**kwargs)

The render editor has the capability to render multiple cameras within a single view. This is different from image binning where an image is saved. Multiple image views are useful for comparing two different camera renders side-by-side. The viewImageCount flag tells the editor that it should prepare its internal image storage mechanism for a given number of views.

Derived from mel command maya.cmds.renderWindowEditor

loadImage(val=True, **kwargs)

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

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

nextViewImage(val=True, **kwargs)

The render editor has the capability to render multiple cameras within a single view. This is different from image binning where an image is saved. Multiple image views are useful for comparing two different camera renders side-by-side. The nextViewImage flag tells the editor that it should prepare its internal image storage mechanism to store to the next view location.

Derived from mel command maya.cmds.renderWindowEditor

removeAllImages(val=True, **kwargs)

remove all the Editor Images from the Editor Image Stack

Derived from mel command maya.cmds.renderWindowEditor

removeImage(val=True, **kwargs)

remove the current Editor Image from the Editor Image Stack

Derived from mel command maya.cmds.renderWindowEditor

resetViewImage(val=True, **kwargs)

The render editor has the capability to render multiple cameras within a single view. This is different from image binning where an image is saved. Multiple image views are useful for comparing two different camera renders side-by-side. The resetViewImage flag tells the editor that it should reset its internal image storage mechanism to the first image. This would happen at the very start of a render view render.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

setAutoResize(val=True, **kwargs)

Lets the render view editor automatically resize the viewport or not.

Derived from mel command maya.cmds.renderWindowEditor

setBlendMode(val=True, **kwargs)

Sets the blend mode for the render view. New image sent to the render view will be blended with the previous image in the render view, and the composited image will appear.

Derived from mel command maya.cmds.renderWindowEditor

setCaption(val=True, **kwargs)

Sets the caption which appears at the bottom of the render view.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

setClear(val=True, **kwargs)

Clear the image with the given color at the given resolution. Argumnets are respecively: width height red green blue.

Derived from mel command maya.cmds.renderWindowEditor

setCompDisplay(val=True, **kwargs)

0 : disable compositing.1 : displays the composited image immediately.For example, when foreground layer tile is sent to the render view window, the composited tile is displayed in the render view window, and the original foreground layer tile is not displayed.2 : display the un-composited image, and keep the composited image for the future command.For example, when foreground layer tile is sent to the render view window, the original foreground layer tile is not displayed, and the composited tile is stored in a buffer.3 : show the current composited image. If there is a composited image in the buffer, display it.

Derived from mel command maya.cmds.renderWindowEditor

setCompImageFile(val=True, **kwargs)

Open the given image file and blend with the buffer as if the image was just rendered.

Derived from mel command maya.cmds.renderWindowEditor

setCurrentCamera(val=True, **kwargs)

Get or set the current camera. (used when redoing last render)

Derived from mel command maya.cmds.renderWindowEditor

setCurrentCameraRig(val=True, **kwargs)

Get or set the current camera rig name. If a camera rig is specified, it will be used when redoing the last render as opposed to the currentCamera value, as the currentCamera value will hold the child camera last used for rendering the camera rig.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

setDocTag(val=True, **kwargs)

Attaches a tag to the Maya editor.

Derived from mel command maya.cmds.renderWindowEditor

setDoubleBuffer(val=True, **kwargs)

Set the display in double buffer mode

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

setFrameImage(val=True, **kwargs)

Frames the image inside the window.

Derived from mel command maya.cmds.renderWindowEditor

setFrameRegion(val=True, **kwargs)

Frames the region inside the window.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

setMarquee(val=True, **kwargs)

The arguments define the four corners of a rectangle: top left bottom right. The rectangle defines a marquee for the render computation.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

setPcaption(val=True, **kwargs)

Get or set the permanent caption which appears under the image that is currently showing in the render editor.

Derived from mel command maya.cmds.renderWindowEditor

setRealSize(val=True, **kwargs)

Display the image with a one to one pixel match.

Derived from mel command maya.cmds.renderWindowEditor

setResetRegion(val=True, **kwargs)

Forces a reset of any marquee/region.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

setShowRegion(val=True, **kwargs)

Shows the current region at the given resolution. The two parameters define the width and height.

Derived from mel command maya.cmds.renderWindowEditor

setSingleBuffer(val=True, **kwargs)

Set the display in single buffer mode

Derived from mel command maya.cmds.renderWindowEditor

setSnapshot(val=True, **kwargs)

Makes a copy of the camera of the model editor at the given size. First argument is the editor name, second is the width, third is the height.

Derived from mel command maya.cmds.renderWindowEditor

setStereo(val=True, **kwargs)

Puts the editor into stereo image mode. The effective resolution of the output image is twice the size of the horizontal size. The orientation of the images can be set using the stereoOrientation flag.

Derived from mel command maya.cmds.renderWindowEditor

setStereoImageOrientation(val=True, **kwargs)

Specifies the orientation of stereo camera renders. The first argument specifies the orientation value for the firstleft image and the second argument specifies the orientation value for the right image. The orientation values are ‘normal’, the image appears as seen throught he camera, or ‘mirrored’, the image is mirrored horizontally.

Derived from mel command maya.cmds.renderWindowEditor

setStereoMode(val=True, **kwargs)

Specifies how the image is displayed in the view. By default the stereo is rendered with a side by side image. The rendered image is a single image that is twice the size of a normal image, ‘both’. Users can also choose to display as ‘redcyan’, ‘redcyanlum’, ‘leftonly’, ‘rightonly’, or ‘stereo’. both - displays both the left and right redcyan - displays the images as a red/cyan pair. redcyanlum - displays the luminance of the images as a red/cyan pair. leftonly - displays the left side only rightonly - displays the right side only stereo - mode that supports Crystal Eyes(tm) or Zscreen (tm) renders

Derived from mel command maya.cmds.renderWindowEditor

setToggle(val=True, **kwargs)

Turns the ground plane display on/off.

Derived from mel command maya.cmds.renderWindowEditor

setViewImageCount(val=True, **kwargs)

The render editor has the capability to render multiple cameras within a single view. This is different from image binning where an image is saved. Multiple image views are useful for comparing two different camera renders side-by-side. The viewImageCount flag tells the editor that it should prepare its internal image storage mechanism for a given number of views.

Derived from mel command maya.cmds.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

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.renderWindowEditor

writeImage(val=True, **kwargs)

write the current Editor Image to disk

Derived from mel command maya.cmds.renderWindowEditor