DisplayFrameListener Class Reference

The display frame listener. More...

#include <OgreBase.h>

Inheritance diagram for DisplayFrameListener:

Collaboration diagram for DisplayFrameListener:

Public Member Functions
	DisplayFrameListener (Ogre::RenderWindow *win)
	Constructor. More...
virtual	~DisplayFrameListener ()
virtual void	windowClosed (Ogre::RenderWindow *rw)
	Called on window closing. More...
bool	frameStarted (const Ogre::FrameEvent &evt)
	Called when a frame is about to begin rendering. More...
bool	keyPressed (const OIS::KeyEvent &e)
	The key listener. More...
bool	keyReleased (const OIS::KeyEvent &e)
	Handles key releasing events. More...
bool	mouseMoved (const OIS::MouseEvent &e)
	Handles mouse movement events. More...
bool	mousePressed (const OIS::MouseEvent &e, OIS::MouseButtonID id)
	Handles mouse button-down events. More...
bool	mouseReleased (const OIS::MouseEvent &e, OIS::MouseButtonID id)
	Handles mouse button-up events. More...
virtual void	setCamera (Ogre::Camera *camera)
	Sets the viewport camera. More...

Public Attributes
Ogre::TextAreaOverlayElement *	info_text
	The information text. More...
Ogre::Overlay *	info_overlay
	The information overlay. More...

Private Attributes
Ogre::RenderWindow *	window_
	The render window. More...
OIS::InputManager *	input_manager_
	The OIS input manager. More...
OIS::Keyboard *	keyboard_
	The OIS keyboard. More...
OIS::Mouse *	mouse_
	The OIS mouse. More...
Ogre::Camera *	camera_
	The camera. More...
float	mouse_move_x_
	Mouse horizontal movement. More...
float	mouse_move_y_
	Mouse vertical movement. More...
bool	mouse_rotate_
	Indicates if the mouse is being rotated. More...
bool	exit_
	Flag for application exit. More...

Detailed Description

The display frame listener.

It listens and responds to input events, such as window changes or mouse and keyboard inputs.

Constructor & Destructor Documentation

DisplayFrameListener()

DisplayFrameListener::DisplayFrameListener ( Ogre::RenderWindow *  win )

inline

Constructor.

Parameters

[in]

win

The render window. Used to determine input context.

~DisplayFrameListener()

virtual DisplayFrameListener::~DisplayFrameListener ( )

inlinevirtual

Member Function Documentation

frameStarted()

bool DisplayFrameListener::frameStarted ( const Ogre::FrameEvent &  evt )

inline

Called when a frame is about to begin rendering.

This event happens before any render targets have begun updating. It captures input events and checks the state of entities.

Parameters

[in]

evt

Triggering event. Unused.

Returns

True to go ahead, false to abort rendering and drop out of the rendering loop.

keyPressed()

bool DisplayFrameListener::keyPressed ( const OIS::KeyEvent &  e )

inline

The key listener.

Parses keyboard events.

Parameters

[in]

e

Triggering event.

Returns

Always true

keyReleased()

bool DisplayFrameListener::keyReleased ( const OIS::KeyEvent &  e )

inline

Handles key releasing events.

It does nothing.

Parameters

[in]

e

Triggering event.

Returns

Always true.

mouseMoved()

bool DisplayFrameListener::mouseMoved ( const OIS::MouseEvent &  e )

inline

Handles mouse movement events.

Parameters

[in]

e

Triggering event.

Returns

Always true.

mousePressed()

bool DisplayFrameListener::mousePressed ( const OIS::MouseEvent &  e, OIS::MouseButtonID  id  )

inline

Handles mouse button-down events.

Parameters

[in]	e	Triggering event.
[in]	id	Button ID.

Returns

Always true.

mouseReleased()

bool DisplayFrameListener::mouseReleased ( const OIS::MouseEvent &  e, OIS::MouseButtonID  id  )

inline

Handles mouse button-up events.

Parameters

[in]	e	Triggering event.
[in]	id	Button ID.

Returns

Always true.

setCamera()

virtual void DisplayFrameListener::setCamera ( Ogre::Camera *  camera )

inlinevirtual

Sets the viewport camera.

windowClosed()

virtual void DisplayFrameListener::windowClosed ( Ogre::RenderWindow *  rw )

inlinevirtual

Called on window closing.

Detaches OIS before window shutdown (very important under Linux).

Member Data Documentation

camera_

Ogre::Camera* DisplayFrameListener::camera_

private

The camera.

exit_

bool DisplayFrameListener::exit_

private

Flag for application exit.

info_overlay

Ogre::Overlay* DisplayFrameListener::info_overlay

The information overlay.

info_text

Ogre::TextAreaOverlayElement* DisplayFrameListener::info_text

The information text.

input_manager_

OIS::InputManager* DisplayFrameListener::input_manager_

private

The OIS input manager.

keyboard_

OIS::Keyboard* DisplayFrameListener::keyboard_

private

The OIS keyboard.

mouse_

OIS::Mouse* DisplayFrameListener::mouse_

private

The OIS mouse.

mouse_move_x_

float DisplayFrameListener::mouse_move_x_

private

Mouse horizontal movement.

mouse_move_y_

float DisplayFrameListener::mouse_move_y_

private

Mouse vertical movement.

mouse_rotate_

bool DisplayFrameListener::mouse_rotate_

private

Indicates if the mouse is being rotated.

window_

Ogre::RenderWindow* DisplayFrameListener::window_

private

The render window.

---

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

• src/installer/common/OgreBase.h