OpenWalnut 1.2.5
Classes | Public Member Functions | Protected Attributes
WGEViewer Class Reference

Class for managing one view to the scene. More...

#include <WGEViewer.h>

Inheritance diagram for WGEViewer:

List of all members.

Classes

class  QueryCallback
 Small class used for querying glGet info during rendering. 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.
virtual ~WGEViewer ()
 Destructor.
virtual void paint ()
 Repaints the contents.
virtual void resize (int width, int height)
 Updates size information.
virtual void close ()
 Close the viewer, but wait for the rendering thread to finish.
osg::ref_ptr< osgViewer::View > getView ()
 Getter for OpenSceneGraph View instance.
void reset ()
 Resets the view using the installed manipulator.
void setCameraManipulator (osg::ref_ptr< osgGA::MatrixManipulator > manipulator)
 Sets the camera manipulator to use.
osg::ref_ptr
< osgGA::MatrixManipulator > 
getCameraManipulator ()
 Returns current active camera manipulator.
void setCamera (osg::ref_ptr< osg::Camera > camera)
 Sets the current camera.
osg::ref_ptr< osg::Camera > getCamera ()
 Returns the camera currently in use.
void setScene (osg::ref_ptr< WGEGroupNode > node)
 Sets the scene graph node to be used for rendering.
osg::ref_ptr< WGEGroupNodegetScene ()
 Returns the currently set OSG node.
std::string getName () const
 Returns the name of the viewer.
void setBgColor (const WColor &bgColor)
 Determine the color of the viewer's background.
osg::ref_ptr< WPickHandlergetPickHandler ()
 Getter for the pick handler.
std::string getOpenGLVendor () const
 Queries the OpenGL vendor info.
WBoolFlag::SPtr isFrameRendered () const
 Returns the flag which denotes whether a frame was rendered.

Protected Attributes

osg::ref_ptr< osgViewer::View > m_View
 The OpenSceneGraph view used in this (Composite)Viewer.
std::string m_name
 The name of the viewer.
osg::ref_ptr< WPickHandlerm_pickHandler
 Pointer to the pick handler of the viewer.
osg::ref_ptr< WGEGroupNodem_scene
 reference to the scene which is displayed by viewer
WBoolFlag::SPtr m_rendered
 This flag is true and notifies after the first rendered frame.
osg::ref_ptr< QueryCallbackm_queryCallback
 The callback used for querying OpenGL features.

Detailed Description

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 68 of file WGEViewer.h.


Constructor & Destructor Documentation

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.

Parameters:
namethe name of the viewer
wdatathe WindowData instance for the widget to use as render widget
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.
projectionModeProjection mode of the viewer.
Exceptions:
WGEInitFailedthrown if initialization of graphics context or graphics window has failed.

Definition at line 53 of file WGEViewer.cpp.

References WGEGraphicsWindow::m_GraphicsContext, WGEGraphicsWindow::m_GraphicsWindow, m_pickHandler, m_queryCallback, m_rendered, and m_View.

WGEViewer::~WGEViewer ( ) [virtual]

Destructor.

Definition at line 113 of file WGEViewer.cpp.

References close().


Member Function Documentation

void WGEViewer::close ( ) [virtual]

Close the viewer, but wait for the rendering thread to finish.

Reimplemented from WGEGraphicsWindow.

Definition at line 189 of file WGEViewer.cpp.

Referenced by ~WGEViewer().

osg::ref_ptr< osg::Camera > WGEViewer::getCamera ( )

Returns the camera currently in use.

Returns:
the camera currently in use.

Definition at line 146 of file WGEViewer.cpp.

References m_View.

osg::ref_ptr< osgGA::MatrixManipulator > WGEViewer::getCameraManipulator ( )

Returns current active camera manipulator.

Returns:
the active camera manipulator.

Definition at line 135 of file WGEViewer.cpp.

References m_View.

std::string WGEViewer::getName ( ) const

Returns the name of the viewer.

Returns:
the name

Definition at line 195 of file WGEViewer.cpp.

References m_name.

std::string WGEViewer::getOpenGLVendor ( ) const

