Go to: Synopsis. Return value. Keywords. Flags. Python examples.
freezeOptions([displayLayers=boolean], [downstream=string], [explicitPropagation=boolean], [invisible=boolean], [referencedNodes=boolean], [runtimePropagation=boolean], [upstream=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
freezeOptions is NOT undoable, queryable, and NOT editable.
This command provides access to the options used by the evaluation manager to
handle propagation and recognition of when a node is in a frozen state.
See the individual flags for the different options available.
These values are all stored as user preferences and persist across sessions.
| string | Current value of the option if querying the downstream or upstream flags |
| boolean | Current value of the option if querying the displayLayers, invisible, referencedNodes, explicitPropagation, or runtimePropagaton flags |
| boolean | In creation mode returns true if all options were successfully set |
In query mode, return type is based on queried flag.
evaluation, manager, DG, runtime, freeze
displayLayers, downstream, explicitPropagation, invisible, referencedNodes, runtimePropagation, upstream
| Long name (short name) |
Argument types |
Properties |
displayLayers(dl)
|
boolean
|
 
|
|
If this option is enabled then any nodes that are in an enabled, invisible display
layer will be considered to be frozen, and the frozen state will propagate accordingly.
|
|
downstream(dn)
|
string
|
|
|
Controls how frozen state is propagated downstream from currently frozen nodes.
Valid values are "none" for no propagation, "safe" for propagation downstream
only when all upstream nodes are frozen, and "force" for propagation downstream
when any upstream node is frozen.
|
|
explicitPropagation(ep)
|
boolean
|
|
|
When turned on this will perform an extra pass when the evaluation graph is
constructed to perform intelligent propagation of the frozen state to related
nodes as specified by the currently enabled options of the evaluation graph.
See also "runtimePropagation".
This option performs more thorough propagation of the frozen state, but requires
extra time for recalculating the evaluation graph.
|
|
invisible(inv)
|
boolean
|
|
|
If this option is enabled then any nodes that are invisible, either directly or
via an invisible parent node, will be considered to be frozen, and the frozen state
will propagate accordingly.
|
|
referencedNodes(rn)
|
boolean
|
|
|
If this option is enabled then any nodes that are referenced in from a frozen referenced node
will also be considered to be frozen, and the frozen state will propagate accordingly.
|
|
runtimePropagation(rt)
|
boolean
|
|
|
When turned on this will allow the frozen state to propagate during execution
of the evaluation graph. See also "explicitPropagation".
This option allows frozen nodes to be scheduled for evaluation, but once it
discovers a node that is frozen it will prune the evaluation based on the
current set of enabled options. It only works in the downstream direction.
|
|
upstream(up)
|
string
|
|
|
Controls how frozen state is propagated upstream from currently frozen nodes.
Valid values are "none" for no propagation, "safe" for propagation upstream
only when all downstream nodes are frozen, and "force" for propagation upstream
when any downstream node is frozen.
|
|
|
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.
|
import maya.cmds as cmds
import maya.cmds as cmds
# Print the current display layer freeze option
print 'Display layer freeze option is {}'.format( cmds.freezeOptions( query=True, displayLayers=True ) )
# Toggle the display layer freeze option on
cmds.freezeOptions( displayLayers=True )
# Return: True #
# Set downstream propagation to safe mode
cmds.freezeOptions( downstream='safe' )
# Return: True #