gazebo::rendering::WindowManager Class Reference

Class to mangage render windows. More...

#include <rendering/rendering.hh>

Public Member Functions
	WindowManager ()
	Constructor. More...
virtual	~WindowManager ()
	Destructor. More...
float	AvgFPS (const uint32_t _id) const
	Get the average FPS. More...
int	CreateWindow (const std::string &_ogreHandle, uint32_t _width, uint32_t _height)
	Create a window. More...
void	Fini ()
	Shutdown all the windows. More...
float	GetAvgFPS (uint32_t _id) GAZEBO_DEPRECATED(7.0)
	Get the average FPS. More...
uint32_t	GetTriangleCount (uint32_t _id) GAZEBO_DEPRECATED(7.0)
	Get the triangle count. More...
Ogre::RenderWindow *	GetWindow (uint32_t _id) GAZEBO_DEPRECATED(7.0)
	Get the render window associated with the given id. More...
void	Moved (uint32_t _id)
	Tells Ogre the window has moved, and needs updating. More...
void	Resize (uint32_t _id, int _width, int _height)
	Resize a window. More...
void	SetCamera (int _windowId, CameraPtr _camera)
	Attach a camera to a window. More...
uint32_t	TriangleCount (const uint32_t _id) const
	Get the triangle count. More...
Ogre::RenderWindow *	Window (const uint32_t _id) const
	Get the render window associated with the given id. More...

Detailed Description

Class to mangage render windows.

Constructor & Destructor Documentation

gazebo::rendering::WindowManager::WindowManager

(

)

Constructor.

virtual gazebo::rendering::WindowManager::~WindowManager ( )

virtual

Destructor.

Member Function Documentation

float gazebo::rendering::WindowManager::AvgFPS

(

const uint32_t

_id

)

const

Get the average FPS.

Parameters

[in]

_id

ID of the window.

Returns

The frames per second.

int gazebo::rendering::WindowManager::CreateWindow	(	const std::string &	_ogreHandle,
		uint32_t	_width,
		uint32_t	_height
	)

Create a window.

Parameters

[in]	_ogreHandle	String representing the ogre window handle.
[in]	_width	With of the window in pixels.
[in]	_height	Height of the window in pixels.

void gazebo::rendering::WindowManager::Fini

(

)

Shutdown all the windows.

float gazebo::rendering::WindowManager::GetAvgFPS

(

uint32_t

_id

)

Get the average FPS.

Parameters

[in]

_id

ID of the window.

Returns

The frames per second.

Deprecated:

See AvgFPS()

uint32_t gazebo::rendering::WindowManager::GetTriangleCount

(

uint32_t

_id

)

Get the triangle count.

Parameters

[in]

_id

ID of the window.

Returns

The triangle count.

Deprecated:

See TriangleCount()

Ogre::RenderWindow* gazebo::rendering::WindowManager::GetWindow

(

uint32_t

_id

)

Get the render window associated with the given id.

Parameters

[in]

_id

ID of the window.

Returns

Pointer to the render window, NULL if the id is invalid.

Deprecated:

See Window()

void gazebo::rendering::WindowManager::Moved

(

uint32_t

_id

)

Tells Ogre the window has moved, and needs updating.

Parameters

[in]

_id

ID of the window.

void gazebo::rendering::WindowManager::Resize	(	uint32_t	_id,
		int	_width,
		int	_height
	)

Resize a window.

Parameters

[in]	_id	Id of the window to resize.
[in]	_width	New width of the window.
[in]	_height	New height of the window.

void gazebo::rendering::WindowManager::SetCamera	(	int	_windowId,
		CameraPtr	_camera
	)

Attach a camera to a window.

Parameters

[in]	_windowId	Id of the window to add the camera to.
[in]	_camera	Pointer to the camera to attach.

uint32_t gazebo::rendering::WindowManager::TriangleCount

(

const uint32_t

_id

)

const

Get the triangle count.

Parameters

[in]

_id

ID of the window.

Returns

The triangle count.

Ogre::RenderWindow* gazebo::rendering::WindowManager::Window

(

const uint32_t

_id

)

const

Get the render window associated with the given id.

Parameters

[in]

_id

ID of the window.

Returns

Pointer to the render window, NULL if the id is invalid.

---

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

• WindowManager.hh