ViewportWidget Class Reference

Class for a 3D viewport widget powered by OGRE. More...

#include <ViewportWidget.h>

Collaboration diagram for ViewportWidget:

List of all members.

Public Slots

void applyViewingParameters (ViewingParameters *viewingParameters)

Applies the given viewing parameters to the viewport's viewing parameters.

void setImage (unsigned int stageIndex, Ogre::TexturePtr image)

Sets the image that should be displayed in the viewport.

void homeView ()

Resets the viewport's view settings.

void setWireframe (bool wireframe)

Activates or deactivates wireframe view in the viewport.

void setBackfaceCulling (bool backfaceCulling)

Activates or deactivates the omission of polygons facing away from the camera.

void toggleOrigin ()

Toggles the display of the point of origin in the viewport.

void toggleCenterPoint ()

Toggles the display of the center point in the viewport.

void toggleOrientationIndicator ()

Toggles the display of the orientation indicator in the viewport.

void toggleGrid ()

Toggles the display of the coordinate grid in the viewport.

Signals

void objectSelected (const QString &objectName, bool toggle)

Signal that is emitted when an object in the viewport has been clicked.

void viewChanged (ViewingParameters *viewingParameters)

Signal that is emitted when the viewing parameters have changed.

void frameSelectedObjectsRequested (ViewingParameters *viewingParameters)

Signal that is emitted when the selected objects in the viewport should be framed by the viewport's camera.

void renderingTriggered ()

Rendering process has been initiated.

Public Member Functions

ViewportWidget (QWidget *parent=0, unsigned int stageIndex=1, bool fullscreen=false, bool stereo=false, int width=1024, int height=768)

Constructor of the ViewportWidget class.

virtual ~ViewportWidget ()

Destructor of the ViewportWidget class.

virtual QPaintEngine * paintEngine () const

Returns a pointer to the paint engine used for drawing on the device.

unsigned int getStageIndex ()

Returns the index of the stage to display in the viewport.

void setStageIndex (unsigned int stageIndex)

Sets the index of the stage to display in the viewport.

void setViewMode (bool viewMode)

Activates or deactivates the view mode in the viewport widget.

void frameSelectedObjects ()

Centers the viewport's view on currently selected objects.

void setFog (bool enabled, double density)

Sets the fog parameters of the viewport.

QColor getFogColor ()

Returns the fog color of the scene.

void setFogColor (const QColor &color)

Sets the fog color of the scene.

QColor getBackgroundColor ()

Returns the background color of the scene.

void setBackgroundColor (const QColor &color)

Sets the background color of the scene.

void setFullscreen (bool fullscreen, int width, int height)

Sets fullscreen mode for the viewport widget.

void getStereoParameters (double &rttWidth, double &rttHeight, double &eyeDist, double &fOffsetMultiplier, double &nearClip, double &farClip, double &fov, double &focalLength)

Fills the given variables with stereo parameter values.

void setStereoParameters (const unsigned int rttWidth, const unsigned int rttHeight, const float eyeDist, const float fOffsetMultiplier, const float nearClip, const float farClip, const float fov, const float focalLength)

Sets the stereo parameters to the given values.

void setStereo (bool enable)

Toggles the stereo mode for the viewport widget.

void setOverlayOnly (bool enable)

Sets whether only overlays (no geometry) should be displayed in viewport.

float getFps ()

Returns the current number of frames per second rendered in the viewport.

int getTriangleCount ()

Returns the number of triangles last rendered in the viewport.

ViewingParameters * getViewingParameters ()

Returns the viewing parameter's of the currently active camera.

Protected Member Functions

virtual void resizeEvent (QResizeEvent *event)

Handles resize events for the widget.

virtual void paintEvent (QPaintEvent *event)

Handles paint events for the widget.

virtual void mousePressEvent (QMouseEvent *event)

Handles mouse press events for the widget.

virtual void mouseMoveEvent (QMouseEvent *event)

Handles mouse move events for the widget.

virtual void mouseReleaseEvent (QMouseEvent *event)

Handles mouse release events for the widget.

virtual void wheelEvent (QWheelEvent *event)

Handles mouse wheel events for the widget.

Protected Attributes

unsigned int m_stageIndex

The index of the stage to display in the viewport.

bool m_showOverlays

Show overlays.

bool m_fullscreen

Flag that states whether the widget is used in fullscreen mode.

bool m_stereo

Flag that states whether stereo viewing is activated.

float m_stereoEyeDist

Stereo view parameters.

float m_stereoFOffsetMultiplier

float m_stereoNearClip

float m_stereoFarClip

float m_stereoFov

float m_stereoFocalLength

unsigned int m_stereoRttWidth

unsigned int m_stereoRttHeight

int m_width

The width of the viewport when in fullscreen mode.

int m_height

The height of the viewport when in fullscreen mode.

Ogre::RenderWindow * m_renderWindow

The OGRE render window to use in the viewport widget.

Ogre::SceneManager * m_sceneManager

The main OGRE scene manager.

Ogre::SceneNode * m_cameraSceneNode

The main viewport's viewing camera scene node.

Ogre::MaterialPtr m_imageMaterial

Material for the viewport's image overlay that is used to display image results from nodes.

Ogre::Camera * m_camera

The viewport's viewing cameras.

Ogre::Camera * m_camera0

Ogre::Camera * m_camera1

Ogre::Camera * m_camera2

Ogre::Camera * m_camera3

