CLayout Class Reference
The base class providing a common interface forc common functions of each screen layout class. More...
#include <DisplayModule.h>
Inheritance diagram for CLayout:
Public Member Functions | |
| virtual bool | Show ()=0 |
| show the layout, actually adds the current layout as a child of the root window | |
| virtual bool | Hide ()=0 |
| removes the layout from the active layouts (so more seen and no more receiving input) | |
| virtual void | Iterate (float seconds) |
| override this if you want to control the layout over time iterations | |
| virtual void | Update () |
| override this if the layout is custom interactive | |
| bool | isShown () |
| simple isShown query | |
| bool | isLoaded () |
| simple isLoaded query | |
| bool | isActive () |
| query to get input focus state | |
Public Attributes | |
| CEGUI::Window * | layoutRoot |
| the root window holding the root window of the layout | |
Protected Member Functions | |
| virtual bool | Load ()=0 |
| protected Load, should be called automatically when an unloaded layout is shown | |
| virtual bool | Unload ()=0 |
| unloads all the gui-related (cegui) data associated with the layout. | |
Protected Attributes | |
| Ogre::SceneManager * | mSceneMgr |
| A general Scene Manager used by display module. | |
| Ogre::RenderWindow * | mRenderWindow |
| Opsimus application window : there exists only one. | |
| CEGUI::WindowManager * | wMgr |
| so you don't have to write CEGUI::WindowManager::GetSingleton() in each function | |
| stringstream | mStream |
| used for type convertions by many functions TODO change the related imp's to sscanf | |
| bool | mLoaded |
| if the layout is loaded | |
| bool | mShown |
| if the layout is shown | |
Detailed Description
The base class providing a common interface forc common functions of each screen layout class.Member Function Documentation
| virtual void CLayout::Update | ( | ) | [inline, virtual] |
override this if the layout is custom interactive
itshould call necessery update subfunctions related to updating the layout
Reimplemented in CLayoutFCPresim, CLayoutFCSim, and CLayoutTRPresim.
The documentation for this class was generated from the following file:
- DisplayModule.h
