itemFilterAttr is undoable, queryable, and editable.
This command creates a named itemFilterAttr object. This object
can be attached to editors, in order to filter the attributes
going through them.
Using union and intersection filters, complex composite filters can
be created.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-hidden(-h)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are hidden to the user
|
|
-writable(-w)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are writable (inputs)
|
|
-readable(-r)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are readable (outputs)
|
|
-keyable(-k)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are keyable
|
|
-scaleRotateTranslate(-srt)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will show only SRT attributes: scale, rotate, translate and
their children
|
|
-hasExpression(-he)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are driven by expressions
|
|
-hasDrivenKey(-hdk)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are driven by driven keys
|
|
-hasCurve(-hc)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are driven by animation
curves.
|
|
-published(-pub)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass attributes that are published on the container.
|
|
-byName(-bn)
|
string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will only pass items whose names match the given regular
expression string. This string can contain the special
characters * and ?. '?' matches any one character, and '*'
matches any substring.
|
|
-byNameString(-bns)
|
string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif) ![edit edit](../gfx/edit.gif)
|
|
The filter will only pass items whose names match the given string.
This is a multi-use flag which allows the user to specify several strings.
The filter will pass items that match any of the strings.
|
|
-byScript(-bs)
|
string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will run a MEL script named by the given string on each
attribute name. Attributes will pass the filter if the script
returns a non-zero value.
The script name string must be the name of a proc whose signature
is:
global proc int procName( string $nodeName string $attrName )
|
|
-secondScript(-ss)
|
string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
Can be used in conjunction with the -bs flag. The second
script is for filtering whole lists at once, rather than
individually. Its signature must be:
global proc string[] procName( string[] $nodeName string[] $attrName )
It should take in a list of attributes, and return a filtered list
of attributes.
|
|
-union(-un)
|
string string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will consist of the union of two other filters, whose
names are the given strings.
Attributes will pass this filter if they pass at least one of the
contained filters.
|
|
-intersect(-in)
|
string string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
The filter will consist of the intersection of two other filters,
whose names are the given strings.
Attributes will pass this filter if and only if they pass both of
the contained filters.
|
|
-negate(-neg)
|
boolean
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
This flag can be used to cause the filter to invert itself,
and reverse what passes and what fails.
|
|
-parent(-p)
|
string
|
|
|
This flag is no longer supported.
|
|
-text(-t)
|
string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
Defines an annotation string to be stored with the filter
|
|
-classification(-cls)
|
string
|
![create create](../gfx/create.gif) ![query query](../gfx/query.gif)
|
|
Internal use only. Indicates whether the filter is a built-in
or user filter. The string argument is one of "builtIn" | "user" | "other".
|
|
-listBuiltInFilters(-lbf)
|
|
|
|
Returns an array of all attribute filters with classification "builtIn".
|
|
-listUserFilters(-luf)
|
|
|
|
Returns an array of all attribute filters with classification "user".
|
|
-listOtherFilters(-lof)
|
|
|
|
Returns an array of all attribute filters with classification "other".
|
|