Ogre::Camera * m_camera4

QString m_cameraName

The current camera name.

Ogre::Light * m_headLight

The viewing camera's light.

Ogre::CompositorInstance * m_stereoCompositor

The stereo compositor.

Ogre::RenderTarget * m_stereoRenderTarget

The stereo OGRE texture render target.

Ogre::Viewport * m_viewport

The OGRE viewports.

Ogre::Viewport * m_stereoViewport0

Ogre::Viewport * m_stereoViewport1

Ogre::Viewport * m_stereoViewport2

Ogre::Viewport * m_stereoViewport3

Ogre::Viewport * m_stereoViewport4

Ogre::ColourValue m_backgroundColor

The background color of the viewport.

Ogre::ColourValue m_fogColor

The fog color of the scene.

Ogre::SceneNode * m_orientationIndicatorCameraSceneNode

The orientation indicator viewport's camera scene node.

Ogre::Camera * m_orientationIndicatorCamera

The orientation indicator viewport's camera.

Ogre::Viewport * m_orientationIndicatorViewport

The orientation indicator viewport to display axes that show the main camera's orientation.

Ogre::Overlay * m_labelOverlay

The overlay for all text information panel overlay elements.

Ogre::Overlay * m_imageOverlay

The overlay for the image panel overlay element.

Ogre::Overlay * m_maskOverlay

The overlay for all mask panel overlay elements.

Ogre::PanelOverlayElement * m_leftTopHudPanel

The panel overlay element used for displaying text information in the top left corner of the viewport.

Ogre::TextAreaOverlayElement * m_leftTopHudTextArea

The text area overlay element used for displaying text information in the top left corner of the viewport.

Ogre::PanelOverlayElement * m_imagePanel

The panel overlay element used for displaying an image.

Ogre::PanelOverlayElement * m_topMaskPanel

The panel overlay element used for masking the top of the viewport.

Ogre::PanelOverlayElement * m_bottomMaskPanel

The panel overlay element used for masking the bottom of the viewport.

Ogre::PanelOverlayElement * m_leftMaskPanel

The panel overlay element used for masking the left of the viewport.

Ogre::PanelOverlayElement * m_rightMaskPanel

The panel overlay element used for masking the right of the viewport.

Ogre::SceneNode * m_viewportObjectsSceneNode

The node that all exclusive viewport object scene nodes will be attached to.

Ogre::SceneNode * m_originSceneNode

The node that the coordinate system's origin axes will be attached to.

Ogre::SceneNode * m_centerPointSceneNode

The node that the center axes will be attached to.

Ogre::SceneNode * m_orientationIndicatorSceneNode

The node that the orientation indicator will be attached to.

Ogre::SceneNode * m_gridSceneNode

The node that the coordinate grid will be attached to.

bool m_viewMode

Flag that states whether the viewing mode is activated.

QPoint m_lastPosition

The last position of the mouse pointer over the viewport.

ViewingParameters * m_viewingParameters

The viewing parameters for the viewport's active camera.

bool m_wireframe

Flag that states whether wireframe view is activated.

bool m_backfaceCulling

Flag that states whether backface culling is activated.

bool m_showOrigin

Flag that states whether the origin should be visible in the viewport.

bool m_showCenterPoint

Flag that states whether the center should be visible in the viewport.

bool m_showOrientationIndicator

Flag that states whether the orientation indicator is shown in the widget.

bool m_showGrid

Flag that states whether the grid should be visible in the viewport.

bool m_overlayOnly

Flag that states whether the geometry should be visible.

Ogre::TexturePtr m_tmpTexture

DEBUG: NILZ:.

float m_dbgColor

Private Member Functions

Ogre::String createUniqueName (const QString &objectName)

Creates a unique name from the given object name by adding the viewport widget's index.

bool createRenderWindow ()

Creates the OGRE render window.

void initializeResources ()

Initializes the resources that will be available to OGRE.

void createViewportObjects ()

Creates basic viewport objects like the viewing camera, the head light, coordinate axes and the grid.

void createOverlays ()

Creates overlay layers for visual components that will be rendered on top of the main scene layer.

void render ()

Redraws the OGRE scene into the viewport widget.

void updateView ()

Calculates the transformation of the viewport's camera according to the current viewing angles, the viewing radius, and the center of view.

Ogre::MaterialPtr createColorMaterial (const Ogre::String &group, const Ogre::String &name, const Ogre::ColourValue &color, bool wireframe=false)

Creates a self-illuminating material with the given name and color under the given group name.

void createAxes (const QString &name, Ogre::SceneNode *parentNode, Ogre::uint32 visibilityFlags=VF_MAIN_VIEWPORT)

Creates three manual objects for X, Y and Z axes with the given name and attaches them to the given parent scene node. The axes will each have a length of 1.

void createGrid (Ogre::SceneNode *parentNode)

Creates a coordinate grid and attaches it to the given parent scene node.

Ogre::SceneNode * getClickedSceneNode (const QPointF &mousePosition)

Returns the scene node that is located under the given mouse position in the viewport.

Static Private Attributes

static unsigned int s_viewportIndex = 0

The index of the next viewport widget to create.

static Ogre::MaterialPtr s_redMaterial

Material for self-illuminating red objects (like coordinate X axes).

static Ogre::MaterialPtr s_greenMaterial

Material for self-illuminating green objects (like coordinate Y axes).

static Ogre::MaterialPtr s_blueMaterial

