飘零风雨亭: 插件编程

The Pipeline and the INode TM Methods

Mon, 30 Oct 2006 03:29:41 GMT

备忘

http://sparks.discreet.com/knowledgebase/sdkdocs_v8/prog/main/sdk_pipe_the_pipeline_and_the_inode_tm_methods.html

The Pipeline and the INode TM Methods

This section discusses the INode methods GetObjectTM(), GetObjTMBeforeWSM() and GetObjTMAfterWSM() and their relationship to the pipeline.

The INode::GetObjectTM(...) method returns a matrix that is used to transform the points of the object from object space to world space. Let's look at an example of how this method is used. Consider how the cylinder node is drawn in the scene. The cylinder draws itself in its BaseObject::Display() method. Into this method is passed an INode pointer. What the implementation of Display()does is call INode::GetObjectTM(). This method returns the matrix that is used to transform the points of the object from object space to world space. The Display() method then takes the matrix returned from GetObjectTM() and sets it into the graphics window (using GraphicsWindow::setTransform()). In this way, when the object starts drawing points in object space, they will be transformed with this matrix. This puts them into world space as they are drawn.

Below is the code from the SimpleObject implementation of BaseObject::Display(). This is the code that the cylinder uses to draw itself. Note the GetObjectTM(t) and setTransform(mat) calls.

int SimpleObject::Display(TimeValue t,

INode* inode,

ViewExp *vpt,

int flags)

{

if (!OKtoDisplay(t)) return 0;

GraphicsWindow *gw = vpt->getGW();

Matrix3 mat = inode->GetObjectTM(t);

UpdateMesh(t); // UpdateMesh just calls BuildMesh() if req'd at time t.

gw->setTransform(mat);

mesh.render( gw, inode->Mtls(),

(flags&USE_DAMAGE_RECT) ? &vpt->GetDammageRect() : NULL, COMP_ALL,

inode->NumMtls());

return(0);

}

There is a case when world space modifiers are applied to an object where the points of the object may have already been transformed into world space. If a world space modifier has been applied, the points of the object may have already been transformed into world space and then deformed by the world space modifier. With the bent, rippled, cylinder example above, this is exactly what has happened. When the ripple space warp was applied, the points of the object were transformed into world space. In this case, the points should not be transformed into world space again when they are drawn (since they were already by the space warp). The problem is, the object does not know if it has been transformed into world space or not.

The way 3ds Max handles this situation is by storing some state information with the node. Before the system calls Display(), HitTest(), etc. on the object it sets a flag. The flag indicates if the object has already been transformed into world space. The GetObjectTM() method looks at this flag to determine the proper matrix to return. In this way, when GetObjectTM() is called, it returns the matrix the object needs to be multiplied by in order to get into world space. If the object is already in world space it will return the identity matrix. If it's not in world space, it will return the matrix to get it there. So all any objects need to do in their Display() methods is call GetObjectTM() and use whatever matrix is returned.

There may be times when a developer needs to access the full object TM regardless of whether the points of the object have been transformed into world space already. For example, if a developer was creating a utility plugin to align two objects. In this case, the developer would need to get the full object TM including the NodeTM and the object offset transformation. It would not matter if the points of the object had already been transformed into world space, the TM is what matters. In this case GetObjectTM() would not work. This is because it returns the identity matrix if the object is already in world space.

To solve this problem 3ds Max provides two other INode methods that may be used.

GetObjTMBeforeWSM()

This method explicitly gets the full NodeTM and object-offset transformation affect before the affect of any world space modifiers.

GetObjTMAfterWSM().

This method explicitly gets the full NodeTM and object-offset transformation and world space modifier affect unless the points of the object have already been transformed into world space in which case it will return the identity matrix.

Example
Using these methods a developer has complete access to any transformation matrix they require. Below is a code example that uses all these methods. This function computes the bounding box of the first object in the current selection set at the current time. It removes anything but scaling from the Object TM. In this way rotation of the node will not affect the bounding box.

To do this we first need to determine if the object is in world space or in object space. Since we are after the object space bounding box (and will later apply scaling) we need to convert the TM back into object space if it is in world space. To check if the object is in world space we call GetObjTMAfterWSM(). If this matrix is the identity we know we are in world space. This is because when the points of the object get transformed by the ObjectState TM to put them into world space the ObjectState TM is set to the identity. Therefore if the matrix is the identity we are in world space.

