From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_game_screen.html | 1872 +++++++++++++++++++++++++++++++ 1 file changed, 1872 insertions(+) create mode 100644 Doc/doxygen/html/class_game_screen.html (limited to 'Doc/doxygen/html/class_game_screen.html') diff --git a/Doc/doxygen/html/class_game_screen.html b/Doc/doxygen/html/class_game_screen.html new file mode 100644 index 0000000..a66e572 --- /dev/null +++ b/Doc/doxygen/html/class_game_screen.html @@ -0,0 +1,1872 @@ + + + + + +Starshatter_Open: GameScreen Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Static Public Member Functions
+
+
GameScreen Class Reference
+
+
+ +

#include <GameScreen.h>

+
+Inheritance diagram for GameScreen:
+
+
+ + +BaseScreen + +
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 GameScreen ()
virtual ~GameScreen ()
virtual void Setup (Screen *screen)
virtual void TearDown ()
virtual bool CloseTopmost ()
virtual bool IsShown () const
virtual void Show ()
virtual void Hide ()
virtual bool IsFormShown () const
virtual void ShowExternal ()
virtual void ShowNavDlg ()
virtual void HideNavDlg ()
virtual bool IsNavShown ()
virtual NavDlg * GetNavDlg ()
virtual void ShowEngDlg ()
virtual void HideEngDlg ()
virtual bool IsEngShown ()
virtual EngDlg * GetEngDlg ()
virtual void ShowFltDlg ()
virtual void HideFltDlg ()
virtual bool IsFltShown ()
virtual FltDlg * GetFltDlg ()
virtual void ShowCtlDlg ()
virtual void HideCtlDlg ()
virtual bool IsCtlShown ()
virtual void ShowJoyDlg ()
virtual bool IsJoyShown ()
virtual void ShowKeyDlg ()
virtual bool IsKeyShown ()
virtual AudDlg * GetAudDlg () const
virtual VidDlg * GetVidDlg () const
virtual OptDlg * GetOptDlg () const
virtual CtlDlg * GetCtlDlg () const
virtual JoyDlg * GetJoyDlg () const
virtual KeyDlg * GetKeyDlg () const
virtual ModDlg * GetModDlg () const
virtual ModInfoDlg * GetModInfoDlg () const
virtual void ShowAudDlg ()
virtual void HideAudDlg ()
virtual bool IsAudShown ()
virtual void ShowVidDlg ()
virtual void HideVidDlg ()
virtual bool IsVidShown ()
virtual void ShowOptDlg ()
virtual void HideOptDlg ()
virtual bool IsOptShown ()
virtual void ShowModDlg ()
virtual void HideModDlg ()
virtual bool IsModShown ()
virtual void ShowModInfoDlg ()
virtual void HideModInfoDlg ()
virtual bool IsModInfoShown ()
virtual void ApplyOptions ()
virtual void CancelOptions ()
virtual void ShowWeaponsOverlay ()
virtual void HideWeaponsOverlay ()
void SetFieldOfView (double fov)
double GetFieldOfView () const
void CycleMFDMode (int mfd)
void CycleHUDMode ()
void CycleHUDColor ()
void CycleHUDWarn ()
void FrameRate (double f)
void ExecFrame ()
CameraView * GetCameraView () const
Bitmap * GetLensFlare (int index)
- Public Member Functions inherited from BaseScreen
 BaseScreen ()
virtual ~BaseScreen ()
virtual void ShowMsnElemDlg ()
virtual void HideMsnElemDlg ()
virtual MsnElemDlg * GetMsnElemDlg ()
virtual void ShowMsgDlg ()
virtual void HideMsgDlg ()
virtual bool IsMsgShown ()
virtual MsgDlg * GetMsgDlg ()
+ + +

+Static Public Member Functions

static GameScreen * GetInstance ()
+

Detailed Description

+
+

Definition at line 52 of file GameScreen.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
GameScreen::GameScreen ()
+
+ +

Definition at line 66 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
GameScreen::~GameScreen ()
+ 		+virtual
+
+ +

Definition at line 95 of file GameScreen.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ApplyOptions ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 1209 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::CancelOptions ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 1233 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::CloseTopmost ()
+ 		+virtual
+
+ +

Definition at line 478 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + + + +
void GameScreen::CycleHUDColor ()
+
+ +

Definition at line 462 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + + + +
void GameScreen::CycleHUDMode ()
+
+ +

Definition at line 455 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + + + +
void GameScreen::CycleHUDWarn ()
+
+ +

Definition at line 469 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void GameScreen::CycleMFDMode (int mfd)
+
+ +

Definition at line 448 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + + + +
void GameScreen::ExecFrame ()
+
+ +

Definition at line 326 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void GameScreen::FrameRate (double f)
+
+ +

Definition at line 287 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual AudDlg* GameScreen::GetAudDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 95 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
CameraView* GameScreen::GetCameraView () const
+ 		+inline
+
+ +

Definition at line 140 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual CtlDlg* GameScreen::GetCtlDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 98 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual EngDlg* GameScreen::GetEngDlg ()
+ 		+inlinevirtual
+
+ +

Definition at line 77 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + + + +
double GameScreen::GetFieldOfView () const
+
+ +

Definition at line 303 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual FltDlg* GameScreen::GetFltDlg ()
+ 		+inlinevirtual
+
+ +

Definition at line 82 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static GameScreen* GameScreen::GetInstance ()
+ 		+inlinestatic
+
+ +

Definition at line 139 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual JoyDlg* GameScreen::GetJoyDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 99 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual KeyDlg* GameScreen::GetKeyDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 100 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + + + + +
Bitmap * GameScreen::GetLensFlare (int index)
+
+ +

Definition at line 311 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual ModDlg* GameScreen::GetModDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 101 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual ModInfoDlg* GameScreen::GetModInfoDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 102 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual NavDlg* GameScreen::GetNavDlg ()
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 72 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual OptDlg* GameScreen::GetOptDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 97 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual VidDlg* GameScreen::GetVidDlg () const
+ 		+inlinevirtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 96 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::Hide ()
+ 		+virtual
+
+ +

Definition at line 576 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideAudDlg ()
+ 		+virtual
+
+ +

Definition at line 842 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideCtlDlg ()
+ 		+virtual
+
+ +

Definition at line 1078 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideEngDlg ()
+ 		+virtual
+
+ +

Definition at line 740 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideFltDlg ()
+ 		+virtual
+
+ +

Definition at line 791 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideModDlg ()
+ 		+virtual
+
+ +

Definition at line 986 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideModInfoDlg ()
+ 		+virtual
+
+ +

Definition at line 1037 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideNavDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 689 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideOptDlg ()
+ 		+virtual
+
+ +

Definition at line 938 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideVidDlg ()
+ 		+virtual
+
+ +

Definition at line 890 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::HideWeaponsOverlay ()
+ 		+virtual
+
+ +

Definition at line 1180 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsAudShown ()
+ 		+virtual
+
+ +

Definition at line 857 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsCtlShown ()
+ 		+virtual
+
+ +

Definition at line 1093 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsEngShown ()
+ 		+virtual
+
+ +

Definition at line 758 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsFltShown ()
+ 		+virtual
+
+ +

Definition at line 809 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsFormShown () const
+ 		+virtual
+
+ +

Definition at line 600 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsJoyShown ()
+ 		+virtual
+
+ +

Definition at line 1165 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsKeyShown ()
+ 		+virtual
+
+ +

Definition at line 1129 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsModInfoShown ()
+ 		+virtual
+
+ +

Definition at line 1045 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsModShown ()
+ 		+virtual
+
+ +

Definition at line 1001 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsNavShown ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 707 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsOptShown ()
+ 		+virtual
+
+ +

Definition at line 953 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual bool GameScreen::IsShown () const
+ 		+inlinevirtual
+
+ +

Definition at line 62 of file GameScreen.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool GameScreen::IsVidShown ()
+ 		+virtual
+
+ +

Definition at line 905 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void GameScreen::SetFieldOfView (double fov)
+
+ +

Definition at line 295 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void GameScreen::Setup (Screen * screen)
+ 		+virtual
+
+ +

Definition at line 104 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::Show ()
+ 		+virtual
+
+ +

Definition at line 560 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowAudDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 817 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowCtlDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 1053 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowEngDlg ()
+ 		+virtual
+
+ +

Definition at line 715 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowExternal ()
+ 		+virtual
+
+ +

Definition at line 640 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowFltDlg ()
+ 		+virtual
+
+ +

Definition at line 766 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowJoyDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 1137 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowKeyDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 1101 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowModDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 961 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowModInfoDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 1009 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowNavDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 663 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowOptDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 913 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowVidDlg ()
+ 		+virtual
+
+ +

Reimplemented from BaseScreen.

+ +

Definition at line 865 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::ShowWeaponsOverlay ()
+ 		+virtual
+
+ +

Definition at line 1173 of file GameScreen.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void GameScreen::TearDown ()
+ 		+virtual
+
+ +

Definition at line 232 of file GameScreen.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1