Material for self-illuminating blue objects (like coordinate Z axes).

static Ogre::MaterialPtr s_grayMaterial

Material for self-illuminating gray objects.

static Ogre::MaterialPtr s_blackMaterial

Material for self-illuminating black objects.

static Ogre::MaterialPtr s_defaultMaterial

Default material to use in shaded mode.

static Ogre::MaterialPtr s_nullMaterial

Material for Null objects.

static Ogre::MaterialPtr s_maskMaterial

Material for semi-transparent mask overlays.

Detailed Description

Class for a 3D viewport widget powered by OGRE.

Inheritance Diagram

[legend]

Constructor & Destructor Documentation

ViewportWidget::ViewportWidget	(	QWidget *	parent = `0`,
		unsigned int	stageIndex = `1`,
		bool	fullscreen = `false`,
		bool	stereo = `false`,
		int	width = `1024`,
		int	height = `768`
	)

Constructor of the ViewportWidget class.

Constructors and Destructors.

Parameters:

	parent	The parent widget the created instance will be a child of.
	stageIndex	The index of the stage to display in the viewport.
	fullscreen	Flag that controls whether the widget is used in fullscreen mode.
	stereo	Flag that controls whether the widget is used in stereo mode.
	width	The width of the viewport when in fullscreen mode.
	height	The height of the viewport when in fullscreen mode.

Constructor of the ViewportWidget class.

Parameters:

	parent	The parent widget the created instance will be a child of.
	stageIndex	The index of the stage to display in the viewport.
	fullscreen	Flag that controls whether the widget is used in fullscreen mode.
	width	The width of the viewport when in fullscreen mode.
	height	The height of the viewport when in fullscreen mode.

ViewportWidget::~ViewportWidget ( ) [virtual]

Destructor of the ViewportWidget class.

Defined virtual to guarantee that the destructor of a derived class will be called if the instance of the derived class is saved in a variable of its parent class type.

Member Function Documentation

QPaintEngine * ViewportWidget::paintEngine ( ) const [virtual]

Returns a pointer to the paint engine used for drawing on the device.

Public Functions.

Returning 0 by this function fixes the widget flickering bug in Qt 4.5.

Returns:: 0.

Returns a pointer to the paint engine used for drawing on the device.

Returning 0 by this function fixes the widget flickering bug in Qt 4.5.

Returns:: 0.

unsigned int ViewportWidget::getStageIndex ( )

Returns the index of the stage to display in the viewport.

Returns:: The index of the stage to display in the viewport.

void ViewportWidget::setStageIndex ( unsigned int stageIndex )

Sets the index of the stage to display in the viewport.

Parameters:

stageIndex

The index of the new stage to display in the viewport.

void ViewportWidget::setViewMode ( bool viewMode )

Activates or deactivates the view mode in the viewport widget.

Parameters:

viewMode

The new value for the view mode flag.

void ViewportWidget::frameSelectedObjects ( )

Centers the viewport's view on currently selected objects.

void ViewportWidget::setFog	(	bool	enabled,
		double	density
	)

Sets the fog parameters of the viewport.

Parameters:

	enabled	Sets whether fog is enabled or not.
	density	Sets the density of the fog (exponential).

QColor ViewportWidget::getFogColor ( )

Returns the fog color of the scene.

Returns:: Fog color of the scene.

void ViewportWidget::setFogColor ( const QColor & color )

Sets the fog color of the scene.

Parameters:

color

Fog color of the scene.

QColor ViewportWidget::getBackgroundColor ( )

Returns the background color of the scene.

Returns:: Fog background of the scene.

void ViewportWidget::setBackgroundColor ( const QColor & color )

Sets the background color of the scene.

Parameters:

color

Background color of the scene.

void ViewportWidget::setFullscreen	(	bool	fullscreen,
		int	width,
		int	height
	)

Sets fullscreen mode for the viewport widget.

Parameters:

	fullscreen	Flag to control whether to enable fullscreen mode.
	width	The width of the viewport in fullscreen mode.
	height	The height of the viewport in fullscreen mode.

void ViewportWidget::getStereoParameters	(	double &	rttWidth,
		double &	rttHeight,
		double &	eyeDist,
		double &	fOffsetMultiplier,
		double &	nearClip,
		double &	farClip,
		double &	fov,
		double &	focalLength
	)

Fills the given variables with stereo parameter values.

Parameters:

	rttWidth	The width of the render texture.
	rttHeight	The height of the render texture.
	eyeDist	The viewer's eye distance.
	fOffsetMultiplier	A multiplier to calculate the frustum offset from the camera position.
	nearClip	The near clipping plane of the camera.
	farClip	The far clippping plane of the camera.
	fov	The camera's field of view setting.
	focalLength	The camera's focal length setting.

void ViewportWidget::setStereoParameters	(	const unsigned int	rttWidth,
		const unsigned int	rttHeight,
		const float	eyeDist,
		const float	fOffsetMultiplier,
		const float	nearClip,
		const float	farClip,
		const float	fov,
		const float	focalLength
	)

Sets the stereo parameters to the given values.

Parameters:

	rttWidth	The width of the render texture.
	rttHeight	The height of the render texture.
	eyeDist	The viewer's eye distance.
	fOffsetMultiplier	A multiplier to calculate the frustum offset from the camera position.
	nearClip	The near clipping plane of the camera.
	farClip	The far clippping plane of the camera.
	fov	The camera's field of view setting.
	focalLength	The camera's focal length setting.

void ViewportWidget::setStereo ( bool enable )

Toggles the stereo mode for the viewport widget.

Parameters:

enable

Flag to enable or disable the stereo mode for the viewport widget.

void ViewportWidget::setOverlayOnly ( bool enable )

Sets whether only overlays (no geometry) should be displayed in viewport.

Parameters:

enable

If true no geometry will be displayed.

float ViewportWidget::getFps ( )

Returns the current number of frames per second rendered in the viewport.

Returns:: The current number of frames per second rendered in the viewport.

int ViewportWidget::getTriangleCount ( )

Returns the number of triangles last rendered in the viewport.

Returns:: The number of triangles last rendered in the viewport.

ViewingParameters * ViewportWidget::getViewingParameters ( )

Returns the viewing parameter's of the currently active camera.

Returns:: The viewing parameter's of the currently active camera.

void ViewportWidget::applyViewingParameters ( ViewingParameters * viewingParameters ) [slot]

Applies the given viewing parameters to the viewport's viewing parameters.

Public Slots.

Parameters:

viewingParameters

The viewing parameters to apply to the viewport.

Applies the given viewing parameters to the viewport's viewing parameters.

Parameters:

viewingParameters

The viewing parameters to apply to the viewport.

void ViewportWidget::setImage	(	unsigned int	stageIndex,
		Ogre::TexturePtr	image
	)			`[slot]`

Sets the image that should be displayed in the viewport.

Parameters:

	stageIndex	The index of the stage to which the image belongs.
	image	The image that should be displayed in the viewport.

Only affects viewports that are set to display the content of the stage with the given index.

Parameters:

	stageIndex	The index of the stage to which the image belongs.
	image	The image that should be displayed in the viewport.

void ViewportWidget::homeView ( ) [slot]

Resets the viewport's view settings.

void ViewportWidget::setWireframe ( bool wireframe ) [slot]

Activates or deactivates wireframe view in the viewport.

Parameters:

wireframe

Flag that controls wireframe view in the viewport.

void ViewportWidget::setBackfaceCulling ( bool backfaceCulling ) [slot]

Activates or deactivates the omission of polygons facing away from the camera.

Parameters:

backfaceCulling

Flag that controls the culling of polygons facing away from the camera.

void ViewportWidget::toggleOrigin ( ) [slot]

Toggles the display of the point of origin in the viewport.

void ViewportWidget::toggleCenterPoint ( ) [slot]

Toggles the display of the center point in the viewport.

void ViewportWidget::toggleOrientationIndicator ( ) [slot]

Toggles the display of the orientation indicator in the viewport.

void ViewportWidget::toggleGrid ( ) [slot]

Toggles the display of the coordinate grid in the viewport.

void ViewportWidget::objectSelected	(	const QString &	objectName,
		bool	toggle
	)			`[signal]`

Signal that is emitted when an object in the viewport has been clicked.

Parameters:

	objectName	The name of the object that was selected, or an empty string if no object has been selected.
	toggle	Flag that controls whether the object's selected state should be toggled.

void ViewportWidget::viewChanged ( ViewingParameters * viewingParameters ) [signal]

Signal that is emitted when the viewing parameters have changed.

Parameters:

viewingParameters

The current viewing parameters.

void ViewportWidget::frameSelectedObjectsRequested ( ViewingParameters * viewingParameters ) [signal]

Signal that is emitted when the selected objects in the viewport should be framed by the viewport's camera.

Requests an adjustment of the viewing parameters the viewport's camera so that the currently selected objects are centered in the view.

Parameters:

viewingParameters

The viewing parameters to modify.

void ViewportWidget::renderingTriggered ( ) [signal]

Rendering process has been initiated.

void ViewportWidget::resizeEvent ( QResizeEvent * event ) [protected, virtual]

Handles resize events for the widget.

Protected Events.

Parameters:

event

The description of the resize event.

Handles resize events for the widget.

Parameters:

event

The description of the resize event.

void ViewportWidget::paintEvent ( QPaintEvent * event ) [protected, virtual]

Handles paint events for the widget.

Parameters:

event

The description of the paint event.

void ViewportWidget::mousePressEvent ( QMouseEvent * event ) [protected, virtual]

Handles mouse press events for the widget.

Parameters:

event

The description of the mouse event.

void ViewportWidget::mouseMoveEvent ( QMouseEvent * event ) [protected, virtual]

Handles mouse move events for the widget.

Parameters:

event

The description of the mouse event.

void ViewportWidget::mouseReleaseEvent ( QMouseEvent * event ) [protected, virtual]

Handles mouse release events for the widget.

Parameters:

event

The description of the mouse event.

void ViewportWidget::wheelEvent ( QWheelEvent * event ) [protected, virtual]

Handles mouse wheel events for the widget.

Parameters:

event

The description of the mouse wheel event.

Ogre::String ViewportWidget::createUniqueName ( const QString & objectName ) [private]

Creates a unique name from the given object name by adding the viewport widget's index.

Private Functions.

bool ViewportWidget::createRenderWindow ( ) [private]

Creates the OGRE render window.

Returns:: True if creating the OGRE render window succeeded, otherwise False.

void ViewportWidget::initializeResources ( ) [private]

Initializes the resources that will be available to OGRE.

void ViewportWidget::createViewportObjects ( ) [private]

Creates basic viewport objects like the viewing camera, the head light, coordinate axes and the grid.

void ViewportWidget::createOverlays ( ) [private]