If the object is in world space we need to compute the object space TM. We can do this by taking the inverse of the world space TM.

If the object is not in world space we just need to get its object TM by calling GetObjectTM().

Once we have the object space TM we want to extract just the scaling portion of the matrix. 3ds Max provides a set of APIs that make this easy. This is done by calling decomp_affine(). This function decomposes a matrix into its translation, rotation and scaling components. See Structure AffineParts for more details.

Once we have the scaling portion of the matrix we can get the bounding box and apply the scaling by calling GetDeformBBox().

void Utility::ComputeBBox(Interface *ip)

{

if (ip->GetSelNodeCount())

{

INode *node = ip->GetSelNode(0);

Box3 box; // The computed box

Matrix3 mat; // The Object TM

Matrix3 sclMat(1); // This will be used to apply the scaling

// Get the result of the pipeline at the current time

TimeValue t = ip->GetTime();

Object *obj = node->EvalWorldState(t).obj;

// Determine if the object is in world space or object space

// so we can get the correct TM. We can check this by getting

// the Object TM after the world space modifiers have been

// applied. It the matrix returned is the identity matrix the

// points of the object have been transformed into world space.

if (node->GetObjTMAfterWSM(t).IsIdentity())

{

// It's in world space, so put it back into object

// space. We can do this by computing the inverse

// of the matrix returned before any world space

// modifiers were applied.

mat = Inverse(node->GetObjTMBeforeWSM(t));

}

else

{

// It's in object space, get the Object TM.

mat = node->GetObjectTM(t);

}

// Extract just the scaling part from the TM

AffineParts parts;

decomp_affine(mat, &parts);

ApplyScaling(sclMat, ScaleValue(parts.k*parts.f, parts.u));

// Get the bound box, and affect it by just

// the scaling portion

obj->GetDeformBBox(t, box, &sclMat);

// Show the size and frame number

float sx = box.pmax.x-box.pmin.x;

float sy = box.pmax.y-box.pmin.y;

float sz = box.pmax.z-box.pmin.z;

TSTR title;

title.printf(_T("Result at frame %d"), t/GetTicksPerFrame());

TSTR buf;

buf.printf(_T("The size is: (%.1f, %.1f, %.1f)"), sx, sy, sz);

MessageBox(NULL, buf, title, MB_ICONINFORMATION|MB_OK);

}

maya插件说明(以helixTool.mll为例):

Sat, 25 Mar 2006 10:05:46 GMT

maya插件说明(以helixTool.mll为例):

flipcode@msn.com

一。装入插件helixTool.mll时:
    创建上下文件命令对象(helixContextCmd):
MStatus initializePlugin( MObject obj ){
  status = plugin.registerContextCommand("helixToolContext",
              _ helixContextCmd::creator,
             | "helixToolCmd",
             | helixTool::creator,
             | helixTool::newSyntax);
             |
             |__
              　　这里回调用helixContextCmd::creator(){ return new helixContextCmd;}
}

二。装入helixTool.mel内容:
1.创建工具上下文helixToolContext1对象:
helixToolContext helixToolContext1;
   1) helixContextCmd::appendSyntax()映射参数类型.
      如: mySyntax = syntax();
          mySyntax.addFlag("ncv","numCVs", kUnsigned) // (shortName,longName, kType)
   2) helixContextCmd::makeObj()创建helixContext.
      如:
      fHelixContext = new helixContext();
          return fHelixContext;
   3) 调用helixContextCmd::doEditFlags()分释参数字串设给fHelixContext

   4) 调用helixContextCmd::doQueryFlags()获取fHelixContext的参数值刷新UI

2.创建helixtTool图标，关联上helixToolContext1
setParent Shelf1;
toolButton -doubleClickCommand "toolPropertyWindow" // 双击进入属性框
    -cl toolCluster       // collection
    -t helixToolContext1 // tool 关联到 helixToolContext1
    -i1 "helixTool.xpm"   // icon
    helixTool1;           // name

