MFnToolContext Class Reference

#include <MFnToolContext.h>

Class Description

Tool context function set.

MFnToolContext is the function set that is used for querying tool contexts.

Typically this could be used in conjunction with MGlobal::currentToolContext().

Inheritance diagram for MFnToolContext:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...
virtual	~MFnToolContext ()
	Destructor.
	MFnToolContext ()
	Default constructor.
	MFnToolContext (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...
MString	name (MStatus *=NULL) const
	Returns the tool context's name. More...
MString	title (MStatus *=NULL) const
	Returns the tool context's title. More...
	MFnToolContext (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...
Public Member Functions inherited from MFnBase
virtual	~MFnBase ()
	Class Destructor. More...
bool	hasObj (MFn::Type) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
bool	hasObj (const MObject &) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
MObject	object (MStatus *ReturnStatus=NULL) const
	Returns the MObject that is attached to the Function Set. More...
virtual MStatus	setObject (MObject &object)
	Attaches the Function Set to the specified Maya Object. More...
virtual MStatus	setObject (const MObject &object)
	NO SCRIPT SUPPORT. More...

Protected Member Functions
virtual const char *	className () const
	Class name. More...

Additional Inherited Members
Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

Constructor & Destructor Documentation

MFnToolContext	(	MObject &	object,
		MStatus *	ReturnStatus = NULL
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

• MS::kSuccess if the function set is successfully attached
• MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnToolContext	(	const MObject &	object,
		MStatus *	ReturnStatus = NULL
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

• MS::kSuccess if the function set is successfully attached
• MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

Member Function Documentation

MFn::Type type ( ) const

virtual

Function set type.

Return the class type : MFn::kToolContext.

Reimplemented from MFnBase.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnToolContext".

MString name

(

MStatus *

ReturnStatus = NULL

)

const

Returns the tool context's name.

Parameters

[out]

ReturnStatus

return status

Returns

Name string

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid tool context

MString title

(

MStatus *

ReturnStatus = NULL

)

const

Returns the tool context's title.

Parameters

[out]

ReturnStatus

return status

Returns

Title string

Status Codes:

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid tool context

---

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

• MFnToolContext.h
• MFnToolContext.cpp