openscenegraph
osgViewer/View
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
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.
7 *
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.
12*/
13
14#ifndef OSGVIEWER_VIEW
15#define OSGVIEWER_VIEW 1
16
17#include <osg/View>
18
21#include <osgUtil/UpdateVisitor>
22#include <osgUtil/SceneView>
23
25#include <osgGA/EventVisitor>
26#include <osgGA/EventQueue>
27#include <osgGA/Device>
28
29#include <osgViewer/Scene>
30#include <osgViewer/ViewerBase>
31#include <osgViewer/Keystone>
32
33namespace osgViewer {
34
35
38{
39 public:
40
42
43 ViewConfig(const ViewConfig& rhs, const osg::CopyOp& copyop=osg::CopyOp::SHALLOW_COPY) : osg::Object(rhs,copyop) {}
44
46
48 virtual void configure(osgViewer::View& /*view*/) const {}
49
52};
53
54
56{
58 {
60 BOUNDING_VOLUME
61 };
62
63 DepthPartitionSettings(DepthMode mode=BOUNDING_VOLUME);
64
65 virtual bool getDepthRange(osg::View& view, unsigned int partition, double& zNear, double& zFar);
66
68 double _zNear;
69 double _zMid;
70 double _zFar;
71};
72
73
76{
77 public:
78
80
82
84
87 virtual osg::View* asView() { return this; }
88
92 ViewerBase* getViewerBase() { return _viewerBase.get(); }
93
95 virtual void take(osg::View& rhs);
96
97 virtual void setStartTick(osg::Timer_t tick);
98 osg::Timer_t getStartTick() const { return _startTick; }
99
100 Scene* getScene() { return _scene.get(); }
101 const Scene* getScene() const { return _scene.get(); }
102
104 virtual void setSceneData(osg::Node* node);
105
106 template<class T> void setSceneData(const osg::ref_ptr<T>& node) { setSceneData(node.get()); }
107
109 osg::Node* getSceneData() { return _scene.valid() ? _scene->getSceneData() : 0; }
110
112 const osg::Node* getSceneData() const { return _scene.valid() ? _scene->getSceneData() : 0; }
113
114
117
118 template<class T> void setDatabasePager(const osg::ref_ptr<T>& dp) { setDatabasePager(dp.get()); }
119
122
125
126
129
130 template<class T> void setImagePager(const osg::ref_ptr<T>& ip) { setImagePager(ip.get()); }
131
134
137
138
141 void addDevice(osgGA::Device* eventSource);
142
143 template<class T> void addDevice(const osg::ref_ptr<T>& eventSource) { addDevice(eventSource.get()); }
144
146 void removeDevice(osgGA::Device* eventSource);
147
148 template<class T> void removeDevice(const osg::ref_ptr<T>& eventSource) { removeDevice(eventSource.get()); }
149
150 typedef std::vector< osg::ref_ptr<osgGA::Device> > Devices;
151
152 Devices& getDevices() { return _eventSources; }
153 const Devices& getDevices() const { return _eventSources; }
154
155
156 /* Set the EventQueue that the View uses to integrate external non window related events.*/
157 void setEventQueue(osgGA::EventQueue* eventQueue) { _eventQueue = eventQueue; }
158
159 template<class T> void setEventQueue(const osg::ref_ptr<T>& eventQueue) { setEventQueue(eventQueue.get()); }
160
161 /* Get the View's EventQueue.*/
162 osgGA::EventQueue* getEventQueue() { return _eventQueue.get(); }
163
164 /* Get the const View's EventQueue.*/
165 const osgGA::EventQueue* getEventQueue() const { return _eventQueue.get(); }
166
169 void setCameraManipulator(osgGA::CameraManipulator* manipulator, bool resetPosition = true);
170
171 template<class T> void setCameraManipulator(const osg::ref_ptr<T>& manipulator, bool resetPosition = true) { setCameraManipulator(manipulator.get(), resetPosition); }
172
174 osgGA::CameraManipulator* getCameraManipulator() { return _cameraManipulator.get(); }
175
177 const osgGA::CameraManipulator* getCameraManipulator() const { return _cameraManipulator.get(); }
178
181 void home();
182
183
184 typedef std::list< osg::ref_ptr<osgGA::EventHandler> > EventHandlers;
185
188
189 template<class T> void addEventHandler(const osg::ref_ptr<T>& eventHandler) { addEventHandler(eventHandler.get()); }
190
193
194 template<class T> void removeEventHandler(const osg::ref_ptr<T>& eventHandler) { removeEventHandler(eventHandler.get()); }
195
197 EventHandlers& getEventHandlers() { return _eventHandlers; }
198
200 const EventHandlers& getEventHandlers() const { return _eventHandlers; }
201
202
207
210
213
214
216 void setDisplaySettings(osg::DisplaySettings* ds) { _displaySettings = ds; }
217
218 template<class T> void setDisplaySettings(const osg::ref_ptr<T>& ds) { setDisplaySettings(ds.get()); }
219
221 osg::DisplaySettings* getDisplaySettings() { return _displaySettings.get(); }
222
224 const osg::DisplaySettings* getDisplaySettings() const { return _displaySettings.get(); }
225
228 {
229 _fusionDistanceMode = mode;
230 _fusionDistanceValue = value;
231 }
232
234 osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const { return _fusionDistanceMode; }
235
237 float getFusionDistanceValue() const { return _fusionDistanceValue; }
238
239
241 void apply(ViewConfig* config);
242
243 template<class T> void apply(const osg::ref_ptr<T>& config) { apply(config.get()); }
244
245 ViewConfig* getLastAppliedViewConfig() { return _lastAppliedViewConfig.get(); }
246 const ViewConfig* getLastAppliedViewConfig() const { return _lastAppliedViewConfig.get(); }
247
248
251
253 void setUpViewInWindow(int x, int y, int width, int height, unsigned int screenNum=0);
254
256 void setUpViewOnSingleScreen(unsigned int screenNum=0);
257
259 void setUpViewFor3DSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image* intensityMap=0, const osg::Matrixd& projectorMatrix = osg::Matrixd());
260
262 void setUpViewForPanoramicSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image* intensityMap=0, const osg::Matrixd& projectorMatrix = osg::Matrixd());
263
265 void setUpViewForWoWVxDisplay(unsigned int screenNum, unsigned char wow_content, unsigned char wow_factor, unsigned char wow_offset, float wow_disparity_Zd, float wow_disparity_vz, float wow_disparity_M, float wow_disparity_C);
266
267
268
271
274
275
277 bool containsCamera(const osg::Camera* camera) const;
278
279 template<class T> bool containsCamera(const osg::ref_ptr<T>& camera) const { return containsCamera(camera.get()); }
280
282 const osg::Camera* getCameraContainingPosition(float x, float y, float& local_x, float& local_y) const;
283
285 bool computeIntersections(float x,float y, osgUtil::LineSegmentIntersector::Intersections& intersections,osg::Node::NodeMask traversalMask = 0xffffffff);
286
288 bool computeIntersections(float x,float y, const osg::NodePath& nodePath, osgUtil::LineSegmentIntersector::Intersections& intersections,osg::Node::NodeMask traversalMask = 0xffffffff);
289
290
293
296
297
300
302 bool computeIntersections(const osg::Camera* camera, osgUtil::Intersector::CoordinateFrame cf, float x,float y, const osg::NodePath& nodePath, osgUtil::LineSegmentIntersector::Intersections& intersections,osg::Node::NodeMask traversalMask = 0xffffffff);
303
304 virtual void requestRedraw();
305 virtual void requestContinuousUpdate(bool needed=true);
306 virtual void requestWarpPointer(float x,float y);
307
309 virtual bool requiresUpdateSceneGraph() const;
310
312 virtual bool requiresRedraw() const;
313
314public:
315
316 osg::Texture* createDistortionTexture(int width, int height);
318 osg::Camera* assignKeystoneDistortionCamera(osg::DisplaySettings* ds, osg::GraphicsContext* gc, int x, int y, int width, int height, GLenum buffer, osg::Texture* texture, Keystone* keystone);
319 osg::Camera* assignStereoCamera(osg::DisplaySettings* ds, osg::GraphicsContext* gc, int x, int y, int width, int height, GLenum buffer, double eyeScale);
321
323 {
324 StereoSlaveCallback(osg::DisplaySettings* ds, double eyeScale):_ds(ds), _eyeScale(eyeScale) {}
325
326 virtual void updateSlave(osg::View& view, osg::View::Slave& slave);
327
329 double _eyeScale;
330 };
331
332
333 public:
334
336 void init();
337
338 protected:
339
340 friend class CompositeViewer;
341
342 virtual ~View();
343
345
347
348
350
352
357
359
363
365
366};
367
368}
369
370#endif
Definition DatabasePager:50
Definition ImagePager:33
Definition CameraManipulator:40
Definition Device:25
Definition EventHandler:34
Definition EventQueue:31
Definition GUIActionAdapter:62
Definition GUIEventAdapter:82
CoordinateFrame
Definition IntersectionVisitor:38
std::multiset< Intersection > Intersections
Definition LineSegmentIntersector:74
FusionDistanceMode
Definition SceneView:339
Definition CompositeViewer:26
Definition Keystone:29
Definition Scene:30
Definition osgViewer/View:38
META_Object(osgViewer, ViewConfig)
virtual osg::DisplaySettings * getActiveDisplaySetting(osgViewer::View &view) const
ViewConfig(const ViewConfig &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
Definition osgViewer/View:43
ViewConfig()
Definition osgViewer/View:41
virtual void configure(osgViewer::View &) const
Definition osgViewer/View:48
Definition osgViewer/View:76
void addEventHandler(const osg::ref_ptr< T > &eventHandler)
Definition osgViewer/View:189
void removeEventHandler(const osg::ref_ptr< T > &eventHandler)
Definition osgViewer/View:194
const osgDB::ImagePager * getImagePager() const
float getFusionDistanceValue() const
Definition osgViewer/View:237
EventHandlers _eventHandlers
Definition osgViewer/View:356
const osg::Camera * getCameraContainingPosition(float x, float y, float &local_x, float &local_y) const
bool computeIntersections(float x, float y, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
bool computeIntersections(const osgGA::GUIEventAdapter &ea, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
osgUtil::SceneView::FusionDistanceMode getFusionDistanceMode() const
Definition osgViewer/View:234
osg::Texture * createDistortionTexture(int width, int height)
void setCoordinateSystemNodePath(const osg::NodePath &nodePath)
void addEventHandler(osgGA::EventHandler *eventHandler)
osgGA::CameraManipulator * getCameraManipulator()
Definition osgViewer/View:174
void removeDevice(const osg::ref_ptr< T > &eventSource)
Definition osgViewer/View:148
void setEventQueue(const osg::ref_ptr< T > &eventQueue)
Definition osgViewer/View:159
osg::ref_ptr< osgGA::EventQueue > _eventQueue
Definition osgViewer/View:354
virtual osg::View * asView()
Definition osgViewer/View:87
void apply(ViewConfig *config)
bool computeIntersections(const osg::Camera *camera, osgUtil::Intersector::CoordinateFrame cf, float x, float y, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
const osgGA::EventQueue * getEventQueue() const
Definition osgViewer/View:165
osg::ref_ptr< ViewConfig > _lastAppliedViewConfig
Definition osgViewer/View:364
void setUpViewOnSingleScreen(unsigned int screenNum=0)
void addDevice(const osg::ref_ptr< T > &eventSource)
Definition osgViewer/View:143
void setUpViewAcrossAllScreens()
virtual void setStartTick(osg::Timer_t tick)
virtual void requestRedraw()
osg::ref_ptr< osgGA::CameraManipulator > _cameraManipulator
Definition osgViewer/View:355
osg::NodePath getCoordinateSystemNodePath() const
osgDB::ImagePager * getImagePager()
osg::ObserverNodePath _coordinateSystemNodePath
Definition osgViewer/View:358
void setImagePager(osgDB::ImagePager *ip)
Devices _eventSources
Definition osgViewer/View:351
bool computeIntersections(float x, float y, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
osg::observer_ptr< ViewerBase > _viewerBase
Definition osgViewer/View:346
const osgDB::DatabasePager * getDatabasePager() const
osg::Node * getSceneData()
Definition osgViewer/View:109
void setCameraManipulator(const osg::ref_ptr< T > &manipulator, bool resetPosition=true)
Definition osgViewer/View:171
void addDevice(osgGA::Device *eventSource)
osg::Camera * assignStereoCamera(osg::DisplaySettings *ds, osg::GraphicsContext *gc, int x, int y, int width, int height, GLenum buffer, double eyeScale)
osg::Timer_t _startTick
Definition osgViewer/View:349
bool computeIntersections(const osg::Camera *camera, osgUtil::Intersector::CoordinateFrame cf, float x, float y, const osg::NodePath &nodePath, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
void assignSceneDataToCameras()
const ViewConfig * getLastAppliedViewConfig() const
Definition osgViewer/View:246
osg::ref_ptr< osg::DisplaySettings > _displaySettings
Definition osgViewer/View:360
const Scene * getScene() const
Definition osgViewer/View:101
osg::Camera * assignRenderToTextureCamera(osg::GraphicsContext *gc, int width, int height, osg::Texture *texture)
void setCameraManipulator(osgGA::CameraManipulator *manipulator, bool resetPosition=true)
void assignStereoOrKeystoneToCamera(osg::Camera *camera, osg::DisplaySettings *ds)
bool computeIntersections(const osgGA::GUIEventAdapter &ea, osgUtil::LineSegmentIntersector::Intersections &intersections, osg::Node::NodeMask traversalMask=0xffffffff)
osg::Camera * assignKeystoneDistortionCamera(osg::DisplaySettings *ds, osg::GraphicsContext *gc, int x, int y, int width, int height, GLenum buffer, osg::Texture *texture, Keystone *keystone)
void setDatabasePager(osgDB::DatabasePager *dp)
void setFusionDistance(osgUtil::SceneView::FusionDistanceMode mode, float value=1.0f)
Definition osgViewer/View:227
virtual void requestContinuousUpdate(bool needed=true)
virtual void setSceneData(osg::Node *node)
Scene * getScene()
Definition osgViewer/View:100
EventHandlers & getEventHandlers()
Definition osgViewer/View:197
void setDisplaySettings(const osg::ref_ptr< T > &ds)
Definition osgViewer/View:218
void apply(const osg::ref_ptr< T > &config)
Definition osgViewer/View:243
osgGA::EventQueue * getEventQueue()
Definition osgViewer/View:162
ViewConfig * getLastAppliedViewConfig()
Definition osgViewer/View:245
const EventHandlers & getEventHandlers() const
Definition osgViewer/View:200
osg::DisplaySettings * getDisplaySettings()
Definition osgViewer/View:221
osgDB::DatabasePager * getDatabasePager()
virtual void take(osg::View &rhs)
virtual bool requiresUpdateSceneGraph() const
void removeDevice(osgGA::Device *eventSource)
bool setUpDepthPartition(DepthPartitionSettings *dsp=0)
osg::ref_ptr< osgViewer::Scene > _scene
Definition osgViewer/View:353
virtual void requestWarpPointer(float x, float y)
bool setUpDepthPartitionForCamera(osg::Camera *cameraToPartition, DepthPartitionSettings *dps=0)
std::list< osg::ref_ptr< osgGA::EventHandler > > EventHandlers
Definition osgViewer/View:184
void setImagePager(const osg::ref_ptr< T > &ip)
Definition osgViewer/View:130
virtual bool requiresRedraw() const
virtual ~View()
void setDatabasePager(const osg::ref_ptr< T > &dp)
Definition osgViewer/View:118
View(const osgViewer::View &view, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
const osgGA::CameraManipulator * getCameraManipulator() const
Definition osgViewer/View:177
void setUpViewInWindow(int x, int y, int width, int height, unsigned int screenNum=0)
bool containsCamera(const osg::ref_ptr< T > &camera) const
Definition osgViewer/View:279
void setUpViewForWoWVxDisplay(unsigned int screenNum, unsigned char wow_content, unsigned char wow_factor, unsigned char wow_offset, float wow_disparity_Zd, float wow_disparity_vz, float wow_disparity_M, float wow_disparity_C)
virtual osg::GraphicsOperation * createRenderer(osg::Camera *camera)
const osg::Node * getSceneData() const
Definition osgViewer/View:112
osgUtil::SceneView::FusionDistanceMode _fusionDistanceMode
Definition osgViewer/View:361
void removeEventHandler(osgGA::EventHandler *eventHandler)
void computeActiveCoordinateSystemNodePath()
float _fusionDistanceValue
Definition osgViewer/View:362
const osg::DisplaySettings * getDisplaySettings() const
Definition osgViewer/View:224
bool containsCamera(const osg::Camera *camera) const
ViewerBase * getViewerBase()
Definition osgViewer/View:92
META_Object(osgViewer, View)
Devices & getDevices()
Definition osgViewer/View:152
void setUpViewFor3DSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image *intensityMap=0, const osg::Matrixd &projectorMatrix=osg::Matrixd())
const Devices & getDevices() const
Definition osgViewer/View:153
osg::Timer_t getStartTick() const
Definition osgViewer/View:98
void setEventQueue(osgGA::EventQueue *eventQueue)
Definition osgViewer/View:157
void setUpViewForPanoramicSphericalDisplay(double radius=1.0, double collar=0.45, unsigned int screenNum=0, osg::Image *intensityMap=0, const osg::Matrixd &projectorMatrix=osg::Matrixd())
std::vector< osg::ref_ptr< osgGA::Device > > Devices
Definition osgViewer/View:150
void setDisplaySettings(osg::DisplaySettings *ds)
Definition osgViewer/View:216
void setSceneData(const osg::ref_ptr< T > &node)
Definition osgViewer/View:106
Definition ViewerBase:36
Definition Camera:45
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
Definition DisplaySettings:34
Definition GraphicsContext:30
Definition Image:179
Definition Matrixd:27
Definition Node:72
unsigned int NodeMask
Definition Node:363
Definition Object:61
Definition ObserverNodePath:28
Definition Referenced:44
Definition Texture:422
Definition osg/View:30
Definition observer_ptr:39
Definition ref_ptr:32
T * get() const
Definition ref_ptr:117
author: Julien Valentin 2017 (mp3butcher@hotmail.com)
Definition AlphaFunc:19
std::vector< Node * > NodePath
Definition Node:47
unsigned long long Timer_t
Definition Timer:24
#define OSGVIEWER_EXPORT
Definition osgViewer/Export:40
Definition osgViewer/View:56
virtual bool getDepthRange(osg::View &view, unsigned int partition, double &zNear, double &zFar)
double _zNear
Definition osgViewer/View:68
DepthMode _mode
Definition osgViewer/View:67
DepthPartitionSettings(DepthMode mode=BOUNDING_VOLUME)
double _zMid
Definition osgViewer/View:69
double _zFar
Definition osgViewer/View:70
DepthMode
Definition osgViewer/View:58
@ FIXED_RANGE
Definition osgViewer/View:59
Definition osgViewer/View:323
StereoSlaveCallback(osg::DisplaySettings *ds, double eyeScale)
Definition osgViewer/View:324
double _eyeScale
Definition osgViewer/View:329
osg::ref_ptr< osg::DisplaySettings > _ds
Definition osgViewer/View:328
virtual void updateSlave(osg::View &view, osg::View::Slave &slave)
Definition GraphicsThread:36
Definition osg/View:98