hoa_scene::SceneMode Class Reference

Handles everything that needs to be done when full-screen artwork is displayed. More...

#include <scene.h>

Inheritance diagram for hoa_scene::SceneMode:

[legend]Collaboration diagram for hoa_scene::SceneMode:

[legend]List of all members.

Public Member Functions
void	Draw ()
	Draws the next frame to be displayed on the screen.
void	Reset ()
	Resets appropriate class members. Called whenever SceneMode is made the active game mode.
	SceneMode ()
void	Update ()
	Updates the game state by the amount of time that has elapsed.
	~SceneMode ()
Private Attributes
uint32	_scene_timer
	Retains the number of milliseconds that have elapsed since this mode was initialized.

---

Detailed Description

Handles everything that needs to be done when full-screen artwork is displayed.

****************************************************************************

This game mode displays a single full-screen art scene, which are used in various places in the game. The scene can not be exited until the amount of milliseconds defined in MIN_SCENE_UPDATES has expired, to ensure that the user does not accidentally skip the scene and can take the time to appreciate the art.

Definition at line 54 of file scene.h.

---

Constructor & Destructor Documentation

hoa_scene::SceneMode::SceneMode

(

)

Definition at line 36 of file scene.cpp.

References hoa_mode_manager::MODE_MANAGER_SCENE_MODE, hoa_mode_manager::GameMode::mode_type, and hoa_scene::SCENE_DEBUG.

hoa_scene::SceneMode::~SceneMode

(

)

Definition at line 49 of file scene.cpp.

References hoa_scene::SCENE_DEBUG.

---

Member Function Documentation

void hoa_scene::SceneMode::Draw

(

)

[virtual]

Draws the next frame to be displayed on the screen.

Implements hoa_mode_manager::GameMode.

Definition at line 76 of file scene.cpp.

void hoa_scene::SceneMode::Reset

(

)

[virtual]

Resets appropriate class members. Called whenever SceneMode is made the active game mode.

Implements hoa_mode_manager::GameMode.

Definition at line 56 of file scene.cpp.

References _scene_timer.

void hoa_scene::SceneMode::Update

(

)

[virtual]

Updates the game state by the amount of time that has elapsed.

Implements hoa_mode_manager::GameMode.

Definition at line 63 of file scene.cpp.

References _scene_timer, hoa_input::GameInput::CancelPress(), hoa_input::GameInput::ConfirmPress(), hoa_system::GameSystem::GetUpdateTime(), hoa_input::InputManager, hoa_scene::private_scene::MIN_SCENE_UPDATES, hoa_mode_manager::ModeManager, hoa_mode_manager::GameModeManager::Pop(), and hoa_system::SystemManager.

Here is the call graph for this function:

---

Member Data Documentation

uint32 hoa_scene::SceneMode::_scene_timer [private]

Retains the number of milliseconds that have elapsed since this mode was initialized.

Definition at line 57 of file scene.h.

Referenced by Reset(), and Update().

---

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

• scene.h
• scene.cpp

---