Maya插件（三）自定义Locator的实现

 前沿

首先介绍一下什么是Locator，运行Maya, 选择菜单Create --> Locator, 我们将看到如下界面：

Locator是属于shape可以被绘制，在Maya中任何一个shape的位置、缩放、旋转是通过它的父节点Transform实现的，但是Locator有自己的local Postion和Local Scale（参考右边的属性编辑界面）。

 

MyLocator的实现

自定义的Locator需要从MPxLocator继承。看如下类定义:

#ifndef __MYLOCATOR_H__ #define __MYLOCATOR_H__ #ifdef WIN32 #ifndef NT_PLUGIN #define NT_PLUGIN #endif #endif #include <maya/MIOStream.h> #include <maya/MGlobal.h> #include <maya/MObject.h> #include <maya/MArgList.h> #include <maya/M3dView.h> #include <maya/MFnDagNode.h> #include <maya/MPxLocatorNode.h> #include <maya/MFnDependencyNode.h> #include <maya/MItDependencyNodes.h> /// MyLocator class MyLocator : public MPxLocatorNode { public: MyLocator(); virtual ~MyLocator(); /// /brief /// 绘制自己 virtual void draw(M3dView &view, const MDagPath &dagPath, M3dView::DisplayStyle style, M3dView::DisplayStatus status); /// /brief /// 是否有包围盒 virtual bool isBounded() const; /// /brief /// 返回包围盒 virtual MBoundingBox boundingBox() const; /// /brief /// 初始化, 用于创建结点属性 static MStatus initialize(); /// /brief /// 创建该结点对象, 向Maya提供接口 static void *creator(); /// /brief /// Node ID, 用于标识该类, 在Maya二进制文件中会使用之 static const MTypeId m_typeId; /// /brief /// Node Type Name, 相当于类名称 static const MString m_typeName; /// /brief /// The following is the name of attribute static MObject m_size; static MObject m_height; }; #endif /// __MYALOCATOR_H__ 

这里重载了函数：

1. draw，  用于绘制MyLocator, 由Maya调用；

2. isBounded， 告诉Maya，该shape有包围盒；

3. boundingBox，返回包围盒，用于选择检测。

 

 

static const MTypeId m_typeId;  // Node ID, 用于标识该类, 在Maya二进制文件中会使用之.

static const MString m_typeName; // Node Type Name, 相当于类名称.

 

static MObject m_size;         // 自定义的属性, 表示Locator的底部正方形的边长

static MObject m_height;     // 自定义的属性, 表示Locator的高度

 

MyLocator的实现如下：