Creates overlay layers for visual components that will be rendered on top of the main scene layer.

void ViewportWidget::render ( ) [private]

Redraws the OGRE scene into the viewport widget.

void ViewportWidget::updateView ( ) [private]

Calculates the transformation of the viewport's camera according to the current viewing angles, the viewing radius, and the center of view.

Ogre::MaterialPtr ViewportWidget::createColorMaterial	(	const Ogre::String &	group,
		const Ogre::String &	name,
		const Ogre::ColourValue &	color,
		bool	wireframe = `false`
	)			`[private]`

Creates a self-illuminating material with the given name and color under the given group name.

Parameters:

	group	The name of the resource group to attach the material to.
	name	The unique name for the material.
	color	The color for the material.
	wireframe	Flag to control whether the material will display objects in wireframe mode.

Returns:: The new color material.

void ViewportWidget::createAxes	(	const QString &	name,
		Ogre::SceneNode *	parentNode,
		Ogre::uint32	visibilityFlags = `VF_MAIN_VIEWPORT`
	)			`[private]`

Creates three manual objects for X, Y and Z axes with the given name and attaches them to the given parent scene node. The axes will each have a length of 1.

Parameters:

	name	The prefix for the axes objects to create.
	parentNode	The scene node to which to attach the axes objects.
	visibilityFlags	The visibility flags to apply to the axes objects.

void ViewportWidget::createGrid ( Ogre::SceneNode * parentNode ) [private]

Creates a coordinate grid and attaches it to the given parent scene node.

Parameters:

parentNode

The scene node to which to attach the grid object.

Ogre::SceneNode * ViewportWidget::getClickedSceneNode ( const QPointF & mousePosition ) [private]

Returns the scene node that is located under the given mouse position in the viewport.

Parameters:

mousePosition

The position of the mouse pointer over the viewport widget.

Returns:: The clicked scene node or 0 if no scene node was clicked.

Member Data Documentation

unsigned int ViewportWidget::s_viewportIndex = 0 [static, private]

The index of the next viewport widget to create.

Private Static Data.

Ogre::MaterialPtr ViewportWidget::s_redMaterial [static, private]

Material for self-illuminating red objects (like coordinate X axes).

Ogre::MaterialPtr ViewportWidget::s_greenMaterial [static, private]

Material for self-illuminating green objects (like coordinate Y axes).

Ogre::MaterialPtr ViewportWidget::s_blueMaterial [static, private]

Material for self-illuminating blue objects (like coordinate Z axes).

Ogre::MaterialPtr ViewportWidget::s_grayMaterial [static, private]

Material for self-illuminating gray objects.

Ogre::MaterialPtr ViewportWidget::s_blackMaterial [static, private]

Material for self-illuminating black objects.

Ogre::MaterialPtr ViewportWidget::s_defaultMaterial [static, private]

Default material to use in shaded mode.

Ogre::MaterialPtr ViewportWidget::s_nullMaterial [static, private]

Material for Null objects.

Ogre::MaterialPtr ViewportWidget::s_maskMaterial [static, private]

Material for semi-transparent mask overlays.

unsigned int ViewportWidget::m_stageIndex [protected]

The index of the stage to display in the viewport.

bool ViewportWidget::m_showOverlays [protected]

Show overlays.

bool ViewportWidget::m_fullscreen [protected]

Flag that states whether the widget is used in fullscreen mode.

bool ViewportWidget::m_stereo [protected]

Flag that states whether stereo viewing is activated.

float ViewportWidget::m_stereoEyeDist [protected]

Stereo view parameters.

float ViewportWidget::m_stereoFOffsetMultiplier [protected]

float ViewportWidget::m_stereoNearClip [protected]

float ViewportWidget::m_stereoFarClip [protected]

float ViewportWidget::m_stereoFov [protected]

float ViewportWidget::m_stereoFocalLength [protected]

unsigned int ViewportWidget::m_stereoRttWidth [protected]

unsigned int ViewportWidget::m_stereoRttHeight [protected]

int ViewportWidget::m_width [protected]

The width of the viewport when in fullscreen mode.

int ViewportWidget::m_height [protected]

The height of the viewport when in fullscreen mode.

Ogre::RenderWindow* ViewportWidget::m_renderWindow [protected]

The OGRE render window to use in the viewport widget.

Ogre::SceneManager* ViewportWidget::m_sceneManager [protected]

The main OGRE scene manager.

Ogre::SceneNode* ViewportWidget::m_cameraSceneNode [protected]

The main viewport's viewing camera scene node.

Ogre::MaterialPtr ViewportWidget::m_imageMaterial [protected]

Material for the viewport's image overlay that is used to display image results from nodes.

Ogre::Camera* ViewportWidget::m_camera [protected]

The viewport's viewing cameras.

Ogre::Camera* ViewportWidget::m_camera0 [protected]

Ogre::Camera* ViewportWidget::m_camera1 [protected]

Ogre::Camera* ViewportWidget::m_camera2 [protected]

Ogre::Camera* ViewportWidget::m_camera3 [protected]

Ogre::Camera* ViewportWidget::m_camera4 [protected]

QString ViewportWidget::m_cameraName [protected]

The current camera name.

Ogre::Light* ViewportWidget::m_headLight [protected]

The viewing camera's light.

Ogre::CompositorInstance* ViewportWidget::m_stereoCompositor [protected]

The stereo compositor.

