WGEGraphicsWindow Class Reference

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

#include <WGEGraphicsWindow.h>

Inheritance diagram for WGEGraphicsWindow:

Collaboration 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. More...
virtual	~WGEGraphicsWindow ()
	Destructor. More...
osg::ref_ptr< osgViewer::GraphicsWindow >	getGraphicsWindow ()
	Getter for m_GraphicsWindow. More...
virtual void	resize (int width, int height)
	Updates size information. More...
virtual void	close ()
	Initiates a close event for this viewer. 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...
virtual bool	isClosed () const
	Check if the windows is open. More...
virtual void	setClosed (bool closed=true)
	Set closed state. More...

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

Private Attributes
bool	m_closed
	Mark the window opened or closed. More...

Detailed Description

Class managing a single graphics context and OSG GraphicsWindow.

Definition at line 36 of file WGEGraphicsWindow.h.

Member Enumeration Documentation

KeyEvents

enum WGEGraphicsWindow::KeyEvents

Event types for the keyEvent() handler.

Definition at line 66 of file WGEGraphicsWindow.h.

MouseEvents

enum WGEGraphicsWindow::MouseEvents

Mouse event types for the mouseEvent() handler.

Definition at line 74 of file WGEGraphicsWindow.h.

Constructor & Destructor Documentation

WGEGraphicsWindow()

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

Default constructor.

Parameters

wdata	the WindowData instance for the widget to use as render widget. NULL on Mac!
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.

Exceptions

WGEInitFailed

thrown if initialization of graphics context or graphics window has failed.

Definition at line 33 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

~WGEGraphicsWindow()

WGEGraphicsWindow::~WGEGraphicsWindow ( )

virtual

Destructor.

Definition at line 39 of file WGEGraphicsWindow.cpp.

Member Function Documentation

close()

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 60 of file WGEGraphicsWindow.cpp.

References setClosed().

Referenced by WGEViewer::close().

Here is the call graph for this function:

Here is the caller graph for this function:

getGraphicsWindow()

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

(

)

Getter for m_GraphicsWindow.

Returns

the OSG GraphicsWindow instance.

Definition at line 44 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

isClosed()

bool WGEGraphicsWindow::isClosed ( ) const

virtual

Check if the windows is open.

Returns

false if the window is not open anymore.

Definition at line 112 of file WGEGraphicsWindow.cpp.

References m_closed.

keyEvent()

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

virtual

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

Parameters

key	the key code.
eventType	the type of event.

Definition at line 68 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

mouseEvent()

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

virtual

Handles mouse events forwarded from widget.

Parameters

eventType	the event type.
x	x coordinate of event.
y	y coordinate of event.
button	mouse button.

Definition at line 86 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

resize()

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

virtual

Updates size information.

Parameters

width	new width.
height	new height.

Reimplemented in WGEViewer.

Definition at line 49 of file WGEGraphicsWindow.cpp.

References m_GraphicsWindow.

Referenced by WGEViewer::resize().

Here is the caller graph for this function:

setClosed()

void WGEGraphicsWindow::setClosed ( bool  closed = true )

virtual

Set closed state.

Parameters

closed

true if widget should be marked as closed.

Definition at line 117 of file WGEGraphicsWindow.cpp.

References m_closed.

Referenced by close().

Here is the caller graph for this function:

Member Data Documentation

m_closed

bool WGEGraphicsWindow::m_closed

private

Mark the window opened or closed.

Definition at line 135 of file WGEGraphicsWindow.h.

Referenced by isClosed(), and setClosed().

m_GraphicsWindow

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

protected

OpenSceneGraph render window.

Definition at line 129 of file WGEGraphicsWindow.h.

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

---

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

• WGEGraphicsWindow.h
• WGEGraphicsWindow.cpp