Queries the OpenGL vendor info.

Returns:
Vendor string.

Definition at line 210 of file WGEViewer.cpp.

References m_queryCallback.

osg::ref_ptr< WPickHandler > WGEViewer::getPickHandler ( )

Getter for the pick handler.

Returns:
the pick handler

Definition at line 200 of file WGEViewer.cpp.

References m_pickHandler.

osg::ref_ptr< WGEGroupNode > WGEViewer::getScene ( )

Returns the currently set OSG node.

Returns:
the node.

Definition at line 157 of file WGEViewer.cpp.

References m_scene.

osg::ref_ptr< osgViewer::View > WGEViewer::getView ( )

Getter for OpenSceneGraph View instance.

Returns:
the OSG Viewer instance.

Definition at line 124 of file WGEViewer.cpp.

References m_View.

WBoolFlag::SPtr WGEViewer::isFrameRendered ( ) const

Returns the flag which denotes whether a frame was rendered.

Returns:
the flag.

Definition at line 215 of file WGEViewer.cpp.

References m_rendered.

void WGEViewer::paint ( ) [virtual]

Repaints the contents.

Mac only.

Definition at line 167 of file WGEViewer.cpp.

References m_View.

void WGEViewer::reset ( )

Resets the view using the installed manipulator.

Definition at line 205 of file WGEViewer.cpp.

References m_View.

void WGEViewer::resize ( int  width,
int  height 
) [virtual]

Updates size information.

Also updates camera.

Parameters:
widthnew width.
heightnew height.

Reimplemented from WGEGraphicsWindow.

Definition at line 174 of file WGEViewer.cpp.

References m_View, and WGECamera::resize().

void WGEViewer::setBgColor ( const WColor &  bgColor)

Determine the color of the viewer's background.

Parameters:
bgColorthe new background color

Definition at line 162 of file WGEViewer.cpp.

References m_View.

void WGEViewer::setCamera ( osg::ref_ptr< osg::Camera >  camera)

Sets the current camera.

Parameters:
camerathe OSG camera instance.

Definition at line 140 of file WGEViewer.cpp.

References m_View.

void WGEViewer::setCameraManipulator ( osg::ref_ptr< osgGA::MatrixManipulator >  manipulator)

Sets the camera manipulator to use.

Parameters:
manipulatorthe manipulator to use.

Definition at line 129 of file WGEViewer.cpp.

References m_View.

void WGEViewer::setScene ( osg::ref_ptr< WGEGroupNode node)

Sets the scene graph node to be used for rendering.

Parameters:
nodepart of the scene graph

Definition at line 151 of file WGEViewer.cpp.

References m_scene, and m_View.


Member Data Documentation

std::string WGEViewer::m_name [protected]

The name of the viewer.

Definition at line 214 of file WGEViewer.h.

Referenced by getName().

osg::ref_ptr<WPickHandler> WGEViewer::m_pickHandler [protected]

Pointer to the pick handler of the viewer.

Definition at line 219 of file WGEViewer.h.

Referenced by getPickHandler(), and WGEViewer().

osg::ref_ptr< QueryCallback > WGEViewer::m_queryCallback [protected]

The callback used for querying OpenGL features.

Definition at line 284 of file WGEViewer.h.

Referenced by getOpenGLVendor(), and WGEViewer().

This flag is true and notifies after the first rendered frame.

Definition at line 229 of file WGEViewer.h.

Referenced by isFrameRendered(), and WGEViewer().

osg::ref_ptr< WGEGroupNode > WGEViewer::m_scene [protected]

reference to the scene which is displayed by viewer

Definition at line 224 of file WGEViewer.h.

Referenced by getScene(), and setScene().

osg::ref_ptr< osgViewer::View > WGEViewer::m_View [protected]

The OpenSceneGraph view used in this (Composite)Viewer.

Definition at line 208 of file WGEViewer.h.

Referenced by getCamera(), getCameraManipulator(), getView(), paint(), reset(), resize(), setBgColor(), setCamera(), setCameraManipulator(), setScene(), and WGEViewer().


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends