rviz::QtOgreRenderWindow Class Reference

#include <qt_ogre_render_window.h>

Inheritance diagram for rviz::QtOgreRenderWindow:

List of all members.

Public Member Functions
Ogre::Camera *	getCamera () const
Ogre::Viewport *	getViewport () const
	QtOgreRenderWindow (QWidget *parent=0)
void	setAutoRender (bool auto_render)
void	setBackgroundColor (Ogre::ColourValue color)
void	setCamera (Ogre::Camera *camera)
void	setOrthoScale (float scale)
	Set the scale of the orthographic window. Only valid for an orthographic camera.
void	setOverlaysEnabled (bool overlays_enabled)
virtual void	setPostRenderCallback (boost::function< void()> func)
virtual void	setPreRenderCallback (boost::function< void()> func)
virtual QSize	sizeHint () const
Protected Member Functions
virtual void	paintEvent (QPaintEvent *e)
virtual void	resizeEvent (QResizeEvent *event)
void	setCameraAspectRatio ()
Protected Attributes
bool	auto_render_
Ogre::ColourValue	background_color_
Ogre::Camera *	camera_
Ogre::Root *	ogre_root_
float	ortho_scale_
bool	overlays_enabled_
boost::function< void()>	post_render_callback_
	Functor which is called after each render.
boost::function< void()>	pre_render_callback_
	Functor which is called before each render.
Ogre::Viewport *	viewport_

---

Detailed Description

Qt Ogre render window widget. Similar in API to wxOgreRenderWindow from ogre_tools release 1.6, but with much of the guts replaced by new RenderSystem and RenderWidget classes inspired by the initialization sequence of Gazebo's renderer.

Definition at line 54 of file qt_ogre_render_window.h.

---

Constructor & Destructor Documentation

rviz::QtOgreRenderWindow::QtOgreRenderWindow

(

QWidget *

parent = 0

)

Constructor.

Parameters:

parent

The parent wxWindow component.

Definition at line 50 of file qt_ogre_render_window.cpp.

---

Member Function Documentation

Ogre::Camera* rviz::QtOgreRenderWindow::getCamera

(

)

const [inline]

Definition at line 90 of file qt_ogre_render_window.h.

Ogre::Viewport * rviz::QtOgreRenderWindow::getViewport

(

)

const

Gets the associated Ogre viewport. If this is called before QWidget::show() on this widget, it will fail an assertion. Several functions of Ogre::Viewport are duplicated in this class which can be called before QWidget::show(), and their effects are propagated to the viewport when it is created.

Definition at line 71 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::paintEvent

(

QPaintEvent *

e

)

[protected, virtual]

Reimplemented from rviz::RenderWidget.

Definition at line 134 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::resizeEvent

(

QResizeEvent *

event

)

[protected, virtual]

Reimplemented from rviz::RenderWidget.

Definition at line 162 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::setAutoRender

(

bool

auto_render

)

[inline]

Definition at line 98 of file qt_ogre_render_window.h.

void rviz::QtOgreRenderWindow::setBackgroundColor

(

Ogre::ColourValue

color

)

Definition at line 92 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::setCamera

(

Ogre::Camera *

camera

)

Set the camera associated with this render window's viewport.

Definition at line 76 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::setCameraAspectRatio

(

)

[protected]

Sets the aspect ratio on the camera

Definition at line 98 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::setOrthoScale

(

float

scale

)

Set the scale of the orthographic window. Only valid for an orthographic camera.

Parameters:

scale

The scale

Definition at line 116 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::setOverlaysEnabled

(

bool

overlays_enabled

)

Definition at line 86 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::setPostRenderCallback

(

boost::function< void()>

func

)

[virtual]

Set a callback which is called after each render

Parameters:

func	The callback functor

Definition at line 128 of file qt_ogre_render_window.cpp.

void rviz::QtOgreRenderWindow::setPreRenderCallback

(

boost::function< void()>

func

)

[virtual]

Set a callback which is called before each render

Parameters:

func	The callback functor

Definition at line 123 of file qt_ogre_render_window.cpp.

virtual QSize rviz::QtOgreRenderWindow::sizeHint

(

)

const [inline, virtual]

Overrides the default implementation. This override is here for convenience. Returns a symbolic 320x240px size.

Returns:

A size of 320x240 (just a symbolic 4:3 size).

Definition at line 76 of file qt_ogre_render_window.h.

---

Member Data Documentation

bool rviz::QtOgreRenderWindow::auto_render_ [protected]

Definition at line 122 of file qt_ogre_render_window.h.

Ogre::ColourValue rviz::QtOgreRenderWindow::background_color_ [protected]

Definition at line 126 of file qt_ogre_render_window.h.

Ogre::Camera* rviz::QtOgreRenderWindow::camera_ [protected]

Reimplemented in ImageView.

Definition at line 124 of file qt_ogre_render_window.h.

Ogre::Root* rviz::QtOgreRenderWindow::ogre_root_ [protected]

Definition at line 116 of file qt_ogre_render_window.h.

float rviz::QtOgreRenderWindow::ortho_scale_ [protected]

Definition at line 121 of file qt_ogre_render_window.h.

bool rviz::QtOgreRenderWindow::overlays_enabled_ [protected]

Definition at line 125 of file qt_ogre_render_window.h.

boost::function<void ()> rviz::QtOgreRenderWindow::post_render_callback_ [protected]

Functor which is called after each render.

Definition at line 119 of file qt_ogre_render_window.h.

boost::function<void ()> rviz::QtOgreRenderWindow::pre_render_callback_ [protected]

Functor which is called before each render.

Definition at line 118 of file qt_ogre_render_window.h.

Ogre::Viewport* rviz::QtOgreRenderWindow::viewport_ [protected]

Definition at line 114 of file qt_ogre_render_window.h.

---

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

• qt_ogre_render_window.h
• qt_ogre_render_window.cpp