Ogre::RenderTarget* ViewportWidget::m_stereoRenderTarget [protected]

The stereo OGRE texture render target.

Ogre::Viewport* ViewportWidget::m_viewport [protected]

The OGRE viewports.

Ogre::Viewport* ViewportWidget::m_stereoViewport0 [protected]

Ogre::Viewport* ViewportWidget::m_stereoViewport1 [protected]

Ogre::Viewport* ViewportWidget::m_stereoViewport2 [protected]

Ogre::Viewport* ViewportWidget::m_stereoViewport3 [protected]

Ogre::Viewport* ViewportWidget::m_stereoViewport4 [protected]

Ogre::ColourValue ViewportWidget::m_backgroundColor [protected]

The background color of the viewport.

Ogre::ColourValue ViewportWidget::m_fogColor [protected]

The fog color of the scene.

Ogre::SceneNode* ViewportWidget::m_orientationIndicatorCameraSceneNode [protected]

The orientation indicator viewport's camera scene node.

Ogre::Camera* ViewportWidget::m_orientationIndicatorCamera [protected]

The orientation indicator viewport's camera.

Ogre::Viewport* ViewportWidget::m_orientationIndicatorViewport [protected]

The orientation indicator viewport to display axes that show the main camera's orientation.

Ogre::Overlay* ViewportWidget::m_labelOverlay [protected]

The overlay for all text information panel overlay elements.

Ogre::Overlay* ViewportWidget::m_imageOverlay [protected]

The overlay for the image panel overlay element.

Ogre::Overlay* ViewportWidget::m_maskOverlay [protected]

The overlay for all mask panel overlay elements.

Ogre::PanelOverlayElement* ViewportWidget::m_leftTopHudPanel [protected]

The panel overlay element used for displaying text information in the top left corner of the viewport.

Ogre::TextAreaOverlayElement* ViewportWidget::m_leftTopHudTextArea [protected]

The text area overlay element used for displaying text information in the top left corner of the viewport.

Ogre::PanelOverlayElement* ViewportWidget::m_imagePanel [protected]

The panel overlay element used for displaying an image.

Ogre::PanelOverlayElement* ViewportWidget::m_topMaskPanel [protected]

The panel overlay element used for masking the top of the viewport.

Ogre::PanelOverlayElement* ViewportWidget::m_bottomMaskPanel [protected]

The panel overlay element used for masking the bottom of the viewport.

Ogre::PanelOverlayElement* ViewportWidget::m_leftMaskPanel [protected]

The panel overlay element used for masking the left of the viewport.

Ogre::PanelOverlayElement* ViewportWidget::m_rightMaskPanel [protected]

The panel overlay element used for masking the right of the viewport.

Ogre::SceneNode* ViewportWidget::m_viewportObjectsSceneNode [protected]

The node that all exclusive viewport object scene nodes will be attached to.

Ogre::SceneNode* ViewportWidget::m_originSceneNode [protected]

The node that the coordinate system's origin axes will be attached to.

Ogre::SceneNode* ViewportWidget::m_centerPointSceneNode [protected]

The node that the center axes will be attached to.

Ogre::SceneNode* ViewportWidget::m_orientationIndicatorSceneNode [protected]

The node that the orientation indicator will be attached to.

Ogre::SceneNode* ViewportWidget::m_gridSceneNode [protected]

The node that the coordinate grid will be attached to.

bool ViewportWidget::m_viewMode [protected]

Flag that states whether the viewing mode is activated.

QPoint ViewportWidget::m_lastPosition [protected]

The last position of the mouse pointer over the viewport.

ViewingParameters* ViewportWidget::m_viewingParameters [protected]

The viewing parameters for the viewport's active camera.

bool ViewportWidget::m_wireframe [protected]

Flag that states whether wireframe view is activated.

bool ViewportWidget::m_backfaceCulling [protected]

Flag that states whether backface culling is activated.

bool ViewportWidget::m_showOrigin [protected]

Flag that states whether the origin should be visible in the viewport.

bool ViewportWidget::m_showCenterPoint [protected]

Flag that states whether the center should be visible in the viewport.

bool ViewportWidget::m_showOrientationIndicator [protected]

Flag that states whether the orientation indicator is shown in the widget.

bool ViewportWidget::m_showGrid [protected]

Flag that states whether the grid should be visible in the viewport.

bool ViewportWidget::m_overlayOnly [protected]

Flag that states whether the geometry should be visible.

Ogre::TexturePtr ViewportWidget::m_tmpTexture [protected]

DEBUG: NILZ:.

float ViewportWidget::m_dbgColor [protected]

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


Public Slots
void	applyViewingParameters (ViewingParameters *viewingParameters)
	Applies the given viewing parameters to the viewport's viewing parameters.
void	setImage (unsigned int stageIndex, Ogre::TexturePtr image)
	Sets the image that should be displayed in the viewport.
void	homeView ()
	Resets the viewport's view settings.
void	setWireframe (bool wireframe)
	Activates or deactivates wireframe view in the viewport.
void	setBackfaceCulling (bool backfaceCulling)
	Activates or deactivates the omission of polygons facing away from the camera.
void	toggleOrigin ()
	Toggles the display of the point of origin in the viewport.
void	toggleCenterPoint ()
	Toggles the display of the center point in the viewport.
void	toggleOrientationIndicator ()
	Toggles the display of the orientation indicator in the viewport.
void	toggleGrid ()
	Toggles the display of the coordinate grid in the viewport.
