1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
14#ifndef OSGVIEWER_CompositeViewer
15#define OSGVIEWER_CompositeViewer 1
17#include <osg/ArgumentParser>
18#include <osgUtil/UpdateVisitor>
19#include <osgViewer/GraphicsWindow>
20#include <osgViewer/View>
24/** CompositeViewer holds one or more views to one or more scenes.*/
25class OSGVIEWER_EXPORT CompositeViewer : public ViewerBase
31 CompositeViewer(const CompositeViewer&,const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY);
33 CompositeViewer(osg::ArgumentParser& arguments);
35 META_Object(osgViewer,CompositeViewer);
37 virtual ~CompositeViewer();
39 /** Read the viewer configuration from a configuration file.*/
40 bool readConfiguration(const std::string& filename);
43 /** Set the Stats object used to collect various frame related timing and scene graph stats.*/
44 virtual void setViewerStats(osg::Stats* stats) { _stats = stats; }
46 /** Get the Viewers Stats object.*/
47 virtual osg::Stats* getViewerStats() { return _stats.get(); }
49 /** Get the Viewers Stats object.*/
50 virtual const osg::Stats* getViewerStats() const { return _stats.get(); }
53 void addView(osgViewer::View* view);
54 template<class T> void addView(const osg::ref_ptr<T>& view) { addView(view.get()); }
56 void removeView(osgViewer::View* view);
57 template<class T> void removeView(const osg::ref_ptr<T>& view) { removeView(view.get()); }
59 osgViewer::View* getView(unsigned i) { return _views[i].get(); }
60 const osgViewer::View* getView(unsigned i) const { return _views[i].get(); }
62 unsigned int getNumViews() const { return _views.size(); }
65 /** Get whether at least of one of this viewer's windows are realized.*/
66 virtual bool isRealized() const;
68 /** Set up windows and associated threads.*/
69 virtual void realize();
71 virtual void setStartTick(osg::Timer_t tick);
73 void setReferenceTime(double time=0.0);
75 osg::FrameStamp* getFrameStamp() { return _frameStamp.get(); }
76 const osg::FrameStamp* getFrameStamp() const { return _frameStamp.get(); }
78 virtual double elapsedTime();
80 virtual osg::FrameStamp* getViewerFrameStamp() { return getFrameStamp(); }
83 /** Execute a main frame loop.
84 * Equivalent to while (!viewer.done()) viewer.frame();
85 * Also calls realize() if the viewer is not already realized,
86 * and installs trackball manipulator if one is not already assigned.
90 /** Check to see if the new frame is required, called by run() when FrameScheme is set to ON_DEMAND.*/
91 virtual bool checkNeedToDoFrame();
93 /** check to see if events have been received, return true if events are now available.*/
94 virtual bool checkEvents();
96 virtual void advance(double simulationTime=USE_REFERENCE_TIME);
98 virtual void eventTraversal();
100 virtual void updateTraversal();
103 void setCameraWithFocus(osg::Camera* camera);
104 osg::Camera* getCameraWithFocus() { return _cameraWithFocus.get(); }
105 const osg::Camera* getCameraWithFocus() const { return _cameraWithFocus.get(); }
107 osgViewer::View* getViewWithFocus() { return _viewWithFocus.get(); }
108 const osgViewer::View* getViewWithFocus() const { return _viewWithFocus.get(); }
110 virtual void getCameras(Cameras& cameras, bool onlyActive=true);
112 virtual void getContexts(Contexts& contexts, bool onlyValid=true);
114 virtual void getAllThreads(Threads& threads, bool onlyActive=true);
116 virtual void getOperationThreads(OperationThreads& threads, bool onlyActive=true);
118 virtual void getScenes(Scenes& scenes, bool onlyValid=true);
120 virtual void getViews(Views& views, bool onlyValid=true);
123 /** Get the keyboard and mouse usage of this viewer.*/
124 virtual void getUsage(osg::ApplicationUsage& usage) const;
128 void constructorInit();
130 virtual void viewerInit();
132 void generateSlavePointerData(osg::Camera* camera, osgGA::GUIEventAdapter& event);
133 void generatePointerData(osgGA::GUIEventAdapter& event);
134 void reprojectPointerData(osgGA::GUIEventAdapter& source_event, osgGA::GUIEventAdapter& dest_event);
136 typedef std::vector< osg::ref_ptr<osgViewer::View> > RefViews;
141 osg::ref_ptr<osg::Stats> _stats;
143 osg::Timer_t _startTick;
144 osg::ref_ptr<osg::FrameStamp> _frameStamp;
146 osg::observer_ptr<osg::Camera> _cameraWithFocus;
147 osg::observer_ptr<osgViewer::View> _viewWithFocus;
149 osg::ref_ptr<osgGA::GUIEventAdapter> _previousEvent;