#include "MyLocator.h" #include <maya/MIOStream.h> #include <maya/MColor.h> #include <maya/MDistance.h> #include <maya/MFnUnitAttribute.h> #include <iostream> #ifdef WIN32 #pragma comment(lib, "opengl32.lib") #endif /// Maya留给自定义的ID空间是[0x00000, 0x7FFFF] const MTypeId MyLocator::m_typeId = 0x10000; const MString MyLocator::m_typeName = "MyLocator"; MObject MyLocator::m_size; MObject MyLocator::m_height; MyLocator::MyLocator() { std::cout << "MyLocator() construction" << std::endl; } MyLocator::~MyLocator() { std::cout << "~MyLocator() destruction" << std::endl; } /// /brief /// 绘制自己 void MyLocator::draw(M3dView &view, const MDagPath &dagPath, M3dView::DisplayStyle style, M3dView::DisplayStatus status) { std::cout << "MyLocator::draw()" << std::endl; MColor col = colorRGB(status); float size = 1.0f, height = 1.0f; MFnDagNode fnDag(thisMObject()); MPlug sizePlug = fnDag.findPlug(m_size); MPlug heightPlug = fnDag.findPlug(m_height); sizePlug.getValue(size); heightPlug.getValue(height); view.beginGL(); glPushAttrib(GL_CURRENT_BIT); /// draw a line glColor3f(1,0,0); glBegin(GL_LINES); glVertex3f(0.0f, -0.5f * height, 0.0f); glVertex3f(0.0f, 0.5f * height, 0.0f); glEnd(); glEnable(GL_BLEND); glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA); if (status == M3dView::kLead) glColor4f(0, 1, 0, 0.3f); else glColor4f(col.r, col.g, col.b, 0.3f); glBegin(GL_QUADS); glVertex3f(-0.5f * size, 0.0f, -0.5f * size); glVertex3f( 0.5f * size, 0.0f, -0.5f * size); glVertex3f( 0.5f * size, 0.0f, 0.5f * size); glVertex3f(-0.5f * size, 0.0f, 0.5f * size); glEnd(); /// 恢复属性 glPopAttrib(); view.endGL(); } /// /brief /// 是否有包围盒 bool MyLocator::isBounded() const { return true; } /// /brief /// 返回包围盒 MBoundingBox MyLocator::boundingBox() const { MBoundingBox bbox; float size = 1.0f, height = 1.0f; MFnDagNode fnDag(thisMObject()); MPlug sizePlug = fnDag.findPlug(m_size); MPlug heightPlug = fnDag.findPlug(m_height); #if 1 if (sizePlug.isNetworked()) { std::cout << "sizePlug is Networked" << std::endl; } else { std::cout << "sizePlug is Non-Networked" << std::endl; } if (heightPlug.isNetworked()) { std::cout << "heightPlug is Networked" << std::endl; } else { std::cout << "heightPlug is Non-Networkde" << std::endl; } #endif sizePlug.getValue(size); heightPlug.getValue(height); bbox.expand(MPoint(-0.5f * size, 0.0f, -0.5f * size)); bbox.expand(MPoint( 0.5f * size, 0.0f, -0.5f * size)); bbox.expand(MPoint( 0.5f * size, 0.0f, 0.5f * size)); bbox.expand(MPoint(-0.5f * size, 0.0f, 0.5f * size)); bbox.expand(MPoint( 0.0f,-0.5f * height, 0.0f)); bbox.expand(MPoint( 0.0f, 0.5f * height, 0.0f)); return bbox; } /// /brief /// 初始化, 用于创建结点属性 MStatus MyLocator::initialize() { MFnUnitAttribute fn; MStatus stat; /// 创建一个Attribute, 全名size, 简写sz, 类型为kDistance m_size = fn.create("size", "sz", MFnUnitAttribute::kDistance); /// set a default value of 1 for the size fn.setDefault(MDistance(1.0, MDistance::uiUnit())); fn.setKeyable(true); /// set a minim value for the attribute fn.setMin(0.1f); /// 添加到该Node stat = addAttribute(m_size); /// check for error if(stat != MS::kSuccess) { stat.perror("Unable to attach size attribute to the locator node"); return stat; } /// 创建一个Attribute, 全名height, 简写h, 类型kDistance m_height = fn.create("height", "h", MFnUnitAttribute::kDistance); fn.setDefault(MDistance(1.0, MDistance::uiUnit())); fn.setKeyable(true); fn.setMin(0.1f); /// 添加到该Node stat = addAttribute( m_height ); /// check for error if( stat != MS::kSuccess ) { stat.perror("Unable to attach height attribute to the locator node"); return stat; } std::cout << "MyLocator::initialize()" << std::endl; return MS::kSuccess; } /// /brief /// 创建该结点对象, 向Maya提供接口 void *MyLocator::creator() { std::cout << "MyLocator::creator()" << std::endl; return new MyLocator(); } 

initialize() 函数在插件被加载时被调用，它告知Maya，MyLocator新增了2个新属性，相当于MyLocator类新增加了2个成员变量（以动态的形式），例如：m_height = fn.create("height", "h", MFnUnitAttribute::kDistance); 创建了一个名字叫height、类型是kDistance的属性，但是这并不表示它的Value保存在m_height中，我们可认为m_height是个变量句柄，以后的文章中将谈到Value保存在DataBlock中。oh.... 这让我想起了Java，句柄+实际的内存块。

 