Signals
void	objectSelected (const QString &objectName, bool toggle)
	Signal that is emitted when an object in the viewport has been clicked.
void	viewChanged (ViewingParameters *viewingParameters)
	Signal that is emitted when the viewing parameters have changed.
void	frameSelectedObjectsRequested (ViewingParameters *viewingParameters)
	Signal that is emitted when the selected objects in the viewport should be framed by the viewport's camera.
void	renderingTriggered ()
	Rendering process has been initiated.
Public Member Functions
	ViewportWidget (QWidget *parent=0, unsigned int stageIndex=1, bool fullscreen=false, bool stereo=false, int width=1024, int height=768)
	Constructor of the ViewportWidget class.
virtual	~ViewportWidget ()
	Destructor of the ViewportWidget class.
virtual QPaintEngine *	paintEngine () const
	Returns a pointer to the paint engine used for drawing on the device.
unsigned int	getStageIndex ()
	Returns the index of the stage to display in the viewport.
void	setStageIndex (unsigned int stageIndex)
	Sets the index of the stage to display in the viewport.
void	setViewMode (bool viewMode)
	Activates or deactivates the view mode in the viewport widget.
void	frameSelectedObjects ()
	Centers the viewport's view on currently selected objects.
void	setFog (bool enabled, double density)
	Sets the fog parameters of the viewport.
QColor	getFogColor ()
	Returns the fog color of the scene.
void	setFogColor (const QColor &color)
	Sets the fog color of the scene.
QColor	getBackgroundColor ()
	Returns the background color of the scene.
void	setBackgroundColor (const QColor &color)
	Sets the background color of the scene.
void	setFullscreen (bool fullscreen, int width, int height)
	Sets fullscreen mode for the viewport widget.
void	getStereoParameters (double &rttWidth, double &rttHeight, double &eyeDist, double &fOffsetMultiplier, double &nearClip, double &farClip, double &fov, double &focalLength)
	Fills the given variables with stereo parameter values.
void	setStereoParameters (const unsigned int rttWidth, const unsigned int rttHeight, const float eyeDist, const float fOffsetMultiplier, const float nearClip, const float farClip, const float fov, const float focalLength)
	Sets the stereo parameters to the given values.
void	setStereo (bool enable)
	Toggles the stereo mode for the viewport widget.
void	setOverlayOnly (bool enable)
	Sets whether only overlays (no geometry) should be displayed in viewport.
float	getFps ()
	Returns the current number of frames per second rendered in the viewport.
int	getTriangleCount ()
	Returns the number of triangles last rendered in the viewport.
ViewingParameters *	getViewingParameters ()
	Returns the viewing parameter's of the currently active camera.
Protected Member Functions
virtual void	resizeEvent (QResizeEvent *event)
	Handles resize events for the widget.
virtual void	paintEvent (QPaintEvent *event)
	Handles paint events for the widget.
virtual void	mousePressEvent (QMouseEvent *event)
	Handles mouse press events for the widget.
virtual void	mouseMoveEvent (QMouseEvent *event)
	Handles mouse move events for the widget.
virtual void	mouseReleaseEvent (QMouseEvent *event)
	Handles mouse release events for the widget.
virtual void	wheelEvent (QWheelEvent *event)
	Handles mouse wheel events for the widget.
Protected Attributes
unsigned int	m_stageIndex
	The index of the stage to display in the viewport.
bool	m_showOverlays
	Show overlays.
bool	m_fullscreen
	Flag that states whether the widget is used in fullscreen mode.
bool	m_stereo
	Flag that states whether stereo viewing is activated.
float	m_stereoEyeDist
	Stereo view parameters.
float	m_stereoFOffsetMultiplier
float	m_stereoNearClip
float	m_stereoFarClip
float	m_stereoFov
float	m_stereoFocalLength
unsigned int	m_stereoRttWidth
unsigned int	m_stereoRttHeight
int	m_width
	The width of the viewport when in fullscreen mode.
int	m_height
	The height of the viewport when in fullscreen mode.
Ogre::RenderWindow *	m_renderWindow
	The OGRE render window to use in the viewport widget.
Ogre::SceneManager *	m_sceneManager
	The main OGRE scene manager.
Ogre::SceneNode *	m_cameraSceneNode
	The main viewport's viewing camera scene node.
Ogre::MaterialPtr	m_imageMaterial
	Material for the viewport's image overlay that is used to display image results from nodes.
Ogre::Camera *	m_camera
	The viewport's viewing cameras.
Ogre::Camera *	m_camera0
Ogre::Camera *	m_camera1
Ogre::Camera *	m_camera2
Ogre::Camera *	m_camera3
Ogre::Camera *	m_camera4
QString	m_cameraName
	The current camera name.
Ogre::Light *	m_headLight
	The viewing camera's light.
Ogre::CompositorInstance *	m_stereoCompositor
	The stereo compositor.
Ogre::RenderTarget *	m_stereoRenderTarget
	The stereo OGRE texture render target.
Ogre::Viewport *	m_viewport
	The OGRE viewports.
Ogre::Viewport *	m_stereoViewport0
Ogre::Viewport *	m_stereoViewport1
Ogre::Viewport *	m_stereoViewport2
Ogre::Viewport *	m_stereoViewport3
Ogre::Viewport *	m_stereoViewport4
Ogre::ColourValue	m_backgroundColor
	The background color of the viewport.
Ogre::ColourValue	m_fogColor
	The fog color of the scene.