三。点击helixtTool图标:
    1). 这时helixtTool图标关联的helixToolContext1变成当前context,
    2). 调用helixContext::toolOnSetup(MEvent &)，可在其中设置要显示的帮助字符。
    3). 开始接收鼠标事件的触发，如doPress(MEvent &event)等

四。视图交互:
    1). 当鼠标点击视图时,调用helixContext::doPress(..){...}
    2). 当鼠标松开时,调用helixContext::doRelease(..){...}

五。helixtTool的产生:
    一般会是在视图中按下的鼠标松开时在helixContext::doRelease(..)函数中
1. helixTool * cmd = (helixTool*)newToolCommand();
2. cmd->setPitch( height/numCV ); // 给产生后的tool设参数
    // cmd->setNumCVs( numCV ); 等等
3. cmd->redoIt();                 // 执行操作
4. cmd->finalize();               // 告知结束。在finalize()会将参数内容打包回传给UI右边属性框进行刷新

    说明: 在1.中分两步:
    1.) 产生前先回调进行参数类型映射:
    MSyntax helixTool::newSyntax()
    {
     MSyntax syntax;
  syntax.addFlag(kPitchFlag, kPitchFlagLong, MSyntax::kDouble);
  syntax.addFlag(kRadiusFlag, kRadiusFlagLong, MSyntax::kDouble);
  // ...
  return syntax;
    }
    2.) 再回调注册的静态创建函数来产生:
    static void* helixTool::creator(){ return new helixTool; }

六。与右边UI(操作参数框)的互动:
在脚本编辑器中source以下两文件
helixProperties.mel
helixValues.mel
1. 双击helixTool图标，右边UI出现helixContextCmd的操作参数框
系统回调了helixContextCmd::doQueryFlags()来获取fHelixContext的参数值UI参数框

    2. 当拖动numCvs拖动改变numCVs个数时,
    a.系统调用helixContextCmd::doEditFlags()分释参数字串设给fHelixContext
   b.系统回调了helixContextCmd::doQueryFlags()来获取fHelixContext的参数值UI参数框

    3.命令参数操作
    a.查询参数: helixToolContext -q -numCVs helixToolContext1
    b.修改参数: helixToolContext -e -numCVs 32 helixToolContext1

3dsMax7数据导出方法及存在问题 (转)

Tue, 21 Feb 2006 05:33:19 GMT

3dsMax7数据导出方法及存在问题 (转)

来源:

http://blog.csdn.net/csdn_gamedev/archive/2005/12/12/550173.aspx
关键字：3D 3dsmax7 插件 maxscript 3dmaxSDK 游戏开发

作者：卢立祎来自：愤怒的犬夜叉

　　在游戏开发过程中需要大量的模型数据来描述人物、建筑、场景，如果开发编辑器来编辑网格、顶点，代价太大，因此往往利用一些现成的3D建模软件来代替。

　　使用 3dsMax7 进行模型、动画数据导出是3D引擎开发过程中的一个必然环节（或者使用Maya等类似的3D建模工具）。然而discreet公司在指导用户进行二次开发的方面做得并不是太好，有一些问题是在开发过程中会常常遇到。

　　美术工作人员在3dsMax环境中编辑好了三维人物或物体，加入了动作动画，指定了渲染方式，编辑了贴图和UV坐标之后，我们就必须想方设法把这类数据从编辑环境中导出成文件以供引擎使用。一般来说，最主要有三种方式来取得需要的数据：

1. 利用已有的导出格式取得数据

2. 制作max的export插件输出数据

3. 编写maxscript输出数据

利用已有的导出格式取得数据
　　使用3ds文件和xml文件作为导出源文件，然后直接在引擎中读取数据转化为自己定义的数据格式。一般来说会使用一些转换工具转换为更加高效的文件格式。比如在早期的MS DirectX SDK 中，就有一个convert3DS 的工具，把3ds格式的文件转换为D3DX使用的X文件。由于这种方式受到源文件信息固定的限制，渐渐的不被采用。DirectX SDK 也开始使用插件的方式导出数据。

　　Max7中，在菜单文件中选择导出，可以看到“IGame Exporter”，可以导出XML格式的文本文件，由于现在解析XML文件已经非常简单，甚至可以用序列化直接映射到数据结构，因此此方法有一定的使用价值。

