Detailed Description

Class for defining a scene list filter.

MObjectListFilter provides an interface to define a list of selection items which can be used to filter the display of items for interactive 3D scene rendering.

The selection list can either have the meaning of rendering only the items in that list (an inclusion list) or only rendering items which are not in the list (an exclusion list).

Programmers using this interface can derive from this class and implement the required methods. The derived class is responsible for

Registering and deregistering the filter via the registerFilter() and deregisterFilter() methods.
Maintaining the selection list to be used for filtering.
Indicating when this list has been modified via the requireListUpdate() method. Note that it is valid to always mark the list as being modified.
Return the selection list when asked via the getList() method.

#include <MObjectListFilter.h>

List of all members.

Public Types
enum	MFilterType { kInclusionList = 0, kExclusionList, kNumberOfFilterTypes }
	Type of filter list. More...
Public Member Functions
	MObjectListFilter (const MString &name)
	Constructor for a filter.
virtual	~MObjectListFilter ()
	Default destructor.
virtual bool	requireListUpdate ()=0
	This method is called by Maya to determine whether the contents of the object list for the filter has changed since the last requireLastUpdate() call was made.
virtual MStatus	getList (MSelectionList &list)=0
	This method will return the selection list to use for filtering scene rendering.
void	setFilterType (MFilterType filterType)
	Set the filter type.
MFilterType	filterType () const
	Query the filter type.
const MString &	name () const
	Query the name identifier.
const MString &	UIname () const
	Query the UI name.
void	setUIName (const MString &name)
	Set the UI name.
Static Public Member Functions
static MStatus	registerFilter (const MObjectListFilter &filter)
	Register the object filter as one of an available set of filters.
static MStatus	deregisterFilter (const MObjectListFilter &filter)
	Deregister the object filter from the list of available filters.
static const char *	className ()
	Returns the name of this class.

Member Enumeration Documentation

enum MFilterType

Search for all occurrences

Type of filter list.

Enumerator:

kInclusionList	Include only items on the list. Search for all occurrences
kExclusionList	Exclude only items on the list. Search for all occurrences
kNumberOfFilterTypes	Not to be used. This is the number of filter types. Search for all occurrences

Constructor & Destructor Documentation

MObjectListFilter ( const MString & name )

Constructor for a filter.

By default the instance is created with the type kInclusionList (an inclusion list). And the UI name is set to be the input name parameter

Parameters:

[in] name Unique name for the filter.

Member Function Documentation

bool requireListUpdate ( ) [pure virtual]

Search for all occurrences

This method is called by Maya to determine whether the contents of the object list for the filter has changed since the last requireLastUpdate() call was made.

If the list has changed then getList() will be called to query for the contents of the filter.

This method will be called once per frame render or refresh if the filter is actively being used for rendering.

Users should never call this method themselves.

Derived classes must implement this method.