Ogre::SceneNode *	m_orientationIndicatorCameraSceneNode
	The orientation indicator viewport's camera scene node.
Ogre::Camera *	m_orientationIndicatorCamera
	The orientation indicator viewport's camera.
Ogre::Viewport *	m_orientationIndicatorViewport
	The orientation indicator viewport to display axes that show the main camera's orientation.
Ogre::Overlay *	m_labelOverlay
	The overlay for all text information panel overlay elements.
Ogre::Overlay *	m_imageOverlay
	The overlay for the image panel overlay element.
Ogre::Overlay *	m_maskOverlay
	The overlay for all mask panel overlay elements.
Ogre::PanelOverlayElement *	m_leftTopHudPanel
	The panel overlay element used for displaying text information in the top left corner of the viewport.
Ogre::TextAreaOverlayElement *	m_leftTopHudTextArea
	The text area overlay element used for displaying text information in the top left corner of the viewport.
Ogre::PanelOverlayElement *	m_imagePanel
	The panel overlay element used for displaying an image.
Ogre::PanelOverlayElement *	m_topMaskPanel
	The panel overlay element used for masking the top of the viewport.
Ogre::PanelOverlayElement *	m_bottomMaskPanel
	The panel overlay element used for masking the bottom of the viewport.
Ogre::PanelOverlayElement *	m_leftMaskPanel
	The panel overlay element used for masking the left of the viewport.
Ogre::PanelOverlayElement *	m_rightMaskPanel
	The panel overlay element used for masking the right of the viewport.
Ogre::SceneNode *	m_viewportObjectsSceneNode
	The node that all exclusive viewport object scene nodes will be attached to.
Ogre::SceneNode *	m_originSceneNode
	The node that the coordinate system's origin axes will be attached to.
Ogre::SceneNode *	m_centerPointSceneNode
	The node that the center axes will be attached to.
Ogre::SceneNode *	m_orientationIndicatorSceneNode
	The node that the orientation indicator will be attached to.
Ogre::SceneNode *	m_gridSceneNode
	The node that the coordinate grid will be attached to.
bool	m_viewMode
	Flag that states whether the viewing mode is activated.
QPoint	m_lastPosition
	The last position of the mouse pointer over the viewport.
ViewingParameters *	m_viewingParameters
	The viewing parameters for the viewport's active camera.
bool	m_wireframe
	Flag that states whether wireframe view is activated.
bool	m_backfaceCulling
	Flag that states whether backface culling is activated.
bool	m_showOrigin
	Flag that states whether the origin should be visible in the viewport.
bool	m_showCenterPoint
	Flag that states whether the center should be visible in the viewport.
bool	m_showOrientationIndicator
	Flag that states whether the orientation indicator is shown in the widget.
bool	m_showGrid
	Flag that states whether the grid should be visible in the viewport.
bool	m_overlayOnly
	Flag that states whether the geometry should be visible.
Ogre::TexturePtr	m_tmpTexture
	DEBUG: NILZ:.
float	m_dbgColor
Private Member Functions
Ogre::String	createUniqueName (const QString &objectName)
	Creates a unique name from the given object name by adding the viewport widget's index.
bool	createRenderWindow ()
	Creates the OGRE render window.
void	initializeResources ()
	Initializes the resources that will be available to OGRE.
void	createViewportObjects ()
	Creates basic viewport objects like the viewing camera, the head light, coordinate axes and the grid.
void	createOverlays ()
	Creates overlay layers for visual components that will be rendered on top of the main scene layer.
void	render ()
	Redraws the OGRE scene into the viewport widget.
void	updateView ()
	Calculates the transformation of the viewport's camera according to the current viewing angles, the viewing radius, and the center of view.
Ogre::MaterialPtr	createColorMaterial (const Ogre::String &group, const Ogre::String &name, const Ogre::ColourValue &color, bool wireframe=false)
	Creates a self-illuminating material with the given name and color under the given group name.
void	createAxes (const QString &name, Ogre::SceneNode *parentNode, Ogre::uint32 visibilityFlags=VF_MAIN_VIEWPORT)
	Creates three manual objects for X, Y and Z axes with the given name and attaches them to the given parent scene node. The axes will each have a length of 1.
void	createGrid (Ogre::SceneNode *parentNode)
	Creates a coordinate grid and attaches it to the given parent scene node.
Ogre::SceneNode *	getClickedSceneNode (const QPointF &mousePosition)
	Returns the scene node that is located under the given mouse position in the viewport.
Static Private Attributes
static unsigned int	s_viewportIndex = 0
	The index of the next viewport widget to create.
static Ogre::MaterialPtr	s_redMaterial
	Material for self-illuminating red objects (like coordinate X axes).
static Ogre::MaterialPtr	s_greenMaterial
	Material for self-illuminating green objects (like coordinate Y axes).
static Ogre::MaterialPtr	s_blueMaterial
	Material for self-illuminating blue objects (like coordinate Z axes).
static Ogre::MaterialPtr	s_grayMaterial
	Material for self-illuminating gray objects.
static Ogre::MaterialPtr	s_blackMaterial
	Material for self-illuminating black objects.
static Ogre::MaterialPtr	s_defaultMaterial
	Default material to use in shaded mode.
static Ogre::MaterialPtr	s_nullMaterial
	Material for Null objects.
static Ogre::MaterialPtr	s_maskMaterial
	Material for semi-transparent mask overlays.