Maya plugin helpers
Provides a simplified setup for Maya API2 plugins.
For very simple commands you can import a decorator which declares and registers a plugin, so a plugin can be as simple as:
from plugger import initializePlugin2, uninitializePlugin2, CommandPlugin
@CommandPlugin('hello_world')
def do_something(args):
print "Hello Word"
This would create a basic MPXPluginCommand object and correctly register it as the hello_world() command. There's also and undoable version, which works the same way. If your function returns an MDGModifier or MDagModifier it becomes undoable:
from plugger import initializePlugin2, uninitializePlugin2, UndoableCommandPlugin
@UndoableCommandPlugin('cube')
def do_something(args):
mod = MDagModifier()
mod.createNode('polyCube')
mod.doIt()
return mod
By default, maya plugins need to expose two static methods initializePlugin2() and uninitializePlugin2(), which need to be able to convert an incoming MObject to an MFnPlugin and register or un-register it. Most of the time there is nothing interesting going on in these methods and they are pure boilerplate. Plugger uses the PluginMeta metaclass to automatically register and unregister plugins for you: you only need to import initializePlugin2 and uninitializePlugin2 from plugger and use the metaclass - or you can derive your own plugin from CommandBase:
from plugger import initializePlugin2, uninitializePlugin2, CommandBase
class AutoRegisteredPlugin(CommandBase):
def doIt(args):
print "executed"