CLayoutFCSim Class Reference

CLayoutFCSim. More...

#include <LayoutFCSim.h>

Inheritance diagram for CLayoutFCSim:

CLayout CSingleton

List of all members.

Public Member Functions

bool Show ()
 show the layout, actually adds the current layout as a child of the root window
bool Hide ()
 removes the layout from the active layouts (so more seen and no more receiving input)
void Update ()
 override this if the layout is custom interactive
void Iterate (float seconds)
 override this if you want to control the layout over time iterations
bool Load ()
 protected Load, should be called automatically when an unloaded layout is shown
bool Unload ()
 unloads all the gui-related (cegui) data associated with the layout.
void SetViewTab (char index)
 when called, sets the index of the selected message see ceguitabcontrol::setSelectedTabAtIndex
void SetResponse (const string &responseText)
 sets response text for fc, displayed for 5 seconds, or until a new response is set
void GetOverhearActors (string &name1, string &name2)
 who are you listening to?
void ClearOverhearActors ()
 sets mOverHearActor1 and mOverHearActor2 to ""

Static Public Member Functions

static CLayoutFCSimGetInstance ()
 sub classes should implement this for easy access to self (which is a singleton)

Private Member Functions

bool handle_endSession (const CEGUI::EventArgs &e)
 handle_endSession
bool handle_selectRole (const CEGUI::EventArgs &e)
 handle_selectRole
bool handle_changeBusy (const CEGUI::EventArgs &e)
 handle_changeBusy
bool handle_clearComm (const CEGUI::EventArgs &e)
 handle_clearComm
bool handle_requestComm (const CEGUI::EventArgs &e)
 handle_requestComm
bool handle_selectActComm (const CEGUI::EventArgs &e)
 handle_selectActComm
bool handle_listenActComm (const CEGUI::EventArgs &e)
 handle_listenActComm
bool handle_controlRollup (const CEGUI::EventArgs &e)
 handle_controlRollup
bool handle_bookmarkLoadSave (const CEGUI::EventArgs &e)
 handle_bookmarkLoadSave
bool handle_viewTabChange (const CEGUI::EventArgs &e)
 handle_viewTabChange
bool handle_zoomIn (const CEGUI::EventArgs &e)
 handle_zoomIn
bool handle_zoomOut (const CEGUI::EventArgs &e)
 handle_zoomOut
bool handle_ShowOptions (const CEGUI::EventArgs &e)
 handle_ShowOptions
bool handle_ShowStats (const CEGUI::EventArgs &e)
 handle_ShowStats
bool handle_OverhearStart (const CEGUI::EventArgs &e)
 handle_OverhearStart
bool handle_OverhearEnd (const CEGUI::EventArgs &e)
 handle_OverhearEnd
bool handle_KeyFocus (const CEGUI::EventArgs &e)
 handle_KeyFocus
void PrepareCommFrame ()
void PrepareCustomTabs ()
 reads the scenario specific gui file and attaches them to the tab controller customTabController

Private Attributes

CTimeCheck responseTracker
 to make the response stay on the screen for 5 seconds
bool responsed
 to make the response stay on the screen for 5 seconds. is response on?
unsigned int elapsedTime
 elapsed time since the layout is shown.
bool simClosed
 set to true when sim is closed. this layout may still be seen on eval layout!
bool mIsOverhearing
 are you overhearing anyone?
string mOverHearActor1
 if you are overhearing anyone, who is the first actor, set to "" when no actor.
string mOverHearActor2
 if you are overhearing anyone, who is the second actor, set to "" when no actor.
CEGUI::TabControl * customTabController
 used to link custom tabs to the layout.
map< string, string > mWidgetScriptCBList
 maps widget names to script callback functions


Detailed Description

CLayoutFCSim.

Member Function Documentation

void CLayoutFCSim::PrepareCommFrame (  )  [private]

call frame holds role names and when selected, allows calls/answer/reject/focus on trainee (displayes the trainees name). it gets roles from session module and prepares role list items

void CLayoutFCSim::Update (  )  [virtual]

override this if the layout is custom interactive

itshould call necessery update subfunctions related to updating the layout

Reimplemented from CLayout.


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

Generated on Fri Jun 13 19:46:38 2008 for OPSIMUS by  doxygen 1.5.5