pymel.core.general.itemFilterAttr

itemFilterAttr(*args, **kwargs)

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.

Flags:

• byName : bn (unicode) [create,query,edit]

  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 (unicode) [create,query,edit]

  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 (unicode) [create,query,edit]

  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 )

• classification : cls (unicode) [create,query,edit]

  Internal use only. Indicates whether the filter is a built-in or user filter. The string argument is one of builtIn| user| other.

• dynamic : dy (bool) []

• exists : ex (bool) []

• hasCurve : hc (bool) [create,query,edit]

  The filter will only pass attributes that are driven by animation curves.

• hasDrivenKey : hdk (bool) [create,query,edit]

  The filter will only pass attributes that are driven by driven keys

• hasExpression : he (bool) [create,query,edit]

  The filter will only pass attributes that are driven by expressions

• hidden : h (bool) [create,query,edit]

  The filter will only pass attributes that are hidden to the user

• intersect : intersect (unicode, unicode) [create,query,edit]

  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.

• keyable : k (bool) [create,query,edit]

  The filter will only pass attributes that are keyable

• listBuiltInFilters : lbf (bool) [query]

  Returns an array of all attribute filters with classification builtIn.

• listOtherFilters : lof (bool) [query]

  Returns an array of all attribute filters with classification other. Flag can have multiple arguments, passed either as a tuple or a list.

• listUserFilters : luf (bool) [query]

  Returns an array of all attribute filters with classification user.

• negate : neg (bool) [create,query,edit]

  This flag can be used to cause the filter to invert itself, and reverse what passes and what fails.

• parent : p (unicode) []

  This flag is no longer supported.

• published : pub (bool) [create,query,edit]

  The filter will only pass attributes that are published on the container.

• readable : r (bool) [create,query,edit]

  The filter will only pass attributes that are readable (outputs)

• scaleRotateTranslate : srt (bool) [create,query,edit]

  The filter will show only SRT attributes: scale, rotate, translate and their children

• secondScript : ss (unicode) [create,query,edit]

  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.

• text : t (unicode) [create,query,edit]

  Defines an annotation string to be stored with the filter

• union : un (unicode, unicode) [create,query,edit]

  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.

• writable : w (bool) [create,query,edit]

  The filter will only pass attributes that are writable (inputs)

Derived from mel command maya.cmds.itemFilterAttr