Go to: Synopsis. Return value. Related. Flags. MEL examples.
refresh [-currentView] [-fileExtension string] [-filename string] [-force] [-suspend boolean]
refresh is undoable, NOT queryable, and NOT editable.
This command is used to force a redraw during script execution.
Normally, redraw is suspended while scripts are executing but
sometimes it is useful to show intermediate results for purposes
such as capturing images from the screen.
If the -cv flag is specified, then only the current active view
is redrawn.
None
currentUnit, displayAffected, displayColor, displayCull, displayLevelOfDetail, displayPref, displayRGBColor, displaySmoothness, displayStats, displaySurface, hide, showHidden, toggle
currentView, fileExtension, filename, force, suspend
| Long name (short name) |
Argument types |
Properties |
|
-currentView(-cv)
|
|
|
|
Redraw only the current view (default redraws all views).
|
|
-fileExtension(-fe)
|
string
|
|
|
Specify the type of file to save using the filename flag.
|
|
-filename(-fn)
|
string
|
|
|
Specify the name of a file in which to save a snapshot of the
viewports, or just the current one if the currentView flag is set.
|
|
-force(-f)
|
|
|
|
Force the refresh regardless of the state of the model.
|
|
-suspend(-su)
|
boolean
|
|
|
Suspends or resumes Maya's handling of refresh events. Specify "on" to
suspend refreshing, and "off" to resume refreshing. Note that
resuming refresh does not itself cause a refresh -- the next natural refresh
event in Maya after "refresh -suspend off" is issued will cause the refresh
to occur. Use this flag with caution: although it provides opportunities
to enhance performance, much of Maya's dependency graph evaluation in
interactive mode is refresh driven, thus use of this flag may lead to
slight solve differences when you have a complex dependency graph with
interrelations.
|
|
|
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 be used more than once in a command.
|
refresh;
// The refresh command can also be used to take a snapshot of the current scene view and
// save it as an image file. See example below.
// Set up workspace for images in current project
string $ws=`workspace -q -fullName`;
string $wsp=$ws + "/images";
sysFile -makeDir $wsp;
// Prepare unique image name for snapshot
string $imageSnapshot = $wsp + "/endSnapshot.jpg";
// Take a snapshot of the viewport and save to file
refresh -cv -fe "jpg" -fn $imageSnapshot;