Maya命令型插件

一 基础概念

这里主要介绍用Maya C++ API进行插件开发的一些基本概念。

1 对象类型

Maya API包含了四种类型的对象：Wrappers，Objects，Function Sets以及Proxies，这四种对象构成了Maya API所有内容。

<1> Wrappers

Wrapper是API提供的一个基础性的类，它包含了一些基础数据类，实用的工具类以及迭代器。数据类包括array，vector，matrix，quaternion等，实用工具类包含selection lists，DAG paths，viewports等。这两种类型的以”M”为前缀，如MIntArray,MFloatArray，MSelectionList等。

Wrapper包含的迭代器，用于遍历数据序列，API中提供了用于遍历maya依赖图、网格顶点、变、面、法线等的迭代器，以”MIt”开头，如有MItMesh，MITDependencyGraph等。

<2> Objects

这里的对象指的是maya里面的对象，例如曲线、DAG节点、光照、IK解算器等，maya里面所有对象都派生自类MObject，这种设计方式允许maya中许多不同派生自MOject的类型可以在API中方便传递。每个MObject的实例代表一个节点或者节点上的属性，但是需要注意的MObject并是就是这个节点或属性，而仅仅是这个节点或属性的句柄。这使得Maya可以保持节点和属性的所有权，保证maya顺畅运行。由于MObject仅仅是maya内部对象的一个句柄，而这个对象可以在运行过程中被maya移除，所以在插件的函数调用中不能依赖于MObject，因为它可能在某个时刻已经是失效的句柄。要获取MObject引用的节点的功能，应该使用Function Set。

<3> Function Sets

MAYA中真正的对象又种类繁多，那么要将功能性的接口写到MObject中显然是不现实的，但是又是需要的（由于API中进行对象句柄的获取或传递的类型一般都是MObject），所以就有了Maya中的Fuction Set类。

代码示例如下：

if ( obj.hasFn( MFn::kMesh ) )

{

    MFnMesh fnMesh( obj );

}

首先通过在MObject对象上判断其是否支持某种功能，如果支持的话，就用该句柄对象来初始化功能集对象，然后就可以使用该功能集对象进行各种操作了。

功能集的类以”MFn”为前缀

<4> Proxies

Proxy类是用于创建一些DG节点，变形器，IK解算器等等新的maya对象的基类（定义了一些虚函数形式的接口）。创建的新类型的类必须实现基类的所需的接口。

该类型的类以”MPx”为前缀

2 错误校验

API中的错误校验一般使用MStaus类来完成，大多数的API都接受该类对象作为参数或返回该类型的值，可以通过查询该类型变量的值来判断是否有错误发生。

通常使用status.error()来检查，如果为真，则有错误发生。API也提供了两个宏

CHECK_MSTATUS( status );//有错则返回真

CHECK_MSTATUS_AND_RETURN_IT( status );//有错则返回

3 插件类型

Maya中的插件类型大体分为两种，一种是命令型插件，另一种是依赖图插件。命令插件的调用方式是通过调用插件的注册接口，而依赖图插件则更复杂得多，它作为maya依赖图里面的一个节点，对输入进行计算产生输出并将输出传递后方的节点。

二 命令插件

命令型插件的开发是通过编写一个派生自MPxCommand的Proxy类，然后将该类的调用接口注册到maya，最后在maya中通过调用该接口即可实现该插件的调用。

每一个派生自MPxCommand的类至少必须实现doIt接口，然后根据需要可选择实现undoIt,redoIt。doIt接口必须搜集用于完成该插件工作的所有数据，然后将它们存放到类成员中。

插件类示例：

//HelloWorldCmd.h

#ifndef HELLOWORLD_H

#define HELLOWORLD_H

 

#include <maya/MArgList.h>

#include <maya/MObject.h>

#include <maya/MGlobal.h>

#include <maya/MPxCommand.h>

 

class HelloWorld : public MPxCommand

{

public:

                    HelloWorld() {};

    virtual MStatus doIt( const MArgList& );

    static  void*   creator();

};

#endif

//HelloWorldCmd.cpp

#include "include/HelloWorldCmd.h"

#include <maya/MFnPlugin.h>

 

void* HelloWorld::creator() {   return new HelloWorld; }

MStatus HelloWorld::doIt( const MArgList& argList )

{

    MGlobal::displayInfo( "Hello World!" );

    return MS::kSuccess;

}

注册插件调用接口

//HelloWorldCmd.cpp

MStatus initializePlugin( MObject obj )

{

    MFnPlugin plugin( obj, "Chad Vernon", "1.0", "Any");

    MStatus status = plugin.registerCommand( "helloWorld", HelloWorld::creator );

    CHECK_MSTATUS_AND_RETURN_IT( status );

    return status;

}

 

MStatus uninitializePlugin( MObject obj )

{

    MFnPlugin plugin( obj );

    MStatus status = plugin.deregisterCommand( "helloWorld" );

    CHECK_MSTATUS_AND_RETURN_IT( status );

    return status;

}

VS工程项目配置

1. 配置好include和lib
2. C++预处理器定义：WIN32;NDEBUG;_WINDOWS;NT_PLUGIN;REQUIRE_IOSTREAM;
3. 链接器输入：OpenMaya.lib OpenMayaAnim.lib Foundation.lib
4. 链接器--->命令行|附加选项:/export:initializePlugin /export:uninitializePlugin 

python下调用该插件

import maya.cmds as cmds

cmds.helloWorld()

MEL下调用该插件:首先在插件管理器中加载该插件，然后在使用如下MEL代码

helloWorld;