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

Synopsis

evaluator [-clusters boolean] [-configuration string] [-enable boolean] [-info boolean] [-name string] [-nodeType string] [-nodeTypeChildren] [-priority int] [-valueName string]

evaluator is NOT undoable, queryable, and NOT editable.

Handles turning on and off custom evaluation overrides used by the evaluation manager. Query no flag to see all available custom evaluators. Query the 'enable' flag to check if an evaluator is currently enabled. If the 'name' flag isn't used then return all modes and their current active state.

Return value

string[]the list of available evaluators (querying with no evaluator flag or invalid evaluator name)
booleanthe previous active state of the named evaluator (with 'name' and 'enable' flags)
booleanthe active state of the named evaluator (query with 'name' and 'enable' flags)
string[]the list of evaluators in the requested active state (query 'enable' flag alone)
string[]the list of nodes for which the evaluator was activated or deactivated (with 'nodeType' or 'nodeTypeChildren' flags)
stringthe queried value for the evaluator (with 'name' and 'valueName' flags)
booleantrue if the configuration request was accepted by the evaluator (with 'name' flag and 'configuration' flag)
string[]the list of configuration parameters accepted by the evaluator (query mode with 'name' flag and 'configuration' flag)
string[]the list of clusters currently assigned to the evaluator with intervening sublist sizes (query mode with 'name' flag and 'clusters' flag)
stringthe help information supplied by the evaluator (query mode with 'name' flag and 'info' flag)
intthe priority value of the evaluator (query mode with 'name' flag and 'priority' flag)

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

Keywords

evaluation, manager, DG, runtime

Flags

clusters, configuration, enable, info, name, nodeType, nodeTypeChildren, priority, valueName
Long name (short name) Argument types Properties
-clusters(-cl) boolean query
This flag queries the list of clusters currently assigned to the named custom evaluator. The return value will be an array of strings where the array consists of a set of (number, string[]) groups. e.g. If an evaluator has 2 clusters with 2 and 3 nodes in them respectively the output would be something like: (2, 'transform2', 'transform3', 3, 'joint1', 'joint2', 'joint3')
-configuration(-c) string createquerymultiuse
Sends configuration information to a custom evaluator. It's up to the evaluator to understand what they mean. Multiple configuration messages can be sent in a single command. Query this flag for a given evaluator to find out what configuration messages it accepts.
-enable(-en) boolean createquery
Enables or disables a specific graph evaluation runtime, depending on the state of the flag. In order to use this flag you must also specify the name in the 'name' argument. When the 'enable' flag is used in conjunction with the 'nodeType' flag then it is used to selectively turn on or off the ability of the given evaluator to handle nodes of the given type (i.e. it no longer toggles the evaluator enabled state). When the 'enable' flag is used in conjunction with the 'configuration' flag then it is passed along with the configuration message interpreted by the custom evaluator.
-info(-i) boolean query
Queries the evaluator information. Only valid in query mode since the information is generated by the evaluator's internal state and cannot be changed. In order to use this flag, the 'name' argument must also be specified.
-name(-n) string createquery
Names a particular DG evaluation override evaluator. Evaluators are registered automatically by name. Query this flag to get a list of available runtimes. When a runtime is registered it is enabled by default. Use the 'enable' flag to change its enabled state.

In query mode, this flag can accept a value.
-nodeType(-nt) string createquerymultiuse
Names a particular node type to be passed to the evaluator request. Evaluators can either use or ignore the node type information as passed.

In query mode, this flag can accept a value.
-nodeTypeChildren(-ntc) createquery
If enabled when using the 'nodeType' flag then handle all of the node types derived from the given one as well. Default is to only handle the named node type.
-priority(-p) int createquery
Query or set the evaluator priority. Custom evaluator with highest priority order will get the chance to claim the nodes first. Evaluators must have unique priority values. In order to use this flag you must also specify the name in the 'name' argument.
-valueName(-vn) string query
Queries a value from a given evaluator. Evaluators can define a set of values for which they answer.

In query mode, this flag can accept a value.
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


// Load a custom evaluator plug-in (not a real plug-in, just an example)
loadPlugin "MY_CUSTOM_EVALUATOR";
// Result: MY_CUSTOM_EVALUATOR //

// List the available evaluators
evaluator -q;
// Result: "MY_CUSTOM_EVALUATOR" //

// Is "MY_CUSTOM_EVALUATOR" enabled?
evaluator -q -name "MY_CUSTOM_EVALUATOR";
// Result: 0 //

// Check which evaluators are disabled
evaluator -enable off -q;
// Result: MY_CUSTOM_EVALUATOR //

// Turn on "MY_CUSTOM_EVALUATOR"
evaluator -enable on -name "MY_CUSTOM_EVALUATOR";
// Result: 0 //

// Check to see which evaluators are enabled
evaluator -enable on -q;
// Result: MY_CUSTOM_EVALUATOR //

// Make "MY_CUSTOM_EVALUATOR" handle nodes of type "transform"
evaluator -enable on -name "MY_CUSTOM_EVALUATOR" -nodeType "transform";
// Result: transform //

// Make "MY_CUSTOM_EVALUATOR" handle nodes of type "transform" and all derived types
evaluator -enable on -name "MY_CUSTOM_EVALUATOR" -nodeType "transform" -nodeTypeChildren;
// Result: transform joint <large list omitted> //

// Get the list of clustered nodes handled by "MY_CUSTOM_EVALUATOR" in the current scene.
evaluator -name "MY_CUSTOM_EVALUATOR" -q -cl;
// Result: 2 transform1 transform2 3 joint3 joint4 joint5 //

// Send a configuration message to "MY_CUSTOM_EVALUATOR"
evaluator -name "MY_CUSTOM_EVALUATOR" -configuration "cluster=subgraph";
// Result:

// Query information about "MY_CUSTOM_EVALUATOR"
evaluator -q -name "MY_CUSTOM_EVALUATOR" -info;
// Result:

// Query "pruneRoots" priority
evaluator -q -name "pruneRoots" -priority;
// Result: 1000

// Set "pruneRoots" priority to 2500
evaluator -name "pruneRoots" -priority 2500;
// Result: 1