OSG教程:场景保存类Viewer

来源： 第三维度
    作者：FreeSouth[杨石兴]编著

    选自《OSG程序设计教程》第二章第四节

    osgViewer::Viewer

    类描述： 为一个单独的场景[scene]保存一个单独的view.

    类中方法：

    1：Viewer()
    2：Viewer (osg::ArgumentParser &arguments)
    3：Viewer (const osgViewer::Viewer &viewer, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)

    说明：是Viewer的构造函数。其中第一个为常见的构造函数。第二个构造函数为从类osg::ArgumentParser中传递参数入Viewer，类ArgumentParser可以获取main入口参数以及程序的其它信息，也可以判断传参是否有误。第三个重载的构造函数为从另一个Viewer创建新Viewer，里面的第一个参数表示源Viewer，而第二个参数表示使用的拷贝类型，参数主要有两个，一个是浅拷贝：SHALLOW_COPY，另一个则是深拷贝：DEEP_COPY_OBJECTS，关于拷贝类型的不同和利弊可以参照一般C++书籍。关于OSG中的拷贝类型可以参照类osg::CopyOp。

    参数

    类继承图表：

    virtual ~Viewer ()

    说明： 析构函数

    META_Object (osgViewer, Viewer)

    说明：是一个宏，宏中定义了标准Clone,且具有isSameAs，ClassName，accept三个重要方法。目的是让从Node派生的子类方便的定义所需要的纯虚方法。

    参数

    virtual void take (View &rhs)

    说明：功能是从一个View中得到它的所有设置，这其中包括相机和子相机以及子视口等等，得到后View会被销毁。

    参数

    virtual bool readConfiguration (const std::string &filename)

    说明：该方法是从类osgViewer::ViewerBase中继承下来的方法，功能是读取一个配置文件来配置Viewer.现实中并不是常用读配置文件的方法来设置Viewer.如果读取成功，则返回True,返则返回假。

    参数

    virtual bool isRealized () const

    说明：该方法是从类osgViewer::ViewerBase中继承下来的方法，功能是看Viewer是否已经执行了Realize操作，如果执行了则返回真，事则返回假。

    virtual void realize ()

    说明：该方法是从类osgViewer::ViewerBase中继承下来的方法，功能是该操作会使对Viewer之前的设置都使之生效。

    virtual void setStartTick (osg::Timer_t tick)

    说明：该方法是从类osgViewer::View中继承下来的方法，功能是设置时钟开始滴答点数，从那里开始计时。可以用于计算程序运行的时间等等。

    参数

    void setReferenceTime (double time=0.0)

    说明：设置参考时间，与上一个函数配合来使用。

    virtual void setSceneData (osg::Node *node)

    说明：设置场景中的数据，为场景中渲染的实际数据，在事面会讲解osg::Node类型。

    参数

    virtual GraphicsWindowEmbedded * setUpViewerAsEmbeddedInWindow (int x, int y, int width, int height)

    说明：该函数的功能是以嵌入式窗口的形式来设置该Viewer的渲染面。返回指向嵌入式界面指针。

    参数

    virtual double elapsedTime ()

    说明：该函数可以计算程序执行的时间，返回值为程序执行的时间，一般为毫秒级。

     virtual osg::FrameStamp * getViewerFrameStamp ()

    说明：这个函数返回当前Viewer的一个FrameStamp,至于什么是FrameStamp，大意是说规定两个时间，在此时间中规定帧的数目，在渲染时会按照这个帧数来把帧压在这个时间段当中。

     virtual int run () 说明：开始执行渲染操作，返回值一般为1。程序退出或出错时会返回0。

    virtual void advance (double simulationTime=USE_REFERENCE_TIME)

    说明：高级，表示从默认参考时间开始会计算一些信息，帧速，帧率，帧间隔等等。

     参数

    virtual void eventTraversal ()

    说明：事件遍历，遍历外部事件来处理场景中因事件发生而引起的渲染变化。

    virtual void updateTraversal ()

    说明：更新遍历，遍历更新场景的数据渲染。

    void setCameraWithFocus (osg::Camera *camera)

    说明：设置相机。

    参数

    osg::Camera * getCameraWithFocus () const osg::Camera * getCameraWithFocus () const

    说明：得到相机，返回值为一个相机。

    virtual void getCameras (Cameras &cameras, bool onlyActive=true)

    说明：得到相机群。参数一为引用类型，执行该函数后cameras就含有了Viewer的相机群。关于引用参数可以参考C++基本书籍。第二个参数问是否获得激活可用的相机群，而不可用的不获得，默认值为真。

    参数

    virtual void getContexts (Contexts &contexts, bool onlyValid=true)

    说明：得到上下文，参数一为引用类型，执行该函数后contexts中就含有了Viewer的上下文，关于引用参数可以参考C++基本书籍。第二个参数问是否获得激活可用的上下文，而不可用的不获得，默认值为真。

    参数

    virtual void getWindows (Windows &windows, bool onlyValid=true)

    说明：得到Windows,这里的Windows并不能直接理解为所谓的窗口，应该理解为一个渲染面。执行该函数后windows中就含有了Viewer中的windows，关于引用参数可以参考C++基本书籍。第二个参数问是否获得激活可用的窗口，而不可用的不获得，默认值为真。

    参数

    virtual void getAllThreads (Threads &threads, bool onlyActive=true)

    说明：得到所有当前Viewer中的线程，执行该函数后threads中会有该Viewer的线程，关于引用参数可以参考C++基本书籍。第二个参数问是否获得正在激活的线程，而不激活的线程不获得，默认值为真。

    参数

    virtual void getOperationThreads (OperationThreads &threads, bool onlyActive=true)

    说明：得到操作线程[OperationThreads],执行该函数后threads中会有该Viewer的操作线程，关于引用参数可以参考C++基本书籍。第二个参数问是否获得正在激活的操作线程，而不激活的线程不获得，默认值为真。

    参数

    virtual void getScenes (Scenes &scenes, bool onlyValid=true)

    说明：得到当前Viewer的Scenes, 执行该函数后scnes中会有该Viewer的scenes,关于引用参数可以参考C++基本书籍。第二个参数问是否获得可用的scenes,而不可用的scenes不获得，默认值为真。

    参数

    virtual void getViews (Views &views, bool onlyValid=true)

    说明：得到当前Viewer的View，执行该函数后views中会有该Viewer的views，关于引用参数可以参考C++基本书籍。第二个参数问是否获得可用的views，而不可用的不获得，默认值为真。

    参数

    virtual void getUsage (osg::ApplicationUsage &usage) const

    说明：得到当前Viewer的命令行描述。

    参数