deformerEvaluator

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

Synopsis

deformerEvaluator([active=boolean], [allowDownloads=boolean], [asNodeName=boolean], [asText=boolean], [deformerChain=boolean], [deformers=boolean], [dumpInfo=boolean], [dumpOutliner=boolean], [gpuBlockPolicy=string], [limitMinimumVerts=boolean], [list=boolean], [members=boolean], [meshes=boolean], [message=boolean], [minimumVerts=int], [nodeInfo=boolean], [nodeStatus=boolean], [omitPassthroughs=boolean], [outlinerHash=boolean], [partition=boolean], [purge=boolean], [reuseMode=[string, string]], [verbose=boolean])

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

deformerEvaluator is NOT undoable, queryable, and NOT editable.

Return value

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

Keywords

Flags

Long name (short name)	Argument types	Properties
active(act)	boolean
Modifier to specify that instead of the current selection all active nodes on the GPU should be queried.
allowDownloads(adl)	boolean
Specifies whether downloads from GPU to CPU are allowed.
asNodeName(nm)	boolean
Modifier to specify that when a certain node attribute is queried it should return the name of the node instead. This is useful when querying multiple nodes at a time and the results need to be lined up with the node names.
asText(txt)	boolean
Modifier to specify that when the node state is queried the state should be returned as text instead of a numeric code
deformerChain(dch)	boolean
Query the state of the nodes in the deformation chain of the specified meshes.
deformers(d)	boolean
Return a list of all currently registered GPU deformers.
dumpInfo(di)	boolean
List information about all supported deformation chains as JSON.
dumpOutliner(dol)	boolean
List information about all supported nodes as a python object.
gpuBlockPolicy(gbp)	string
Specifies the gpu blocking policy for a node. Currently, we support the following blocking modes: "off" "on" "group" "upstream" "upstreamExcl" "upstreamMesh" "downstream" "downstreamExcl" "groupDownload" Default is "off" which means the node causes no blocking of the GPU.
limitMinimumVerts(lmv)	boolean
Specifies whether the limit on the minimum vert count of the geometry is used or not. The system configuration determines a certain minimum size for geometries to be allowed on GPU. When this flag is on this limit is obeyed. When this flag is off this limit is ignored. This is only used for debugging purposes and is not saved to the file or any preferences.
list(ls)	boolean
Return a list of nodes that are currently active on the GPU.
members(mbr)	boolean
Return the names of the nodes that are in the same cluster as the specified nodes.
meshes(m)	boolean
Modifier to specify that only meshes need to be queried.
message(msg)	boolean
Return the messages associated with the specified nodes.
minimumVerts(mnv)	int
Set the minimum vert count under which the geometry will not be allowed on the GPU (unless in a network with qualifying geometries). This is only used for debugging purposes and is not saved to the file or any preferences.
nodeInfo(ni)	boolean
List all the information gathered during partitioning about the selected nodes
nodeStatus(ns)	boolean
Return the state of the node on the GPU. When queried it will return a numeric code unless the asText flag is used as well.
omitPassthroughs(opt)	boolean
Whether opassthrough nodes like groupParts nodes should be ommitted from the dumped info or not
outlinerHash(olh)	boolean
Return the unique hash value for the current outliner state.
partition(prt)	boolean
Flag to force a repartition (for debug purposes only)
purge(prg)	boolean
Purge the data of any unused gpu nodes
reuseMode(ru)	[string, string]
Specifies how the GPU nodes can be reused when repartitioning. A mode has to be specified for each of the three node types (deformer and displayMesh). A mode for a node type is one of the following: Mode "never" means they will never be reused Mode "immediate" means that nodes will remain in memory during repartitioning but the ones that are not in use immediatley after that will be purged Mode "always" means that all nodes will remain in memory during and after repartitioning for later reuse
verbose(v)	boolean
Print more verbose information of other flags.

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


# Set the reuse mode for deformers and sinks
cmds.deformerEvaluator(ru=("always", "never"))

# List all registered GPU deformers.
cmds.deformerEvaluator( deformers=True )

# List all nodes that are on the GPU
cmds.deformerEvaluator( ls=True )

# List all meshes that are on the GPU
cmds.deformerEvaluator( ls=True, m=True )

# List information about selected nodes
cmds.deformerEvaluator( )

# List information about selected meshes
cmds.deformerEvaluator( m=True )

# List deformation chain information about selected meshes
cmds.deformerEvaluator( dch=True )

# List all the deformation chains of all meshes that are active on the GPU
cmds.deformerEvaluator( dch=True, act=True )

# List the names of the nodes that are in the same cluster(s) as the specified nodes.
cmds.deformerEvaluator( mbr=True )

# List the messages associated with the selected nodes.
cmds.deformerEvaluator( msg=True )

# Return all active clusters in JSON format.
cmds.deformerEvaluator(query=True, dumpInfo=True, opt=True);