progressWindow

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

progressWindow([endProgress=boolean], [isCancelled=boolean], [isInterruptable=boolean], [maxValue=int], [minValue=int], [progress=int], [status=string], [step=int], [title=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

progressWindow is undoable, queryable, and editable.

Only one progress window is allowed on screen at a time. While the window is visible, the busy cursor is shown.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
endProgress(ep)	boolean
Terminates the progress window. No other flags can be used at the same time. This is normally issued through MEL in response to the -ic/isCancelled flag being set or if the progress value reaches its maximum.
isCancelled(ic)	boolean
Returns true if the user has tried to cancel the operation. Returns false otherwise.
isInterruptable(ii)	boolean
Returns true if the progress window should respond to attempts to cancel the operation. The cancel button is disabled if this is set to true.
maxValue(max)	int
The maximum or "ending" value of the progress indicator. If the progress value is greater than the -max/maxValue, the progress value will be set to the maximum. Default value is 100.
minValue(min)	int
The minimum or "starting" value of the progress indicator. If the progress value is less than the -min/minValue, the progress value will be set to the minimum. Default value is 0.
progress(pr)	int
The amount of progress currently shown on the control. The value will always be between min and max. Default is equal to the minimum when the control is created.
status(st)	string
The status text appearing above the progress gauge.
step(s)	int
Increments the -pr/progress value by the amount specified.
title(t)	string
The window title.

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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# +-+------------------+
# |-|  Doing Nothing   |
# +--------------------+
# | Sleeping: 40%      |
# |                    |
# | +----------------+ |
# | |||||||          | |
# | +----------------+ |
# |                    |
# | Hit ESC to Cancel  |
# +--------------------+

# Always use the progress dialog from a script, never directly
# from the Script Editor.

amount = 0

cmds.progressWindow(	title='Doing Nothing',
					progress=amount,
					status='Sleeping: 0%',
					isInterruptable=True )
while True :
	# Check if the dialog has been cancelled
	if cmds.progressWindow( query=True, isCancelled=True ) :
		break

	# Check if end condition has been reached
	if cmds.progressWindow( query=True, progress=True ) >= 100 :
		break

	amount += 5

	cmds.progressWindow( edit=True, progress=amount, status=('Sleeping: ' + `amount` + '%' ) )

	cmds.pause( seconds=1 )

cmds.progressWindow(endProgress=1)