OSG-王锐《最长的一帧》

昀长的一帧王锐（array）这是一篇有关OpenSceneGraph源代码的拙劣教程，没有任何能赏心悦目的小例子，也不会贡献出什么企业级的绝密的商业代码，标题也只是个噱头（坏了，没人看了^_^）。本文写作的目的说来很简单，无非就是想要深入地了解一下，OSG在一帧时间，也就是仿真循环的一个画面当中都做了什么。对OSG有所了解之后，我们也许可以很快地回答这个问题，正如下面的代码所示：while(!viewer.done())viewer.frame();就这样，用一个循环结构来反复地执行frame()函数，直到done()函数的返回值为true为止。每一次执行frame()函数就相当于完成了OSG场景渲染的一帧，配置较好的计算机可以达到每秒钟一二百帧的速率，而通常仿真程序顺利运行的昀低帧速在15~25帧/秒即可。很好，看来笔者的机器运行frame()函数通常只需要8~10ms左右，比一眨眼的工夫都要短。那么本文就到此结束吗？答案当然是否定的，恰恰相反，这篇繁琐且可能错误百出的文字，其目的正是要深入frame()函数，再深入函数中调用的函数……一直挖掘下去，直到我们期待的瑰宝出现；当然也可能是一无所获，只是乐在其中。这样的探索要到什么时候结束呢？从这短短的10毫秒中引申出来的，无比冗长的一帧，又是多么丰富抑或无聊的内容呢？现在笔者也不知道，也许直到昀后也不会明了，不过相信深入源代码的过程就是一种享受，希望读者您也可以同我一起享受这份辛苦与快乐。源代码版本：OpenSceneGraph2.6.0；操作系统环境假设为Win32平台。为了保证教程的篇幅不致被过多程序代码所占据，文中会适当地改写和缩编所列出的代码，仅保证其执行效果不变，因此可能与实际源文件的内容有所区别。由于作者水平和精力所限，本文暂时仅对单视景器（即使用osgViewer::Viewer类）的情形作出介绍。转载请注明作者和本文在写作过程中将会用到一些专有名词，它们可能与读者阅读的其它文章中所述有所差异，现列举如下：场景图形-SceneGraph；场景子树-Subgraph；节点-Node；摄像机-Camera；渲染器-Renderer；窗口-Window；视口-Viewport；场景-Scene；视图-View；视景器-Viewer；漫游器-Manipulator；访问器-Visitor；回调-Callback；事件-Event；更新-Update；筛选-Cull；绘制-Draw。第一日好了，在开始第一天的行程之前，请先打开您昀惯用的编程工具吧：VisualStudio？CodeBlocks？UltraEdit？SourceInsight？Emacs？Vim？或者只是附件里那个制作低劣的记事本……总之请打开它们，打开OpenSceneGraph-2.6.0的源代码文件夹，打开osgViewer/ViewerBase.cpp这个文件……同样的话就不再重复了。但是如果您没有这样做，而仅仅是一边聊着QQ，一边在电话里和女朋友发着牢骚，一边还要应付突然冲进来的老板，一边打开这篇教程的话——对不起，我想您会在1分钟以内就对其感到厌烦，因为它就像天书一样，或者就像一坨乱七八糟的毛线团，只有家里那只打着哈欠的小猫可能会过来捅上一下。不过不用担心，如果您已经耐着性子读到了这里，并且已经看到了ViewerBase.cpp中总共752行规规矩矩的代码，那么我会尽全力协助您继续走完漫长的一帧的旅程，并在其中把自己所知所得（不仅仅局限于那个该死的frame函数，而是遍及OSG的方方面面）全数灌输给您。当然也希望您尽全力给我以打压、批评和指正，我只是一个普普通通的梦想着先找个女朋友成家立业的毛头小子而已，如果我的话全都是对的，那么那些真正的图形学权威们一定都住在寒风刺骨的珠穆朗玛峰顶上。好了，废话不再多说。我们这就开始。当前位置：osgViewer/ViewerBase.cpp第571行，osgViewer::ViewerBase::frame()frame函数的内容本身几乎一眼就可以看完。不过要注意的是，这个函数是ViewerBase类的成员函数，而非Viewer类。因此，无论对于单视景器的Viewer类，还是多视景器的CompositeViewer类，frame函数的内容都是相同的（因为它们都没有再重写这个函数的内容）。该函数所执行的主要工作如下：1、如果这是仿真系统启动后的第一帧，则执行viewerInit()；此时如果还没有执行realize()函数，则执行它。2、执行advance函数。3、执行eventTraversal函数，顾名思义，这个函数将负责处理系统产生的各种事件，诸如鼠标的移动，点击，键盘的响应，窗口的关闭等等，以及摄像机与场景图形的事件回调（EventCallback）。4、执行updateTraversal函数，这个函数负责遍历所有的更新回调（UpdateCallback）；除此之外，它的另一个重要任务就是负责更新DatabasePager与ImagePager这两个重要的分页数据处理组件。5、执行renderingTraversals函数，这里将使用较为复杂的线程处理方法，完成场景的筛选（cull）和绘制（draw）工作。下面我们就按照1~5的顺序，开始我们的源代码解读之旅。当前位置：osgViewer/View.cpp第227行，osgViewer::View::init()Viewer::viewerInit函数只做了一件事，就是调用View::init()函数，而这个init函数的工作似乎也是一目了然的：无非就是完成视景器的初始化工作而已。不过在我们离开这个函数，继续我们的旅程之前，还是仔细探究一下，这个初始化工作到底包含了什么？阅读某个函数的源代码过程中，如果能够大致知道这个函数的主要工作，并了解其中用到的变量的功能，那么即使只有很少的注释内容，应该也可以顺利地读完所有代码。如果对一些命名晦涩的变量不甚理解，或者根本不知道这个函数于运行流程中有何用途，那么理解源代码的过程就会麻烦很多。View::init函数中出现了两个重要的类成员变量：_eventQueue和_cameraManipulator，并且还将一个osgGA::GUIEventAdapter的实例传入后者的初始化函数。代码如下：osg::ref_ptrosgGA::GUIEventAdapterinitEvent=_eventQueue-createEvent();initEvent-setEventType(osgGA::GUIEventAdapter::FRAME);if(_cameraManipulator.valid())_cameraManipulator-init(*initEvent,*this);从变量的名称可以猜测出_eventQueue的功能，它用于储存该视景器的事件队列。OSG中代表事件的类是osgGA::GUIEventAdapter，它可以用于表达各种类型的鼠标、键盘、触压笔和窗口事件。在用户程序中，我们往往通过继承osgGA::GUIEventHandler类，并重写handle函数的方法，获取实时的鼠标/键盘输入，并进而实现相应的用户代码（参见osgkeyboardmouse）。_eventQueue除了保存一个GUIEventAdapter的链表之外，还提供了一系列对链表及其元素的操作函数，这其中，createEvent函数的作用是分配和返回一个新的GUIEventAdapter事件的指针。随后，这个新事件的类型被指定为FRAME事件，即每帧都会触发的一个事件。那么，_cameraManipulator呢？没错，它就是视景器中所用的场景漫游器的实例。通常我们都会使用setCameraManipulator来设置这个变量的内容，例如轨迹球漫游器（TrackballManipulator）可以使用鼠标拖动来观察场景，而驾驶漫游器（DriveManipulator）则使用类似于汽车驾驶的效果来实现场景的漫游。上面的代码将新创建的FRAME事件和Viewer对象本身传递给_cameraManipulator的init函数，不同的漫游器（如TrackballManipulator、DriveManipulator）会重写各自的init函数，实现自己所需的初始化工作。如果读者希望自己编写一个场景的漫游器，那么覆写并使用osgGA::MatrixManipulator::init就可以灵活地初始化自定义漫游器的功能了，它的调用时机就在这里。那么，回到viewerInit函数……很好，这次似乎没有更多的内容了。没想到一个短短的函数竟然包含了那么多的信息，看来草率地阅读还真是使不得。解读成果：osgGA::EventQueue::createEvent，osgGA::MatrixManipulator::init，osgViewer::View::init，osgViewer::Viewer::viewerInit。悬疑列表：无。第二日当前位置：osgViewer/Viewer.cpp第385行，osgViewer::Viewer::realize()Viewer::realize函数是我们十分熟悉的另一个函数，从OSG问世以来，我们就习惯于在进入仿真循环之前调用它（现在的OSG会自动调用这个函数，如果我们忘记的话），以完成窗口和场景的“设置”工作。那么，什么叫做“设置”，这句简单的场景设置又包含了多少内容呢？艰辛的旅程就此开始吧。首先是一行：setCameraWithFocus(0)，其内容无非是设置类变量_cameraWithFocus指向的内容为NULL。至于这个“带有焦点的摄像机”是什么意思，我们似乎明白，似乎又不明白，就先放入一个“悬疑列表”（TodoList）中好了。下面遇到的函数就比较重要了，因为我们将会在很多地方遇到它：Contextscontexts;getContexts(contexts);变量contexts是一个保存了osg::GraphicsContext指针的向量组，而Viewer::getContexts函数的作用是获取所有的图形上下文，并保存到这个向量组中来。对于需要将OSG嵌合到各式各样的GUI系统（如MFC，Qt，wxWidgets等）的朋友来说，osg::GraphicsContext类是经常要打交道的对象之一。一种常用的嵌入方式也许是这样实现的：osg::ref_ptrosg::GraphicsContext::Traitstraits=newosg::GraphicsContext::Traits;osg::ref_ptrosg::Referencedwindata=newosgViewer::GraphicsWindowWin32::WindowData(hWnd);traits-x=0;traits-y=0;……traits-inheritedWindowData=windata;osg::GraphicsContext*gc=osg::GraphicsContext::createGraphicsContext(traits.get());Camera*camera=viewer.getCamera();camera-setGraphicsContext(gc);……viewer.setCamera(camera);这个过程虽然比较繁杂，但是顺序还是十分清楚的：首先设置嵌入窗口的特性（Traits），例如X、Y位置，宽度和高度，以及父窗口的句柄（inheritedWindowData）；然后根据特性的设置创建一个新的图形设备上下文（GraphicsContext），将其赋予场景所用的摄像机。而我们在getContexts函数中所要获取的，也许就包括这样一个用户建立的GraphicsContext设备。当前位置：osgViewer/Viewer.cpp第1061行