制作max的export插件输出数据
　　使用maxSDK进行插件开发是大家普遍采用的方法，网上也可以查到相关的很多资料。在3dsmax7的目录中，可以找到maxsdk的目录，其中的help目录可以找到一些使用和开发帮助：

1. Sdk.chm

　　SDK的帮助文件。版本为6。个人感觉无论从整体结构还是编排都很糟糕，很难再非常快的时间内找到你想要的资料。

　　如果要使用CS（Character Studio）的功能，就必须包含Include\CS目录下的头文件，以前max版本必须先安装CS的SDK才可以使用此功能，在max7中，CS已经成为了max的一个标准组件，因此CS SDK的部分也已经在max SDK中包含。

　　Max7包含的CS的版本号为4.2。

2. IGameHelp.chm

　　Discreet提供了一套IGame的接口用来导出一般游戏制作需要导出的数据。“IGame Exporter”就是使用了此接口。可以在maxsdk\samples目录下找到这个插件的源代码。

　　DirectX9提供的max插件也是使用了IGame接口导出数据，可以在DirectX SDK中的\Utilities\Source\Max找到此插件的源代码以供参考。

　　IGameHelp.chm是使用Doxygen(http://www.doxygen.org/)自动生成的文档文件，因此使用和查找习惯于Doxygen通用生成格式相同。

　　其中的IGameSkin已经自动包含了Skin和Physique两种Modifier，无须分别写两套处理代码。

　　Max7自带的IGameInterface版本号为1.121。

3. sparks_archive.chm

　　sparks是max的一个讨论站点，在里面可以找到很多你需要的问题的答案，sparks_archive.chm可以自动更新到最新，但是我从来没有更新成功过。

　　此外，max7依旧提供了一套Ravi K Karra编写的VC6的3ds max Plugin Wizard，可以自动生成所需要的插件框架，很可惜，版本还是R5，搭配max7的SDK会有一些小问题。把文件\MAXSDK\HELP\SDKAPWZ.ZIP拷贝到VistualStudio的模版目录中（比如：\Microsoft Visual Studio\Common\MSDev98\Template），解压缩zip文件，VC6的新建模版中就会出现max Plugin Wizard这一项。

　　如果要在VC6上编译max7的插件，还需要对一个头文件作一点小小的修改：在文件include\istdplug.h文件的第1685行：

typedef struct { 改为： typedef struct Options{

1708行：

class Options2: public Options 改为：class Options2: public IAssignVertexColors::Options

　　这都是因为VC6编译器无法对匿名结构进行继承。

　　当然，也可以选择使用VC7\7.1进行Plug编写。可以在 http://sparks.discreet.com/downloads/downloadshome.cfm?f=2&wf_id=134 下载到3ds max 6 and 7 Plugin Wizard for Visual Studio 7。

　　使用插件导出数据有一个很大的弊端：在插件编写调试过程中，经常要重新重新启动max，浪费了不少时间，这一点无法与maxscript相比。

编写maxscript输出数据
　　使用maxscript进行数据输出是现在我手头项目的使用方法，使用简单、调试方便，每次有了改动不用重新启动3ds max。可以在帮助菜单内找到MAXScript Reference 7.0。maxscript可以操作max编辑环境内的所有的对象，并且可以通过plugin来增加功能与接口（插件的gup类型）。Max还内置了一个脚本编辑器，有语法高亮功能（到处是Bug!），建议使用EditPlus等文本编辑软件来编写脚本，并且可以在http://www.editplus.com/files/maxscript.zip 下载到最新的EditPlus的maxscript语法高亮配置文件。

　　Max7内置的Visual MaxScirpt编辑器可以方便的编辑界面，所见即所得，很方便，但是附带的方法编辑器同样非常难用，建议使用外部编辑。

　　如果需要导出Character Studio数据，需要注意一些问题。

　　Character Studio包含Biped、Physique和群组三个组件，一般我们会用到前两个。

　　Biped是CS中主要的和最受认可的组件，它是用与类人角色的通用装备，但同时又足够灵活，可以进行自定义以适合各种不同形状的角色。在MAXScript Reference 7.0中的MAXScript Extensions中可以找到相应扩展各种使用方式的介绍和范例。

　　Physique是类似于“蒙皮”的修改器，但它有额外的功能以更好的控制基本骨骼影响网格的方式。当使用Biped时，不需要Physique。它只是一种可选的蒙皮系统，也可以使用编准的“蒙皮”修改器。虽然在MAXScript Reference 7.0也有对Physique扩展方法的介绍以及范例，但是遗憾的是，Discreet并没有在Max7种实现它（这一点非常奇怪，有了说明却没有实现。据说在Max8中，这个扩展已经被删除）。如果在脚本中使用了此扩展，运行时会报告undefined。因此，我们必须手动实现此扩展，编写扩展的plugin。幸好已经有人把这个扩展导出插件写好，名字叫IPhysique，网上可以搜索到IPhysique.zip或者IPhysique.gup这个文件，把它拷贝到max的plugins目录下就可以了。因为这个导出方法和Reference中的方法不兼容，因此需要阅读自带的IPhysique.doc文档，里面大致介绍了各种函数方法的使用。在使用的时候，不要忘记在函数调用前加上physiqueOps前缀，比如physiqueOps.getPhysiqueModifier。但是要注意的是：网上下载的IPhysique.gup有不同的版本，一般来说是for max5.1的，无法在max7中使用，因此，可以有两个选择来解决这个问题：

下载源代码，重新在maxSDK7下编译。源代码地址：

http://sparks.discreet.com/downloads/downloadshome.cfm?f=2&wf_id=130

有人已经把它在maxSDK7下编译生成了二进制文件。下载地址：

http://sparks.discreet.com/downloads/downloadshome.cfm?f=2&wf_id=146

这样，就可以很方便的使用Physique的功能进行数据导出了。

总结
　　总的来说，使用maxscript来进行数据导出是一个比较好的选择，无须编译、无须重启max，方便调试。

http://sparks.discreet.com/downloads/downloadshome.cfm?f=2&wf_id=130

有人已经把它在maxSDK7下编译生成了二进制文件。下载地址：

http://sparks.discreet.com/downloads/downloadshome.cfm?f=2&wf_id=146

这样，就可以很方便的使用Physique的功能进行数据导出了。

总结
　　总的来说，使用maxscript来进行数据导出是一个比较好的选择，无须编译、无须重启max，方便调试。

Trackback: http://tb.blog.csdn.net/TrackBack.aspx?PostId=550173

maya PlugInsAPI 笔记

Fri, 25 Nov 2005 03:21:22 GMT

maya PlugInsAPI 笔记

以下是我在学maya时所作的笔记，对你也许没什么用，不过如果你也想知道如何编写maya插件的话，在我的“精彩网址链接”中有链接.
// 一.
MPxContexCommand  ---  脚本
MpxContex         ---  处理事件工具
MpxToolCommand    ---  给MpxContex用:如制模(在MpxContex的鼠标释放事件中产生一个newToolCommand临时对象来调用它的MpxToolCommand的doIt方法来产生模型)

注册
initializePlugin(...)
{
status = plugin.registerContextCommand(
            "helixToolContext", helixContextCmd::creator,
            "helixToolCmd", helixTool::creator,
            helixTool::newSyntax);
}
反注册
uninitializePlugin

// 二. 激活方法:
1. 用setToolTo command
2. 添加icon到shelf中
marqueeToolContext marqueeToolContext1; // 注意marqueeToolContext 是你在注册时的名字
setParent Shelf1;
toolButton  -cl toolCluster
            -t marqueeToolContext1
            -i1 "marqueeTool.xpm" marqueeTool1;
This code could either be sourced by hand from the MEL command window, or it could be invoked with MGlobal::sourceFile() in the initializePlugin() method of the plug-in.

// 三. Tool Property Sheets：
为了处理工具表单要写两个Mel文件:
1.<yourContextName>Properties.mel
2. <yourContextNamevalues.mel

// 四. 获取信息:
1. 遍历MItDag时得到MDagPath
2. 通过MDagPath得到对应MFnDagNode
3. 去掉不要的信息:如dagPath.isIntermediateObject()是这中间数据（如修改模型顶点时会保留原来的模型和被改后的模型在同一Transform结点下）, 而只找我们所要的，如MfnDagNode.hasFn(Mfn:kMesh)
4. 获得信息： fnMesh.getPoints(MPointArrary, MSpace:kWorld);