OGRE中使用CEGUI详解

研究了一下午，总算是在OGRE中使用上CEGUI了。参考了许多网友的文章，这里结合自己的经验给出详细的步骤。

新手一般都使用OGRE提供的ExampleApplication+ExampleFrameListener框架。

这个框架默认是屏幕独占模式，而且是没有鼠标的。要使用鼠标，或者进一步创建UI界面，必须使用CEGUI。

下面给出通过CEGUI使用鼠标的详细步骤（VS2005 + Ogre1.6.5）：

1.工程配置

确保VS选项中的项目和解决方案配置中已经添加了Dependencies/include/CEGUI目录。

工程属性-->链接中增加依赖项CEGUIBase_d.lib和OgreGUIRenderer_d.lib(如果是release则没有"_d"，下同，不再赘述)

这2个lib库分别在ogre/Dependencies/lib/和ogre/lib下。根据这个目录配置好附加库目录。

2.头文件支持

需要用到的头文件有OgreCEGUIRenderer.h，OgreCEGUIResourceProvider.h，OgreCEGUITexture.h

他们在ogre/Samples/Common/CEGUIRenderer/include下面，你可以复制到你的工程，也可以增加引用该目录。

3.dll运行时支持

在ogre/Samples/Common/bin/Debug里面找到

CEGUIBase_d.dll，CEGUIExpatParser_d.dll，CEGUIFalagardWRBase_d.dll，OgreGUIRenderer_d.dll

把他们复制到你的工程的目标文件夹里供exe调用。

4.添加代码

派生你自己的监听类：

class GuiFrameListener : public ExampleFrameListener, public OIS::KeyListener, public OIS::MouseListener
{
private:
CEGUI::Renderer* mGUIRenderer;
SceneManager *mSceneMgr;              // A pointer to the scene manager
RaySceneQuery *mRaySceneQuery;      // The ray scene query pointer
public:
// NB using buffered input, this is the only change
GuiFrameListener(RenderWindow* win, Camera* cam, CEGUI::Renderer* renderer, SceneManager* pSceneMgr);

//  OIS::KeyListener和OIS::MouseListener是2个虚基类，必须实例化其纯虚函数
virtual bool frameStarted(const FrameEvent &evt);
virtual bool frameEnded(const FrameEvent& evt);
virtual bool frameRenderingQueued(const FrameEvent& evt);
//----------------------------------------------------------------//
virtual bool processUnbufferedKeyInput(const FrameEvent& evt){return true;}
//----------------------------------------------------------------//
virtual bool mouseMoved( const OIS::MouseEvent &arg );
virtual bool mousePressed( const OIS::MouseEvent &arg, OIS::MouseButtonID id );
virtual bool mouseReleased( const OIS::MouseEvent &arg, OIS::MouseButtonID id );
};

GuiFrameListener 的实现：

GuiFrameListener::GuiFrameListener(RenderWindow* win, Camera* cam, CEGUI::Renderer* renderer, SceneManager* pSceneMgr)
:ExampleFrameListener(win, cam, true, true)
{
mMouse->setEventCallback(this);
mKeyboard->setEventCallback(this);

mGUIRenderer = renderer;
}

bool GuiFrameListener::mouseMoved( const OIS::MouseEvent &arg )
{
CEGUI::System::getSingleton().injectMouseMove(arg.state.X.rel, rg.state.Y.rel);

return true;
}

// 其余省略...

GuiFrameListener 的构造函数尤其值得注意：

这个构造函数做了这么几件重要的事情：

1.调用ExampleFrameListener(win, cam, true, true)构造函数。

注意后面2个true分别设置了使用缓冲的键盘、鼠标输入。

默认参数是false。在false状态下，ExampleFrameListener在每帧执行frameRenderingQueued的时候不会mKeyboard->capture()和mMouse->capture();

这2个函数恰好调用的是你重载自OIS::KeyListener和OIS::MouseListener的虚函数。

2.设置了鼠标键盘的回调类为this（也就是GuiFrameListener）。

从ExampleApplication类派生你自己的App类，最重要的是重写createFrameListener，如下：

void MyApplication::createFrameListener(void)
{
mFrameListener= new GuiFrameListener(mWindow, mCamera, mGUIRenderer, mSceneMgr);
mFrameListener->showDebugOverlay(true);
mRoot->addFrameListener(mFrameListener);
};

这样给你的app关联了GuiFrameListener类监听鼠标操作。

看出来了吗？典型的观察者模式。只要你需要，你可以增加任意个Listener类来监听事件。

同样很重要的，在createScene中初始化CEGUI

void MyApplication::createScene(void)
{
// CEGUI setup
mGUIRenderer = new CEGUI::OgreCEGUIRenderer(mWindow, Ogre::RENDER_QUEUE_OVERLAY, false, 3000, mSceneMgr);
mGUISystem = new CEGUI::System(mGUIRenderer);

// Mouse
CEGUI::SchemeManager::getSingleton().loadScheme((CEGUI::utf8*)"TaharezLookSkin.scheme");
CEGUI::MouseCursor::getSingleton().setImage("TaharezLook", "MouseArrow");
}

这里有几点值得注意。

我刚开始写的时候，new CEGUI::System总是导致内存溢出错误，后来发现是在第三步（运行时配置）中操作有误导致的。

其次注意到"TaharezLookSkin.scheme"和"TaharezLook"，他们是用来定义鼠标样式和UI字体等样式的文件，在ogre/Samples/Media/gui和ogre/Samples/Media/fonts中。一定要注意配置好resources.cfg文件！

现在编译工程并运行，会发现鼠标出现在了屏幕最中间。这样把鼠标的移动处理全权丢给CEGUI去处理了。

当然你也可以自己编写你想要的任何鼠标处理。