OpenWalnut  1.3.1
Public Types | Public Member Functions | Protected Attributes | List of all members
WGEGraphicsWindow Class Reference

Class managing a single graphics context and OSG GraphicsWindow. More...

#include <WGEGraphicsWindow.h>

+ Inheritance diagram for WGEGraphicsWindow:

Public Types

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

 WGEGraphicsWindow (osg::ref_ptr< osg::Referenced > wdata, int x, int y, int width, int height)
 Default constructor.
virtual ~WGEGraphicsWindow ()
 Destructor.
osg::ref_ptr
< osgViewer::GraphicsWindow > 
getGraphicsWindow ()
 Getter for m_GraphicsWindow.
virtual void resize (int width, int height)
 Updates size information.
virtual void close ()
 Initiates a close event for this viewer.
virtual void keyEvent (KeyEvents eventType, int key)
 Handles key events (if forwarded to this Viewer instance).
virtual void mouseEvent (MouseEvents eventType, int x, int y, int button)
 Handles mouse events forwarded from widget.

Protected Attributes

osg::ref_ptr
< osgViewer::GraphicsWindow > 
m_GraphicsWindow
 OpenSceneGraph render window.

Detailed Description

Class managing a single graphics context and OSG GraphicsWindow.

Definition at line 37 of file WGEGraphicsWindow.h.

Member Enumeration Documentation

Event types for the keyEvent() handler.

Definition at line 67 of file WGEGraphicsWindow.h.

Mouse event types for the mouseEvent() handler.

Definition at line 75 of file WGEGraphicsWindow.h.

Constructor & Destructor Documentation

WGEGraphicsWindow::WGEGraphicsWindow ( osg::ref_ptr< osg::Referenced >  wdata,
int  x,
int  y,
int  width,
int  height 
)

Default constructor.

Parameters
wdatathe WindowData instance for the widget to use as render widget. NULL on Mac!
xX coordinate of widget where to create the context.
yY coordinate of widget where to create the context.
widthWidth of the widget.
heightHeight of the Widget.
Exceptions
WGEInitFailedthrown if initialization of graphics context or graphics window has failed.

Definition at line 31 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

WGEGraphicsWindow::~WGEGraphicsWindow ( )
virtual

Destructor.

Definition at line 59 of file WGEGraphicsWindow.cpp.

Member Function Documentation

void WGEGraphicsWindow::close ( )
virtual

Initiates a close event for this viewer.

It destroys the graphics context and invalidates the viewer. This should be called whenever a QT Widget closes to also free its OSG Viewer resources.

Reimplemented in WGEViewer.

Definition at line 119 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

osg::ref_ptr< osgViewer::GraphicsWindow > WGEGraphicsWindow::getGraphicsWindow ( )

Getter for m_GraphicsWindow.

Returns
the OSG GraphicsWindow instance.

Definition at line 64 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

void WGEGraphicsWindow::keyEvent ( KeyEvents  eventType,
int  key 
)
virtual

Handles key events (if forwarded to this Viewer instance).

Parameters
keythe key code.
eventTypethe type of event.

Definition at line 124 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

void WGEGraphicsWindow::mouseEvent ( MouseEvents  eventType,
int  x,
int  y,
int  button 
)
virtual

Handles mouse events forwarded from widget.

Parameters
eventTypethe event type.
xx coordinate of event.
yy coordinate of event.
buttonmouse button.

Definition at line 137 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

void WGEGraphicsWindow::resize ( int  width,
int  height 
)
virtual

Updates size information.

Parameters
widthnew width.
heightnew height.

Reimplemented in WGEViewer.

Definition at line 113 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

Member Data Documentation

osg::ref_ptr<osgViewer::GraphicsWindow> WGEGraphicsWindow::m_GraphicsWindow
protected

OpenSceneGraph render window.

Definition at line 116 of file WGEGraphicsWindow.h.

Referenced by close(), getGraphicsWindow(), keyEvent(), mouseEvent(), resize(), WGEGraphicsWindow(), and WGEViewer::WGEViewer().


The documentation for this class was generated from the following files: