regcom::client::Console

Console Class Reference

#include <Console.h>

Inheritance diagram for Console:

Window

List of all members.


Public Member Functions

 Console ()
 Public constructor.
virtual ~Console ()
 Virtual destructor.
virtual void Draw (gui::Rect rect)
 (*** add brief description here ***)
virtual void OnMouseMove (gui::Point point)
 (*** add brief description here ***)
virtual void OnMouseDown (int n, gui::Point point)
 (*** add brief description here ***)
virtual void OnMouseUp (int n, gui::Point point)
 (*** add brief description here ***)
void SetStatus (const std::string &rStatus)
 (*** add brief description here ***)
void SetMapView (MapView *pView)
 (*** add brief description here ***)
void SetRadarCursor (gui::Rect rect)
 (*** add brief description here ***)
void ScanMap (regcom::common::Map *pMap)
 (*** add brief description here ***)
virtual int Contains (gui::Point point)
 (*** add brief description here ***)

Private Attributes

RadarView * m_pRadarView
 (*** add brief description here ***)
gui::StringView * m_Status
 (*** add brief description here ***)
gui::Surface * m_pFrameImage
 (*** add brief description here ***)
gui::Button * m_pButtonTable [8]
 (*** add brief description here ***)
bool m_Dragging
 (*** add brief description here ***)
int m_DragX
 (*** add brief description here ***)
int m_DragY
 (*** add brief description here ***)

Static Private Attributes

static const int BUTTON_COUNT = 5
 (*** add brief description here ***)
static const int BUTTON_X0 = 6
 (*** add brief description here ***)
static const int BUTTON_Y0 = 156
 (*** add brief description here ***)
static const int BUTTON_WIDTH = 40
 (*** add brief description here ***)
static const int BUTTON_HEIGHT = 16
 (*** add brief description here ***)
static const ButtonInfo s_ButtonInfo [BUTTON_COUNT]
 (*** add brief description here ***)

Detailed Description

(*** add brief description here ***)
Full Description
(*** add full description here ***)

Constructor & Destructor Documentation

Console (  ) 

Public constructor.

Full Description
This method creates a new instance of the class.
Returns:
New instance of the class.

~Console (  )  [virtual]

Virtual destructor.

Full Description
This method destroys an existing instance of the class.
Returns:
None.

Member Function Documentation

void Draw ( gui::Rect  rect  )  [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
rect  (*** add description here ***)

Reimplemented from Window.

void OnMouseMove ( gui::Point  point  )  [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
point  (*** add description here ***)

Reimplemented from Window.

void OnMouseDown ( int  n,
gui::Point  point 
) [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
n  (*** add description here ***)
point  (*** add description here ***)

Reimplemented from Window.

void OnMouseUp ( int  n,
gui::Point  point 
) [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
n  (*** add description here ***)
point  (*** add description here ***)

Reimplemented from Window.

void SetStatus ( const std::string &  rStatus  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
rStatus  (*** add description here ***)

void SetMapView ( MapView *  pView  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
pView  (*** add description here ***)

void SetRadarCursor ( gui::Rect  rect  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
rect  (*** add description here ***)

void ScanMap ( regcom::common::Map *  pMap  ) 

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
pMap  (*** add description here ***)

int Contains ( gui::Point  point  )  [virtual]

(*** add brief description here ***)

Full Description
(*** add full description here ***)
Returns:
(*** add return description here ***)
Parameters:
point  (*** add description here ***)

Reimplemented from Window.

Member Data Documentation

RadarView* m_pRadarView [private]

(*** add brief description here ***)

gui::StringView* m_Status [private]

(*** add brief description here ***)

gui::Surface* m_pFrameImage [private]

(*** add brief description here ***)

gui::Button* m_pButtonTable[8] [private]

(*** add brief description here ***)

bool m_Dragging [private]

(*** add brief description here ***)

int m_DragX [private]

(*** add brief description here ***)

int m_DragY [private]

(*** add brief description here ***)

const int BUTTON_COUNT = 5 [static, private]

(*** add brief description here ***)

const int BUTTON_X0 = 6 [static, private]

(*** add brief description here ***)

const int BUTTON_Y0 = 156 [static, private]

(*** add brief description here ***)

const int BUTTON_WIDTH = 40 [static, private]

(*** add brief description here ***)

const int BUTTON_HEIGHT = 16 [static, private]

(*** add brief description here ***)

const ButtonInfo s_ButtonInfo [static, private]

Initial value:

{
    { BUTTON_X0, BUTTON_Y0 + 0*BUTTON_HEIGHT,
        Client::USER_EVENT_ZOOM_IN, "Zoom in" },
    { BUTTON_X0, BUTTON_Y0 + 1*BUTTON_HEIGHT,
        Client::USER_EVENT_ZOOM_OUT, "Zoom out" },
    { BUTTON_X0, BUTTON_Y0 + 2*BUTTON_HEIGHT,
        Client::USER_EVENT_TOGGLE_GRID, "Toggle grid" },
    { BUTTON_X0, BUTTON_Y0 + 3*BUTTON_HEIGHT,
        Client::USER_EVENT_NEW_MAP, "New map" },
    { BUTTON_X0, BUTTON_Y0 + 4*BUTTON_HEIGHT,
        Client::USER_EVENT_QUIT_GAME, "Quit game" }
}
(*** add brief description here ***)

Full Description
(*** add full description here ***)

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