OpenMaya.MFnPlugin Class Reference

Class Description

Register and deregister plug-in services with Maya.

Method resolution order:
-   MFnPlugin
-   MFnBase
-   __builtin__.object

---

Base Class

MFnBase

Constructors

Signature	Parameters	Description
Available in Maya 2012 Gold:
MFnPlugin()		Default constructor. Returns a new MFnPlugin function set with no Maya object attached.
MFnPlugin(plugin, vendor='Unknown', version='Unknown', apiVersion='Any')	plugin - MObject vendor - string version - string apiVersion - string	Attaches the function set to the specified plugin object, which is provided as a parameter to the plugin's initializePlugin() and uninitializePlugin() functions, and specifies an optional vendor name, plugin version string and minimal required Maya apiVersion (which is currently ignored).

 

---

Inheritance diagram for OpenMaya.MFnPlugin:

Public Member Functions
	__init__ ()
	deregisterAttributePatternFactory ()
	deregisterData ()
	deregisterDragAndDropBehavior ()
	deregisterNode ()
	registerAttributePatternFactory ()
	registerData ()
	registerDragAndDropBehavior ()
	registerNode ()
	registerShape ()
Public Member Functions inherited from OpenMaya.MFnBase
	__init__ ()
	hasObj ()
	object ()
	setObject ()
	type ()

Available in Maya 2012 Gold:
	version
	apiVersion ()
	deregisterCommand ()
	loadPath ()
	name ()
	registerCommand ()
	setName ()
	vendor ()

Constructor & Destructor Documentation

OpenMaya.MFnPlugin.__init__

(

)

x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMaya.MFnPlugin.apiVersion

(

)

Return the API version required by the plug-in.

Signature:	apiVersion()
Parameters:
Returns:	string
Description:	Return the API version required by the plug-in.

OpenMaya.MFnPlugin.deregisterAttributePatternFactory

(

)

Deregister a user defined attribute pattern factory type from Maya.

OpenMaya.MFnPlugin.deregisterCommand

(

)

Deregister a user defined command from Maya.

Signature:	deregisterCommand(cmdName)
Parameters:	cmdName - string
Returns:	Reference to self.
Description:	Deregister a user defined command from Maya.

OpenMaya.MFnPlugin.deregisterData

(

)

Deregister a user defined data type from Maya.

OpenMaya.MFnPlugin.deregisterDragAndDropBehavior

(

)

Deregister a user defined drag and drop behavior from Maya.

OpenMaya.MFnPlugin.deregisterNode

(

)

Deregister a user defined dependency node from Maya.

OpenMaya.MFnPlugin.loadPath

(

)

Return the full path name of the file from which the plug-in was loaded.

Signature:	loadPath()
Parameters:
Returns:	string
Description:	Return the full path name of the file from which the plug-in was loaded.

OpenMaya.MFnPlugin.name

(

)

Return the plug-in's name.

Signature:	name()
Parameters:
Returns:	string
Description:	Return the plug-in's name.

OpenMaya.MFnPlugin.registerAttributePatternFactory

(

)

Register a new attribute pattern factory type with Maya.

OpenMaya.MFnPlugin.registerCommand

(

)

Register a new command with Maya.

Signature:	registerCommand(cmdName, createCmdFunc, createSyntaxFunc=None)
Parameters:	cmdName - string createCmdFunc - Python callable createSyntaxFunc - Python callable
Returns:
Description:	Register a new command with Maya. createCmdFunc is a Python callable which takes no arguments and returns a new instance of the MPxCommand-derived class. createSyntaxFunc is a Python callable which takes no arguments and returns an MSyntax object initialized with the command's syntax.

OpenMaya.MFnPlugin.registerData

(

)

Register a new data type with Maya.

OpenMaya.MFnPlugin.registerDragAndDropBehavior

(

)

Register a new drag and drop behavior with Maya.
Once registered, the new behavior can be used to finish connections between node drag and drops from the hyperGraph/hyperShade to other nodes or Maya UI.

OpenMaya.MFnPlugin.registerNode

(

)

Register a new dependency node with Maya.

OpenMaya.MFnPlugin.registerShape

(

)

Register a new user defined shape node with Maya.
To deregister the shape node use the MFnPlugin.deregisterNode().

OpenMaya.MFnPlugin.setName

(

)

Set the plug-in's name.

Signature:	setName(name, makeUnique=True)
Parameters:	name - string makeUnique - bool
Returns:	Reference to self.
Description:	Set the plug-in's name. If another plug-in is already using name and makeUnique is True then Maya will choose a unique name for the plug-in, otherwise a RuntimeError will be raised.

OpenMaya.MFnPlugin.vendor

(

)

Return the plug-in's vendor string.

Signature:	vendor()
Parameters:
Returns:	string
Description:	Return the plug-in's vendor string.

Property Documentation

OpenMaya.MFnPlugin.version

static

 Plug-in version string.

Name:	version
Type:	string
Access:	RW
Description:	Plug-in version string.