pymel.core.system.pluginDisplayFilter

pluginDisplayFilter(*args, **kwargs)

Register, deregister or query a plugin display filter. Plug-ins can use this command to register their own display filters which will appear in the ‘Show’ menus on Maya’s model panels.

Flags:

Long name (short name)		Argument Types	Properties
classification (cls)		unicode
	The classification used to filter objects in Viewport 2.0. This classification is the same as MFnPlugin::registerNode(). If the node was registered with multiple classifications, use the one beginning with “drawdb”. The default value of this flag is an empty string (“”). It will not filter any objects in Viewport 2.0.
deregister (dr)		bool
	Deregister a plugin display filter.
exists (ex)		unicode
	Returns true if the specified filter exists, false otherwise. Other flags are ignored.
label (l)		unicode
	The string to be displayed for this filter in the UI. E.g. in the ‘Show’ menu of a model panel. The default value of this flag is the same as the plugin display filter name.
listFilters (lf)		bool
	Returns an array of all plugin display filters.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
register (r)		bool
	Register a plugin display filter. The -register is implied if both -register and -deregister flags are missing in create mode. You are responsible for deregistering any filters which you register. Filters are reference counted, meaning that if you register the same filter twice then you will have to deregister it twice as well.

Derived from mel command maya.cmds.pluginDisplayFilter

Example:

import pymel.core as pm

#    Register a plugin display filter.
#
pm.pluginDisplayFilter('myDisplayFilter', register = 1, label = 'My Display Filter', classification = 'drawdb/geometry/myShape')
# Result: u'myDisplayFilter' #
#    Deregister a plugin display filter.
#
pm.pluginDisplayFilter('myDisplayFilter', deregister = 1)
# Result: u'myDisplayFilter' #
#    List all plugin display filters.
#
filters = pm.pluginDisplayFilter(q = 1, listFilters = 1)
#    Query the label of a display filter
#
label = pm.pluginDisplayFilter('myDisplayFilter', q = 1, label = 1)