DLL的导出函数

同前面的插件一样，同样是在导出函数中进行注册，不过这里我们要注册的是Node.

#include "MyLocator.h" #include <maya/MIOStream.h> #include <maya/MFnPlugin.h> #include <iostream> #ifdef WIN32 #define MLL_EXPORT __declspec(dllexport) #else #define MLL_EXPORT #endif /// /brief /// initialize plugin /// /param /// obj (in) the plugin handle /// /ret /// return MS::kSuccess if OK. /// /NOTE: /// invoked only once by Maya when DLL is loaded. MLL_EXPORT MStatus initializePlugin(MObject obj) { MFnPlugin plugin(obj, "Jett Huang", "1.0", "Any"); /// register the command MStatus status = plugin.registerNode(MyLocator::m_typeName, MyLocator::m_typeId, MyLocator::creator, MyLocator::initialize, MPxNode::kLocatorNode); if (!status) { status.perror("Failed to register MyLocator/n"); } else { std::cout << "initializePlugin" << std::endl; } return status; } /// /brief /// unintializePlugin /// /param /// obj (in) the plugin handle to un-register /// /ret /// MS::kSuccess if OK. MLL_EXPORT MStatus uninitializePlugin(MObject obj) { MFnPlugin plugin(obj); /// deregister the PxCommand MStatus status = plugin.deregisterNode(MyLocator::m_typeId); if (!status) { status.perror("failed to deregister MyLocator/n"); } else { std::cout << "uninitializePlugin" << std::endl; } return status; } 

注册函数

 

    MStatus status = plugin.registerNode(MyLocator::m_typeName,

                                         MyLocator::m_typeId,             // 自定义的Node Id

                                         MyLocator::creator,                 // 创建MyLocator对象 

                                         MyLocator::initialize,               // 注册时被调用，动态完成MyLocator的扩充

                                         MPxNode::kLocatorNode);      // 该Node是个Locator Node.

 

 

OK! 编译运行，并加载MyLocator.Mll，在Mel命令行中输入

createNode "MyLocator"     按Enter键后，我们会看到如下内容：

 

如果此时设置Locator Attributes是没用的，因为在draw()中，压根就没被使用！

 

加入自定义的Attribute Editor界面

咦，怎么不见右边的编辑窗口中有 height 和 size的编辑呢，那时因为我们没有加入界面，下面要加入一个Attribule Editor Template, 用于加入自定义的属性。 我们的脚本文件名为AEMyLocatorTemplate.MLL,  名字是由 AE + 自定义节点名 + Template.MLL,  放在Maya用户目录的scripts下面。 当我们选择自定义节点时，该脚本将会自动执行！

global proc AEMyLocatorTemplate ( string $nodeName ) { print("DEBUG: AEMyLocatorTemplate is Invokded: " + $nodeName); editorTemplate -beginScrollLayout; // 加入我们的属性编辑控件 editorTemplate -beginLayout "MyLocator Size" -collapse 0; editorTemplate -addControl "size"; editorTemplate -addControl "height"; editorTemplate -endLayout; // 标准的Locator编辑控件 editorTemplate -beginLayout "Locator Attributes" -collapse 1; AElocatorCommon $nodeName; editorTemplate -endLayout; AElocatorInclude $nodeName; // This will add the standard UI controls for the node editorTemplate -addExtraControls; editorTemplate -endScrollLayout; } 

OK，当我们选择自定义的MyLocator时，将出现编辑界面如下：

 

 

查看对象的生存

OuputWindow的显示如下：

 

MyLocator::initialize()

initializePlugin

MyLocator::creator()

MyLocator() construction

sizePlug is Non-Networked

heightPlug is Non-Networkde

MyLocator::draw()

 

 

选择菜单File -->NewScene, 看到MyLocator对象被销毁

~MyLocator() destruction

 

实例代码vs2005 URL: http://download.csdn.net/source/2702834