backgroundEvaluationManager

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

Synopsis

backgroundEvaluationManager([interrupt=boolean], [mode=string], [pause=boolean], [resume=boolean])

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

backgroundEvaluationManager is NOT undoable, queryable, and NOT editable.

Return value

None

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

Keywords

Flags

Long name (short name)	Argument types	Properties
interrupt(i)	boolean
Enable or disable fast interrupt of background execution during interactive workflow.
mode(m)	string
Changes the current evaluation mode in the evaluation manager. Supported values are "serial" and "parallel".
pause(p)	boolean
Pause background evaluation. Will block till background evaluation is fully stopped. Can be queried to get the current state.
resume(r)	boolean
Resume background evaluation. Will start suspended evaluations unless someones else requested it.

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


import maya.cmds as cmds

# Set background evaluation manager to serial mode
cmds.backgroundEvaluationManager( mode="serial" )
# Result: True #

# Return the current background evaluation manager mode
cmds.backgroundEvaluationManager( query=True, m=True )
# Result: [u'serial'] #

# Pause background evaluation
cmds.backgroundEvaluationManager( pause=True )
# Result: True #

# Return the current background evaluation manager mode
cmds.backgroundEvaluationManager( query=True, p=True )
# Result: True #

# Resume background evaluation (unless was paused by someone else)
cmds.backgroundEvaluationManager( resume=True )
# Result: True #

# Enable fast interrupt of background executions
cmds.backgroundEvaluationManager( interrupt=True )
# Result: True #