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

Synopsis

itemFilterType [-text string] [-type] string

itemFilterType is undoable, queryable, and editable.

This command queries a named itemFilter object. This object can be attached to selectionConnection objects, or to editors, in order to filter the item lists going through them. Using union and intersection filters, complex composite filters can be created.

Return value

string
string[]

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

Flags

text, type
Long name (short name) Argument types Properties
-type(-typ) query
Query the type of the filter object. Possible return values are: itemFilter, attributeFilter, renderFilter, or unknownFilter.
-text(-t) string queryedit
Defines an annotation string to be stored with the filter
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

//    Create a filter that will pass all spot lights and transforms.
//
string $filter = `itemFilter -byType transform -byType spotLight`;

//    Now query the type of the filter.
//
string $type = `itemFilterType -query -type $filter`;
print ("Filter type: " + $type + "\n");

//    Delete the filter.
//
delete $filter;