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_m_f_d.html | 1412 +++++++++++++++++++++++++++++++++++++ 1 file changed, 1412 insertions(+) create mode 100644 Doc/doxygen/html/class_m_f_d.html (limited to 'Doc/doxygen/html/class_m_f_d.html') diff --git a/Doc/doxygen/html/class_m_f_d.html b/Doc/doxygen/html/class_m_f_d.html new file mode 100644 index 0000000..75dea95 --- /dev/null +++ b/Doc/doxygen/html/class_m_f_d.html @@ -0,0 +1,1412 @@ + + + + + +Starshatter_Open: MFD Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Types | +Protected Attributes
+
+
MFD Class Reference
+
+
+ +

#include <Mfd.h>

+ +

List of all members.

+ + + +

+Public Types

enum  Modes {
+  MFD_MODE_OFF, +MFD_MODE_GAME, +MFD_MODE_SHIP, +MFD_MODE_FOV, +
+  MFD_MODE_HSD, +MFD_MODE_3D +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 MFD (Window *c, int index)
virtual ~MFD ()
int operator== (const MFD &that) const
virtual void Draw ()
virtual void DrawGameMFD ()
virtual void DrawStatusMFD ()
virtual void DrawSensorMFD ()
virtual void DrawHSD ()
virtual void Draw3D ()
virtual void DrawSensorLabels (const char *mfd_mode)
virtual void DrawMap ()
virtual void DrawGauge (int x, int y, int percent)
virtual void SetStatusColor (int status)
virtual void SetWindow (Window *w)
virtual Window * GetWindow ()
virtual void SetRect (const Rect &r)
virtual const Rect & GetRect () const
virtual void SetMode (int m)
virtual int GetMode () const
virtual Sprite * GetSprite ()
virtual void SetShip (Ship *s)
virtual Ship * GetShip ()
virtual void Show ()
virtual void Hide ()
virtual void UseCameraView (CameraView *v)
void DrawMFDText (int index, const char *txt, Rect &r, int align, int status=-1)
void HideMFDText (int index)
void SetText3DColor (Color c)
void SetCockpitHUDTexture (Bitmap *bmp)
bool IsMouseLatched () const
+ + + + +

+Static Public Member Functions

static void Initialize ()
static void Close ()
static void SetColor (Color c)
+ + +

+Protected Types

enum  { TXT_LAST = 20 + }
+ + + + + + + + + + + + + + +

+Protected Attributes

Window * window
Rect rect
int index
int mode
int lines
Sprite * sprite
bool hidden
Ship * ship
HUDText mfd_text [TXT_LAST]
CameraView * camview
Bitmap * cockpit_hud_texture
int mouse_latch
bool mouse_in
+

Detailed Description

+
+

Definition at line 32 of file Mfd.h.

+

Member Enumeration Documentation

+ +
+
+ + + + + +
+ + + + +
anonymous enum
+ 		+protected
+
+
Enumerator:
+ +
TXT_LAST  +
+
+
+ +

Definition at line 85 of file Mfd.h.

+ +
+
+ +
+
+ + + + +
enum MFD::Modes
+
+
Enumerator:
+ + + + + + +
MFD_MODE_OFF  +
MFD_MODE_GAME  +
MFD_MODE_SHIP  +
MFD_MODE_FOV  +
MFD_MODE_HSD  +
MFD_MODE_3D  +
+
+
+ +

Definition at line 35 of file Mfd.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
MFD::MFD (Window * c,
int index 
)
+
+ +

Definition at line 68 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
MFD::~MFD ()
+ 		+virtual
+
+ +

Definition at line 88 of file Mfd.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void MFD::Close ()
+ 		+static
+
+ +

Definition at line 115 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::Draw ()
+ 		+virtual
+
+ +

Definition at line 249 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::Draw3D ()
+ 		+virtual
+
+ +

Definition at line 832 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::DrawGameMFD ()
+ 		+virtual
+
+ +

Definition at line 1079 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void MFD::DrawGauge (int x,
int y,
int percent 
)
+ 		+virtual
+
+ +

Definition at line 1056 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::DrawHSD ()
+ 		+virtual
+
+ +

Definition at line 608 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::DrawMap ()
+ 		+virtual
+
+ +

Definition at line 1048 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void MFD::DrawMFDText (int index,
const char * txt,
Rect & r,
int align,
int status = -1 
)
+
+ +

Definition at line 1337 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MFD::DrawSensorLabels (const char * mfd_mode)
+ 		+virtual
+
+ +

Definition at line 321 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::DrawSensorMFD ()
+ 		+virtual
+
+ +

Definition at line 403 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::DrawStatusMFD ()
+ 		+virtual
+
+ +

Definition at line 1151 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int MFD::GetMode () const
+ 		+inlinevirtual
+
+ +

Definition at line 66 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual const Rect& MFD::GetRect () const
+ 		+inlinevirtual
+
+ +

Definition at line 64 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Ship* MFD::GetShip ()
+ 		+inlinevirtual
+
+ +

Definition at line 70 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Sprite* MFD::GetSprite ()
+ 		+inlinevirtual
+
+ +

Definition at line 67 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual Window* MFD::GetWindow ()
+ 		+inlinevirtual
+
+ +

Definition at line 62 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::Hide ()
+ 		+virtual
+
+ +

Definition at line 183 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void MFD::HideMFDText (int index)
+
+ +

Definition at line 1394 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::Initialize ()
+ 		+static
+
+ +

Definition at line 96 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + + + +
bool MFD::IsMouseLatched () const
+
+ +

Definition at line 1330 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int MFD::operator== (const MFD & that) const
+ 		+inline
+
+ +

Definition at line 43 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MFD::SetCockpitHUDTexture (Bitmap * bmp)
+ 		+inline
+
+ +

Definition at line 79 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MFD::SetColor (Color c)
+ 		+static
+
+ +

Definition at line 139 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MFD::SetMode (int m)
+ 		+virtual
+
+ +

Definition at line 210 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MFD::SetRect (const Rect & r)
+ 		+virtual
+
+ +

Definition at line 197 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MFD::SetShip (Ship * s)
+ 		+inlinevirtual
+
+ +

Definition at line 69 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MFD::SetStatusColor (int status)
+ 		+virtual
+
+ +

Definition at line 1315 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void MFD::SetText3DColor (Color c)
+
+ +

Definition at line 159 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MFD::SetWindow (Window * w)
+ 		+inlinevirtual
+
+ +

Definition at line 61 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MFD::Show ()
+ 		+virtual
+
+ +

Definition at line 168 of file Mfd.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MFD::UseCameraView (CameraView * v)
+ 		+virtual
+
+ +

Definition at line 131 of file Mfd.cpp.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
CameraView* MFD::camview
+ 		+protected
+
+ +

Definition at line 96 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap* MFD::cockpit_hud_texture
+ 		+protected
+
+ +

Definition at line 97 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool MFD::hidden
+ 		+protected
+
+ +

Definition at line 93 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MFD::index
+ 		+protected
+
+ +

Definition at line 89 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MFD::lines
+ 		+protected
+
+ +

Definition at line 91 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
HUDText MFD::mfd_text[TXT_LAST]
+ 		+protected
+
+ +

Definition at line 95 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MFD::mode
+ 		+protected
+
+ +

Definition at line 90 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool MFD::mouse_in
+ 		+protected
+
+ +

Definition at line 100 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MFD::mouse_latch
+ 		+protected
+
+ +

Definition at line 99 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Rect MFD::rect
+ 		+protected
+
+ +

Definition at line 88 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Ship* MFD::ship
+ 		+protected
+
+ +

Definition at line 94 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Sprite* MFD::sprite
+ 		+protected
+
+ +

Definition at line 92 of file Mfd.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Window* MFD::window
+ 		+protected
+
+ +

Definition at line 87 of file Mfd.h.

+ +
+
+
The documentation for this class was generated from the following files:
    +
  • D:/SRC/StarshatterSVN/Stars45/Mfd.h
    • +
  • D:/SRC/StarshatterSVN/Stars45/Mfd.cpp
    • +
+
+
+ + + + -- cgit v1.1