OpenWalnut  1.4.0
Public Types | Public Member Functions | Protected Attributes | Private Attributes
WGEGraphicsWindow Class Reference

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

#include <WGEGraphicsWindow.h>

+ Inheritance diagram for WGEGraphicsWindow:

List of all members.

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.
virtual bool isClosed () const
 Check if the windows is open.
virtual void setClosed (bool closed=true)
 Set closed state.

Protected Attributes

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

Private Attributes

bool m_closed
 Mark the window opened or closed.

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.

Destructor.

Definition at line 60 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 112 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 65 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

bool WGEGraphicsWindow::isClosed ( ) const [virtual]

Check if the windows is open.

Returns:
false if the window is not open anymore.

Definition at line 152 of file WGEGraphicsWindow.cpp.

References m_closed.

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 117 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 130 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 106 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

void WGEGraphicsWindow::setClosed ( bool  closed = true) [virtual]

Set closed state.

Parameters:
closedtrue if widget should be marked as closed.

Definition at line 157 of file WGEGraphicsWindow.cpp.

References m_closed.


Member Data Documentation

Mark the window opened or closed.

Definition at line 157 of file WGEGraphicsWindow.h.

Referenced by isClosed(), and setClosed().

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

OpenSceneGraph render window.

Definition at line 130 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: