GameFrameListener Class Reference

The game frame listener. More...

#include <GameFrameListener.h>

Inheritance diagram for GameFrameListener:

Collaboration diagram for GameFrameListener:

Public Member Functions
	GameFrameListener (Ogre::RenderWindow *win)
	Constructor. More...
virtual	~GameFrameListener ()
	Destructor. More...
bool	frameStarted (const Ogre::FrameEvent &evt)
	Called when a frame is about to begin rendering. More...
bool	frameEnded (const Ogre::FrameEvent &evt)
	Called just after a frame has been rendered. More...
virtual void	windowMoved (Ogre::RenderWindow *rw)
	Event triggered when the window moves. More...
virtual void	windowResized (Ogre::RenderWindow *rw)
	Event triggered when the window changes it's size. More...
virtual void	windowClosed (Ogre::RenderWindow *rw)
	Event triggered when the window is closed. More...
virtual void	windowFocusChange (Ogre::RenderWindow *rw)
	Event triggered when the window losses or gains the focus. More...
bool	keyPressed (const OIS::KeyEvent &e)
	Triggered when a key is pressed. More...
bool	keyReleased (const OIS::KeyEvent &e)
	Triggered when a key is released. More...
bool	mouseMoved (const OIS::MouseEvent &e)
	Triggered when the mouse moves. More...
bool	mousePressed (const OIS::MouseEvent &e, OIS::MouseButtonID id)
	Triggered when a mouse button is pressed. More...
bool	mouseReleased (const OIS::MouseEvent &e, OIS::MouseButtonID id)
	Triggered when a mouse button is released. More...

Protected Attributes
Ogre::RenderWindow *	window_
	The render window. More...
OIS::InputManager *	input_manager_
	The input manager. More...
OIS::Keyboard *	keyboard_
	The keyboard. More...
OIS::Mouse *	mouse_
	The mouse. More...

Detailed Description

The game frame listener.

Handles the game window and input events.

Constructor & Destructor Documentation

GameFrameListener()

GameFrameListener::GameFrameListener

(

Ogre::RenderWindow *

win

)

Constructor.

Parameters

[in]

win

Render window.

~GameFrameListener()

GameFrameListener::~GameFrameListener ( )

virtual

Destructor.

Member Function Documentation

frameEnded()

bool GameFrameListener::frameEnded

(

const Ogre::FrameEvent &

evt

)

Called just after a frame has been rendered.

This event happens after all render targets have been fully updated and the buffers switched.

Returns

True to continue with the next frame, false to drop out of the rendering loop.

frameStarted()

bool GameFrameListener::frameStarted

(

const Ogre::FrameEvent &

evt

)

Called when a frame is about to begin rendering.

This event happens before any render targets have begun updating.

Returns

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

keyPressed()

bool GameFrameListener::keyPressed

(

const OIS::KeyEvent &

e

)

Triggered when a key is pressed.

Parameters

[in]

e

Keyboard event.

keyReleased()

bool GameFrameListener::keyReleased

(

const OIS::KeyEvent &

e

)

Triggered when a key is released.

Parameters

[in]

e

Keyboard event.

mouseMoved()

bool GameFrameListener::mouseMoved

(

const OIS::MouseEvent &

e

)

Triggered when the mouse moves.

Parameters

[in]

e

Mouse event.

mousePressed()

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

Triggered when a mouse button is pressed.

Parameters

[in]	e	Mouse event.
[in]	id	ID of the presses mouse button.

mouseReleased()

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

Triggered when a mouse button is released.

Parameters

[in]	e	Mouse event.
[in]	id	ID of the presses mouse button.

windowClosed()

void GameFrameListener::windowClosed ( Ogre::RenderWindow *  rw )

virtual

Event triggered when the window is closed.

Parameters

[in]

rw

The render window.

windowFocusChange()

void GameFrameListener::windowFocusChange ( Ogre::RenderWindow *  rw )

virtual

Event triggered when the window losses or gains the focus.

Parameters

[in]

rw

The render window.

windowMoved()

void GameFrameListener::windowMoved ( Ogre::RenderWindow *  rw )

virtual

Event triggered when the window moves.

Parameters

[in]

rw

The render window.

windowResized()

void GameFrameListener::windowResized ( Ogre::RenderWindow *  rw )

virtual

Event triggered when the window changes it's size.

Parameters

[in]

rw

The render window.

Member Data Documentation

input_manager_

OIS::InputManager* GameFrameListener::input_manager_

protected

The input manager.

keyboard_

OIS::Keyboard* GameFrameListener::keyboard_

protected

The keyboard.

mouse_

OIS::Mouse* GameFrameListener::mouse_

protected

The mouse.

window_

Ogre::RenderWindow* GameFrameListener::window_

protected

The render window.

---

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

• src/core/GameFrameListener.h
• src/core/GameFrameListener.cpp