pymel.core.animation.freezeOptions¶

freezeOptions(*args, **kwargs)¶

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.

Flags:

Long Name / Short Name		Argument Types	Properties
displayLayers / dl		bool
	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		unicode
	Controls how frozen state is propagated downstream from currently frozen nodes. Valid values are nonefor no propagation, safefor propagation downstream only when all upstream nodes are frozen, and forcefor propagation downstream when any upstream node is frozen.
explicitPropagation / ep		bool
	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		bool
	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		bool
	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		bool
	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		unicode
	Controls how frozen state is propagated upstream from currently frozen nodes. Valid values are nonefor no propagation, safefor propagation upstream only when all downstream nodes are frozen, and forcefor propagation upstream when any downstream node is frozen. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.freezeOptions

Example:

::

import pymel.core as pm

import maya.cmds as cmds

# Print the current display layer freeze option print ‘Display layer freeze option is {}’.format( pm.freezeOptions( query=True, displayLayers=True ) )

# Toggle the display layer freeze option on pm.freezeOptions( displayLayers=True ) # Result: True # # Return: True #

# Set downstream propagation to safe mode pm.freezeOptions( downstream=’safe’ ) # Result: True # # Return: True #