OpenWalnut
1.3.1
|
Class for managing one view to the scene. More...
#include <WGEViewer.h>
Classes | |
class | QueryCallback |
Small class used for querying glGet info during rendering. More... | |
Public Types | |
typedef boost::shared_ptr < WGEViewer > | SPtr |
Convenience typedef. More... | |
typedef boost::shared_ptr < const WGEViewer > | ConstSPtr |
Convenience typedef. More... | |
![]() | |
enum | KeyEvents { KEYPRESS, KEYRELEASE } |
Event types for the keyEvent() handler. More... | |
enum | MouseEvents { MOUSEPRESS, MOUSERELEASE, MOUSEDOUBLECLICK, MOUSEMOVE, MOUSESCROLL } |
Mouse event types for the mouseEvent() handler. More... | |
Public Member Functions | |
WGEViewer (std::string name, osg::ref_ptr< osg::Referenced > wdata, int x, int y, int width, int height, WGECamera::ProjectionMode projectionMode=WGECamera::ORTHOGRAPHIC) | |
Default constructor. More... | |
virtual | ~WGEViewer () |
Destructor. More... | |
virtual void | paint () |
Repaints the contents. More... | |
virtual void | resize (int width, int height) |
Updates size information. More... | |
virtual void | close () |
Close the viewer, but wait for the rendering thread to finish. More... | |
osg::ref_ptr< osgViewer::View > | getView () |
Getter for OpenSceneGraph View instance. More... | |
void | reset () |
Resets the view using the installed manipulator. More... | |
void | setCameraManipulator (osg::ref_ptr< osgGA::MatrixManipulator > manipulator) |
Sets the camera manipulator to use. More... | |
osg::ref_ptr < osgGA::MatrixManipulator > | getCameraManipulator () |
Returns current active camera manipulator. More... | |
void | setCamera (osg::ref_ptr< osg::Camera > camera) |
Sets the current camera. More... | |
osg::ref_ptr< osg::Camera > | getCamera () |
Returns the camera currently in use. More... | |
void | setScene (osg::ref_ptr< WGEGroupNode > node) |
Sets the scene graph node to be used for rendering. More... | |
osg::ref_ptr< WGEGroupNode > | getScene () |
Returns the currently set OSG node. More... | |
std::string | getName () const |
Returns the name of the viewer. More... | |
void | setBgColor (const WColor &bgColor) |
Determine the color of the viewer's background. More... | |
osg::ref_ptr< WPickHandler > | getPickHandler () |
Getter for the pick handler. More... | |
std::string | getOpenGLVendor () const |
Queries the OpenGL vendor info. More... | |
WBoolFlag::SPtr | isFrameRendered () const |
Returns the flag which denotes whether a frame was rendered. More... | |
WGEScreenCapture::RefPtr | getScreenCapture () const |
Returns the main cameras screen capture callback. More... | |
WGEAnimationManipulator::RefPtr | animationMode (bool on=true) |
The (de-)activates the animation mode. More... | |
bool | isAnimationMode () const |
Checks if the viewer is in animation mode. More... | |
![]() | |
WGEGraphicsWindow (osg::ref_ptr< osg::Referenced > wdata, int x, int y, int width, int height) | |
Default constructor. More... | |
virtual | ~WGEGraphicsWindow () |
Destructor. More... | |
osg::ref_ptr < osgViewer::GraphicsWindow > | getGraphicsWindow () |
Getter for m_GraphicsWindow. More... | |
virtual void | keyEvent (KeyEvents eventType, int key) |
Handles key events (if forwarded to this Viewer instance). More... | |
virtual void | mouseEvent (MouseEvents eventType, int x, int y, int button) |
Handles mouse events forwarded from widget. More... | |
Protected Attributes | |
osg::ref_ptr< osgViewer::View > | m_View |
The OpenSceneGraph view used in this (Composite)Viewer. More... | |
std::string | m_name |
The name of the viewer. More... | |
osg::ref_ptr< WPickHandler > | m_pickHandler |
Pointer to the pick handler of the viewer. More... | |
osg::ref_ptr< WGEGroupNode > | m_scene |
reference to the scene which is displayed by viewer More... | |
WBoolFlag::SPtr | m_rendered |
This flag is true and notifies after the first rendered frame. More... | |
osg::ref_ptr< QueryCallback > | m_queryCallback |
The callback used for querying OpenGL features. More... | |
WGEScreenCapture::RefPtr | m_screenCapture |
The screen capture callback. More... | |
bool | m_inAnimationMode |
True -> animation mode on. More... | |
osg::ref_ptr < osgGA::MatrixManipulator > | m_animationModeManipulatorBackup |
The manipulator that was set before entering animation mode. More... | |
![]() | |
osg::ref_ptr < osgViewer::GraphicsWindow > | m_GraphicsWindow |
OpenSceneGraph render window. More... | |
osg::ref_ptr < osg::GraphicsContext > | m_GraphicsContext |
OpenSceneGraph render context. More... | |
osg::ref_ptr< osg::Referenced > | m_WindowData |
Widget window data. More... | |
Additional Inherited Members | |
![]() | |
void | createContext (int x, int y, int width, int height) |
Creates a new OpenGL context in the calling thread. More... | |
Class for managing one view to the scene.
This includes viewport, camera and graphics context. It is, besides WGraphicsEngine, the ONLY entry point for each widget for accessing the graphics engine.
Definition at line 67 of file WGEViewer.h.
typedef boost::shared_ptr< const WGEViewer > WGEViewer::ConstSPtr |
Convenience typedef.
Definition at line 79 of file WGEViewer.h.
typedef boost::shared_ptr< WGEViewer > WGEViewer::SPtr |
Convenience typedef.
Definition at line 74 of file WGEViewer.h.
WGEViewer::WGEViewer | ( | std::string | name, |
osg::ref_ptr< osg::Referenced > | wdata, | ||
int | x, | ||
int | y, | ||
int | width, | ||
int | height, | ||
WGECamera::ProjectionMode | projectionMode = WGECamera::ORTHOGRAPHIC |
||
) |
Default constructor.
name | the name of the viewer |
wdata | the WindowData instance for the widget to use as render widget |
x | X coordinate of widget where to create the context. |
y | Y coordinate of widget where to create the context. |
width | Width of the widget. |
height | Height of the Widget. |
projectionMode | Projection mode of the viewer. |
WGEInitFailed | thrown if initialization of graphics context or graphics window has failed. |
Definition at line 56 of file WGEViewer.cpp.
References WGEGraphicsWindow::m_GraphicsContext, WGEGraphicsWindow::m_GraphicsWindow, m_pickHandler, m_queryCallback, m_rendered, m_screenCapture, and m_View.
|
virtual |
WGEAnimationManipulator::RefPtr WGEViewer::animationMode | ( | bool | on = true ) |
The (de-)activates the animation mode.
In animation mode, a special camera manipulator is used instead of the currently set. This manipulator can then play some animation path in realtime, frame-rate independent or in frame-per-frame mode which is useful if combined with the getScreenCapture() record function.
If animation mode is turned off again, the previously set manipulator / camera setting is restored.
on | true to turn on. |
Definition at line 261 of file WGEViewer.cpp.
References getCameraManipulator(), m_animationModeManipulatorBackup, m_inAnimationMode, and m_View.
|
virtual |
Close the viewer, but wait for the rendering thread to finish.
Reimplemented from WGEGraphicsWindow.
Definition at line 197 of file WGEViewer.cpp.
References WGEGraphicsWindow::close().
Referenced by ~WGEViewer().
osg::ref_ptr< osg::Camera > WGEViewer::getCamera | ( | ) |
Returns the camera currently in use.
Definition at line 154 of file WGEViewer.cpp.
References m_View.
osg::ref_ptr< osgGA::MatrixManipulator > WGEViewer::getCameraManipulator | ( | ) |
Returns current active camera manipulator.
Definition at line 143 of file WGEViewer.cpp.
References m_View.
Referenced by animationMode().
std::string WGEViewer::getName | ( | ) | const |
Returns the name of the viewer.
Definition at line 203 of file WGEViewer.cpp.
References m_name.
std::string WGEViewer::getOpenGLVendor | ( | ) | const |
Queries the OpenGL vendor info.
Definition at line 223 of file WGEViewer.cpp.
References m_queryCallback.
osg::ref_ptr< WPickHandler > WGEViewer::getPickHandler | ( | ) |
Getter for the pick handler.
Definition at line 208 of file WGEViewer.cpp.
References m_pickHandler.
osg::ref_ptr< WGEGroupNode > WGEViewer::getScene | ( | ) |
Returns the currently set OSG node.
Definition at line 165 of file WGEViewer.cpp.
References m_scene.
WGEScreenCapture::RefPtr WGEViewer::getScreenCapture | ( | ) | const |
Returns the main cameras screen capture callback.
Definition at line 218 of file WGEViewer.cpp.
References m_screenCapture.
osg::ref_ptr< osgViewer::View > WGEViewer::getView | ( | ) |
Getter for OpenSceneGraph View instance.
Definition at line 130 of file WGEViewer.cpp.
References m_View.
bool WGEViewer::isAnimationMode | ( | ) | const |
Checks if the viewer is in animation mode.
Definition at line 292 of file WGEViewer.cpp.
References m_inAnimationMode.
WBoolFlag::SPtr WGEViewer::isFrameRendered | ( | ) | const |
Returns the flag which denotes whether a frame was rendered.
Definition at line 228 of file WGEViewer.cpp.
References m_rendered.
|
virtual |
void WGEViewer::reset | ( | ) |
Resets the view using the installed manipulator.
Definition at line 213 of file WGEViewer.cpp.
References m_View.
|
virtual |
Updates size information.
Also updates camera.
width | new width. |
height | new height. |
Reimplemented from WGEGraphicsWindow.
Definition at line 182 of file WGEViewer.cpp.
References m_View, WGECamera::resize(), and WGEGraphicsWindow::resize().
void WGEViewer::setBgColor | ( | const WColor & | bgColor) |
Determine the color of the viewer's background.
bgColor | the new background color |
Definition at line 170 of file WGEViewer.cpp.
References m_View.
void WGEViewer::setCamera | ( | osg::ref_ptr< osg::Camera > | camera) |
Sets the current camera.
camera | the OSG camera instance. |
Definition at line 148 of file WGEViewer.cpp.
References m_View.
void WGEViewer::setCameraManipulator | ( | osg::ref_ptr< osgGA::MatrixManipulator > | manipulator) |
Sets the camera manipulator to use.
manipulator | the manipulator to use. |
Definition at line 135 of file WGEViewer.cpp.
References m_inAnimationMode, and m_View.
void WGEViewer::setScene | ( | osg::ref_ptr< WGEGroupNode > | node) |
Sets the scene graph node to be used for rendering.
node | part of the scene graph |
Definition at line 159 of file WGEViewer.cpp.
|
protected |
The manipulator that was set before entering animation mode.
Null if not in animation mode.
Definition at line 339 of file WGEViewer.h.
Referenced by animationMode().
|
protected |
True -> animation mode on.
Definition at line 334 of file WGEViewer.h.
Referenced by animationMode(), isAnimationMode(), and setCameraManipulator().
|
protected |
|
protected |
Pointer to the pick handler of the viewer.
Definition at line 258 of file WGEViewer.h.
Referenced by getPickHandler(), and WGEViewer().
|
protected |
The callback used for querying OpenGL features.
Definition at line 323 of file WGEViewer.h.
Referenced by getOpenGLVendor(), and WGEViewer().
|
protected |
This flag is true and notifies after the first rendered frame.
Definition at line 268 of file WGEViewer.h.
Referenced by isFrameRendered(), and WGEViewer().
|
protected |
reference to the scene which is displayed by viewer
Definition at line 263 of file WGEViewer.h.
Referenced by getScene(), and setScene().
|
protected |
The screen capture callback.
Definition at line 329 of file WGEViewer.h.
Referenced by getScreenCapture(), and WGEViewer().
|
protected |
The OpenSceneGraph view used in this (Composite)Viewer.
Definition at line 247 of file WGEViewer.h.
Referenced by animationMode(), getCamera(), getCameraManipulator(), getView(), paint(), reset(), resize(), setBgColor(), setCamera(), setCameraManipulator(), setScene(), and WGEViewer().