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

Synopsis

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

deformerEvaluator is NOT undoable, queryable, and NOT editable.

Print debug information about deformer evaluator status. In query mode the debug information is returned as a string[], otherwise the information is displayed in the script editor.

Return value

string[]the debug information when query mode is used.

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

Keywords

OpenCL, debug

Flags

active, allowDownloads, asNodeName, asText, deformerChain, deformers, dumpInfo, dumpOutliner, gpuBlockPolicy, limitMinimumVerts, list, members, meshes, message, minimumVerts, nodeInfo, nodeStatus, omitPassthroughs, outlinerHash, partition, purge, reuseMode, verbose
Long name (short name) Argument types Properties
-active(-act) createquery
Modifier to specify that instead of the current selection all active nodes on the GPU should be queried.
-allowDownloads(-adl) boolean createquery
Specifies whether downloads from GPU to CPU are allowed.
-asNodeName(-nm) createquery
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) createquery
Modifier to specify that when the node state is queried the state should be returned as text instead of a numeric code
-deformerChain(-dch) createquery
Query the state of the nodes in the deformation chain of the specified meshes.
-deformers(-d) createquery
Return a list of all currently registered GPU deformers.
-dumpInfo(-di) createquery
List information about all supported deformation chains as JSON.
-dumpOutliner(-dol) createquery
List information about all supported nodes as a python object.
-gpuBlockPolicy(-gbp) string createquery
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 createquery
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) createquery
Return a list of nodes that are currently active on the GPU.
-members(-mbr) createquery
Return the names of the nodes that are in the same cluster as the specified nodes.
-meshes(-m) createquery
Modifier to specify that only meshes need to be queried.
-message(-msg) createquery
Return the messages associated with the specified nodes.
-minimumVerts(-mnv) int createquery
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) createquery
List all the information gathered during partitioning about the selected nodes
-nodeStatus(-ns) createquery
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) createquery
Whether opassthrough nodes like groupParts nodes should be ommitted from the dumped info or not
-outlinerHash(-olh) createquery
Return the unique hash value for the current outliner state.
-partition(-prt) createquery
Flag to force a repartition (for debug purposes only)
-purge(-prg) createquery
Purge the data of any unused gpu nodes
-reuseMode(-ru) string string createquery
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 createquery
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 be used more than once in a command.

MEL examples


// Set the reuse mode for deformers and sinks
deformerEvaluator -ru "always" "never";

// List all registered GPU deformers.
deformerEvaluator -deformers;

// List all nodes that are on the GPU
deformerEvaluator -ls;

// List all meshes that are on the GPU
deformerEvaluator -ls -m;

// List information about selected nodes
deformerEvaluator;

// List information about all active nodes
deformerEvaluator -act;

// List information about selected meshes
deformerEvaluator -m;

// List deformation chain information about selected meshes
deformerEvaluator -dch;

// List all the deformation chains of all meshes that are active on the GPU
deformerEvaluator -dch -act;

// List the names of the nodes that are in the same cluster(s) as the specified nodes.
deformerEvaluator -mbr;

// List the messages associated with the selected nodes.
deformerEvaluator -msg;

// Return all active clusters in JSON format whole omitting all pasthrough nodes.
deformerEvaluator -query -dumpInfo -opt;