hoa_boot::WelcomeScreen Class Reference

Provides for everything that is needed for displaying the game welcome message. More...

#include <boot_welcome.h>

Collaboration diagram for hoa_boot::WelcomeScreen:

[legend]List of all members.

Public Member Functions
void	Draw ()
	Draws the welcome window on the screen if it is set visible.
void	Hide ()
	Hides the welcome window.
bool	IsVisible ()
	Returns true if the welcome window is set visible at the moment.
void	Show ()
	Shows the welcome window.
	WelcomeScreen ()
	~WelcomeScreen ()
Private Attributes
bool	_visible
	Is the window visible or not.
hoa_video::RenderedString *	_welcome_rendered
	Rendered text string.
std::string	_welcome_text
	Text to be displayed.
hoa_video::MenuWindow	_window
	Window for the screen.

---

Detailed Description

Provides for everything that is needed for displaying the game welcome message.

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

This class is used only in boot mode.

Definition at line 35 of file boot_welcome.h.

---

Constructor & Destructor Documentation

hoa_boot::WelcomeScreen::WelcomeScreen

(

)

Definition at line 29 of file boot_welcome.cpp.

References _window, hoa_video::MenuWindow::Create(), hoa_video::MenuWindow::Hide(), and hoa_video::private_video::GUIElement::SetPosition().

Here is the call graph for this function:

hoa_boot::WelcomeScreen::~WelcomeScreen

(

)

Definition at line 64 of file boot_welcome.cpp.

References _welcome_rendered, _window, and hoa_video::MenuWindow::Destroy().

Here is the call graph for this function:

---

Member Function Documentation

void hoa_boot::WelcomeScreen::Draw

(

)

Draws the welcome window on the screen if it is set visible.

Definition at line 75 of file boot_welcome.cpp.

References _welcome_rendered, _window, hoa_video::RenderedString::Draw(), hoa_video::MenuWindow::Draw(), hoa_video::MenuWindow::GetState(), hoa_video::GameVideo::Move(), hoa_video::VIDEO_MENU_STATE_SHOWN, and hoa_video::VideoManager.

Referenced by hoa_boot::BootMode::Draw().

Here is the call graph for this function:

void hoa_boot::WelcomeScreen::Hide

(

)

Hides the welcome window.

Definition at line 109 of file boot_welcome.cpp.

References _visible, _welcome_rendered, _window, hoa_video::MenuWindow::Hide(), hoa_video::GameVideo::SetTextColor(), and hoa_video::VideoManager.

Referenced by hoa_boot::BootMode::Update().

Here is the call graph for this function:

bool hoa_boot::WelcomeScreen::IsVisible

(

)

Returns true if the welcome window is set visible at the moment.

Definition at line 122 of file boot_welcome.cpp.

References _visible.

Referenced by hoa_boot::BootMode::Draw(), and hoa_boot::BootMode::Update().

void hoa_boot::WelcomeScreen::Show

(

)

Shows the welcome window.

Definition at line 92 of file boot_welcome.cpp.

References _visible, _welcome_rendered, _welcome_text, _window, hoa_utils::MakeUnicodeString(), hoa_video::GameVideo::RenderText(), hoa_video::GameVideo::SetFont(), hoa_video::MenuWindow::Show(), and hoa_video::VideoManager.

Referenced by hoa_boot::BootMode::_EndOpeningAnimation().

Here is the call graph for this function:

---

Member Data Documentation

bool hoa_boot::WelcomeScreen::_visible [private]

Is the window visible or not.

Definition at line 59 of file boot_welcome.h.

Referenced by Hide(), IsVisible(), and Show().

hoa_video::RenderedString* hoa_boot::WelcomeScreen::_welcome_rendered [private]

Rendered text string.

Definition at line 62 of file boot_welcome.h.

Referenced by Draw(), Hide(), Show(), and ~WelcomeScreen().

std::string hoa_boot::WelcomeScreen::_welcome_text [private]

Text to be displayed.

Definition at line 65 of file boot_welcome.h.

Referenced by Show().

hoa_video::MenuWindow hoa_boot::WelcomeScreen::_window [private]

Window for the screen.

Definition at line 56 of file boot_welcome.h.

Referenced by Draw(), Hide(), Show(), WelcomeScreen(), and ~WelcomeScreen().

---

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

• boot_welcome.h
• boot_welcome.cpp

---