BrushConfiguration Class Reference

#include <brush.h>

Class Description

This class can be used to define configurations for different brush behaviours of the same class.

Definition at line 26 of file brush.h.

Public Types
enum	PredefinedCategory { PaintTools, SculptTools, PoseTools, SelectTools }

Public Member Functions
	BrushConfiguration ()
	Constructor. More...
	BrushConfiguration (const ClassDesc *pClass, unsigned int iID, const QString &sStringID, const QString &sDisplayName, const QString &sCategory, const QString &sCategoryTr, const QString &sToolTip, int version=INTRODUCED_IN_MUDBOX_2013_OR_EARLIER)
	BrushConfiguration (const ClassDesc *pClass, unsigned int iID, const QString &sStringID, const QString &sDisplayName, PredefinedCategory nCategory, const QString &sToolTip, int version=INTRODUCED_IN_MUDBOX_2013_OR_EARLIER)
	~BrushConfiguration ()
unsigned int	ID (void) const
	Returns the unique id of the configuration. More...
virtual QString	Name (void) const
	Deprecated. More...
virtual QString	StringID (void) const
	Returns the string id of the configuration. More...
virtual QString	DisplayName (void) const
	Returns the display name of the configuration. More...
virtual void	SetDisplayName (const QString &sDisplayName)
	Sets the display name of the configuration. More...
virtual QString	ToolTip (void) const
	Returns the tooltip for the configuration. More...
virtual int	Version (void) const
	Returns a value indicating what version of Mudbox this configuration was introduced in. More...
virtual const ClassDesc *	OperationClass (void) const
	Returns the operation class belonging to the configuration. More...
virtual QString	Category () const
	Returns the category title that groups configurations together. More...
virtual QString	DisplayCategory () const
	Returns the category title that groups configurations together. More...
virtual void	Serialize (Stream &s)
	Serializes the configuration to the given stream. More...
virtual QString	Icon (void)
	Returns the icon file for the configuration. More...

Member Enumeration Documentation

enum PredefinedCategory

Enumerator
PaintTools
SculptTools
PoseTools
SelectTools

Definition at line 29 of file brush.h.

    {
        PaintTools,
        SculptTools,
        PoseTools,
        SelectTools
    } PredefinedCategory;

Constructor & Destructor Documentation

BrushConfiguration

(

)

Constructor.

BrushConfiguration	(	const ClassDesc *	pClass,
		unsigned int	iID,
		const QString &	sStringID,
		const QString &	sDisplayName,
		const QString &	sCategory,
		const QString &	sCategoryTr,
		const QString &	sToolTip,
		int	version = INTRODUCED_IN_MUDBOX_2013_OR_EARLIER
	)

BrushConfiguration	(	const ClassDesc *	pClass,
		unsigned int	iID,
		const QString &	sStringID,
		const QString &	sDisplayName,
		PredefinedCategory	nCategory,
		const QString &	sToolTip,
		int	version = INTRODUCED_IN_MUDBOX_2013_OR_EARLIER
	)

~BrushConfiguration

(

)

Member Function Documentation

unsigned int ID

(

void

)

const

Returns the unique id of the configuration.

virtual QString Name ( void  ) const

virtual

Deprecated.

Call StringID() or DisplayName() instead. Returns the name of the configuration.

virtual QString StringID ( void  ) const

virtual

Returns the string id of the configuration.

virtual QString DisplayName ( void  ) const

virtual

Returns the display name of the configuration.

virtual void SetDisplayName ( const QString &  sDisplayName )

virtual

Sets the display name of the configuration.

virtual QString ToolTip ( void  ) const

virtual

Returns the tooltip for the configuration.

virtual int Version ( void  ) const

virtual

Returns a value indicating what version of Mudbox this configuration was introduced in.

virtual const ClassDesc* OperationClass ( void  ) const

virtual

Returns the operation class belonging to the configuration.

virtual QString Category ( ) const

virtual

Returns the category title that groups configurations together.

virtual QString DisplayCategory ( ) const

virtual

Returns the category title that groups configurations together.

virtual void Serialize ( Stream &  s )

virtual

Serializes the configuration to the given stream.

virtual QString Icon ( void  )

virtual

Returns the icon file for the configuration.

---

The documentation for this class was generated from the following file:

• Mudbox/brush.h