renderWindowEditor is undoable, queryable, and editable.
Create a editor window that can receive the result of the rendering
process
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-exists(-ex) |
|
![create create](../gfx/create.gif) |
|
Returns true|false depending upon whether the specified object
exists. Other flags are ignored. |
|
-defineTemplate(-dt) |
string |
![create create](../gfx/create.gif) |
|
Puts a 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. |
|
-useTemplate(-ut) |
string |
![create create](../gfx/create.gif) |
|
Force the command to use a command template other than the
current one. |
|
-panel(-pnl) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) |
|
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. |
|
-parent(-p) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Specifies the parent layout for this editor. This flag will
only have an effect if the editor is currently un-parented. |
|
-unParent(-up) |
|
![create create](../gfx/create.gif) ![edit edit](../gfx/edit.gif) |
|
Specifies that the editor should be removed from its layout.
This cannot be used with query. |
|
-control(-ctl) |
|
![query query](../gfx/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, at times, for an editor to exist without a control.
This flag returns "NONE" if no control is present. |
|
-mainListConnection(-mlc) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-forceMainConnection(-fmc) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-selectionConnection(-slc) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-highlightConnection(-hlc) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-filter(-f) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-lockMainConnection(-lck) |
|
![create create](../gfx/create.gif) ![edit edit](../gfx/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. |
|
-stateString(-sts) |
|
![query query](../gfx/query.gif) |
|
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. |
|
-unlockMainConnection(-ulk) |
|
![create create](../gfx/create.gif) ![edit edit](../gfx/edit.gif) |
|
Unlocks the mainConnection, effectively restoring the original
mainConnection (if it is still available), and dynamic
updates. |
|
-updateMainConnection(-upd) |
|
![create create](../gfx/create.gif) ![edit edit](../gfx/edit.gif) |
|
Causes a locked mainConnection to be updated from the orginal
mainConnection, but preserves the lock state. |
|
-docTag(-dtg) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Attaches a tag to the Maya editor. |
|
-scaleRed(-sr) |
float |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/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 |
|
-scaleGreen(-sg) |
float |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/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 |
|
-scaleBlue(-sb) |
float |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/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 |
|
-singleBuffer(-sbf) |
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Set the display in single buffer mode |
|
-doubleBuffer(-dbf) |
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Set the display in double buffer mode |
|
-changeCommand(-cc) |
string string string
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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
|
|
-displayImage(-di) |
int |
![query query](../gfx/query.gif) ![edit edit](../gfx/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/saveImage" flag. |
|
-loadImage(-li) |
string |
![edit edit](../gfx/edit.gif) |
|
load an image from disk and set it as the current Editor
Image |
|
-writeImage(-wi) |
string |
![edit edit](../gfx/edit.gif) |
|
write the current Editor Image to disk |
|
-displayStyle(-dst) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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
|
|
-removeImage(-ri) |
|
![edit edit](../gfx/edit.gif) |
|
remove the current Editor Image from the Editor Image
Stack |
|
-removeAllImages(-ra) |
|
![edit edit](../gfx/edit.gif) |
|
remove all the Editor Images from the Editor Image Stack |
|
-saveImage(-si) |
|
![edit edit](../gfx/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/displayImage" flag. |
|
-nbImages(-nim) |
|
![query query](../gfx/query.gif) |
|
returns the number of images |
|
-toggle(-tgl) |
boolean |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Turns the ground plane display on/off. |
|
-marquee(-mq) |
float float float float |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
The arguments define the four corners of a rectangle: top left
bottom right. The rectangle defines a marquee for the render
computation. |
|
-resetRegion(-rr) |
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Forces a reset of any marquee/region. |
|
-autoResize(-ar) |
boolean |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Lets the render view editor automatically resize the viewport
or not. |
|
-showRegion(-srg) |
int int |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Shows the current region at the given resolution. The two
parameters define the width and height. |
|
-snapshot(-snp) |
string int int |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-currentCamera(-crc) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Get or set the current camera. (used when redoing last
render) |
|
-currentCameraRig(-crg) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-clear(-cl) |
int int float float float |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Clear the image with the given color at the given resolution.
Argumnets are respecively: width height red green blue. |
|
-frameImage(-fi) |
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Frames the image inside the window. |
|
-frameRegion(-fr) |
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Frames the region inside the window. |
|
-realSize(-rs) |
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Display the image with a one to one pixel match. |
|
-caption(-cap) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Sets the caption which appears at the bottom of the render
view. |
|
-pcaption(-pca) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Get or set the permanent caption which appears under the image
that is currently showing in the render editor. |
|
-compDisplay(-cd) |
int |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
- 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.
|
|
-blendMode(-blm) |
int |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-compImageFile(-cif) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
Open the given image file and blend with the buffer as if the
image was just rendered. |
|
-stereo(-s) |
int |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-stereoImageOrientation(
-sio) |
string string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-resetViewImage(-rvi) |
|
![create create](../gfx/create.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-nextViewImage(-nvi) |
|
![create create](../gfx/create.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-viewImageCount(-vic) |
int |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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. |
|
-displayImageViewCount(-dvc) |
int |
![query query](../gfx/query.gif) |
|
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. |
|
-stereoMode(-sm) |
string |
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif) |
|
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 |
|
-colorManage(-com) |
|
![edit edit](../gfx/edit.gif) |
|
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. |
|