GG
|
This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application. More...
#include <OgreGUI.h>
Public Member Functions | |
OgreGUI (Ogre::RenderWindow *window, const std::string &config_filename="") | |
virtual | ~OgreGUI () |
virtual boost::shared_ptr < ModalEventPump > | CreateModalEventPump (bool &done) |
virtual unsigned int | Ticks () const |
virtual X | AppWidth () const |
virtual Y | AppHeight () const |
const Ogre::SharedPtr < Ogre::DataStream > & | ConfigFileStream () const |
virtual void | Exit (int code) |
Static Public Member Functions | |
static OgreGUI * | GetGUI () |
Public Attributes | |
boost::signal< void()> | HandleSystemEventsSignal |
boost::signal< void(X, Y)> | WindowResizedSignal |
boost::signal< void()> | WindowClosedSignal |
Protected Member Functions | |
virtual void | RenderBegin () |
virtual void | RenderEnd () |
virtual void | Run () |
virtual void | HandleSystemEvents () |
virtual void | Enter2DMode () |
virtual void | Exit2DMode () |
This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application.
Usage:
Any application including an object of this class should declare that object as a local variable in main(). The name of this variable will herein be assumed to be "gui". It should be allocated on the stack; if it is created dynamically, a leak may occur.
OgreGUI serves as a driver of the main Ogre event loop, and mediates between the global GL state set by Ogre and the global GL state set by GG. It also provides important information to the input plugin via its public signals.
OgreGUI does not constitute a complete input driver for GG. This is because Ogre does not provide any direct input support at all (at the time of this writing, Ogre uses an input library called OIS to provide keyboard, mouse, and joystick input). Following the Ogre convention, OgreGUI relies upon the Ogre plugin system to provide the actual input system used by Ogre and GG. A plugin for OIS is provided in the Ogre/Plugins subtree of the GG sources.
Any plugin used with OgreGUI must grab input state (mouse, keyboard, etc.) in response to the firing of OgreGUI::HandleSystemEventsSignal. It is notified of changes in the window size via OgreGUI::WindowResizedSignal. OgreGUI::HandleWindowClose indicates that the Ogre::RenderWindow in which OgreGUI is operating has or is about to close, in case the plugin needs to perform cleanup.
To use OgreGUI, one must first create "gui", then load the input plugin using Ogre's plugin loading mechanism, then call "gui();". For example:
OgreGUI gui(ogre_window, "/path/to/input_plugin.cfg"); ogre_root->loadPlugin("/path/to/plugin"); gui();
When building GG and OgreGUI statically, the input plugin needs to be created and managed by the application, and installed into and uninstalled from the Ogre::Root singleton explicitly. The plugin must be constructed after Ogre::Root has been constructed:
#include <GG/Ogre/Plugins/OISIput.h> ... OgreGUI gui(ogre_window, "/path/to/input_plugin.cfg"); OISInput* ois_input_plugin = new OISInput; ogre_root->installPlugin(ois_input_plugin); gui(); ... ogre_root->uninstallPlugin(ois_input_plugin); delete ois_input_plugin;
GG::OgreGUI::OgreGUI | ( | Ogre::RenderWindow * | window, |
const std::string & | config_filename = "" |
||
) | [explicit] |
Basic ctor. A nonzero window is required, and an optional configuration filename, config_filename. If config_filename is supplied, it will be available via ConfigFileStream().
virtual GG::OgreGUI::~OgreGUI | ( | ) | [virtual] |
Dtor.
virtual boost::shared_ptr<ModalEventPump> GG::OgreGUI::CreateModalEventPump | ( | bool & | done | ) | [virtual] |
Creates a modal event pump suitable for use with Ogre.
Reimplemented from GG::GUI.
const Ogre::SharedPtr<Ogre::DataStream>& GG::OgreGUI::ConfigFileStream | ( | ) | const |
Returns an Ogre::DataStream containing the contents of the config_filename ctor parameter. This will be null if config_filename was not supplied to the ctor.
static OgreGUI* GG::OgreGUI::GetGUI | ( | ) | [static] |
Allows any code to access the gui framework by calling GG::OgreGUI::GetGUI().
Reimplemented from GG::GUI.
virtual void GG::OgreGUI::HandleSystemEvents | ( | ) | [protected, virtual] |
boost::signal<void ()> GG::OgreGUI::HandleSystemEventsSignal |
boost::signal<void (X, Y)> GG::OgreGUI::WindowResizedSignal |
Emitted whenever the OgreGUI's AppWidth() and/or AppHeight() change.
boost::signal<void ()> GG::OgreGUI::WindowClosedSignal |