Emergency 20 Dokumentation  4.2.0
em5::MiniMapWindow Class Reference

EMERGENCY 5 mini-map window HUD element. More...

#include <MiniMapWindow.h>

Inheritance diagram for em5::MiniMapWindow:
qsf::GuiDocument

Public Member Functions

 MiniMapWindow (qsf::GuiContext &guiContext)
 
virtual ~MiniMapWindow ()
 
void setMap (qsf::Map &map)
 
void rebuildGui (bool forceRebuild=false)
 
bool isUnitOverviewButtonVisible () const
 
void setUnitOverviewButtonVisible (bool visible)
 
void setPingButtonVisible (bool visible)
 
void setFilterButtonsVisible (bool visible)
 
MiniMapRenderergetRenderer () const
 
Rocket::Core::Geometry * getLibRocketGeometry () const
 
virtual void processEvent (const std::string &eventKey, Rocket::Core::Event &event) override
 
- Public Member Functions inherited from qsf::GuiDocument
 GuiDocument (GuiContext &guiContext)
 Constructor. More...
 
 GuiDocument (GuiContext &guiContext, Rocket::Core::ElementDocument &rocketCoreElementDocument)
 Constructor. More...
 
virtual ~GuiDocument ()
 Destructor. More...
 
GuiContextgetGuiContext () const
 Return the document's owning GUI context. More...
 
Rocket::Core::ElementDocument * getRocketCoreElementDocument () const
 Return the document's libRocket document. More...
 
bool loadByFilename (const std::string &filename)
 Load the document from an RML file. More...
 
void unload ()
 Use this method if you want to change a documents .rml file at runtime. More...
 
void show ()
 Show the document. More...
 
void showFocused ()
 Show the document focused. More...
 
void showModal ()
 Show the document modal. More...
 
void hide ()
 Hide the document. More...
 
bool isVisible () const
 Check if the document is currently visible. More...
 
void setVisible (bool visible)
 Show/hide the document. More...
 
void pullToFront ()
 Pull the document to the front. More...
 
Rocket::Core::Element * findElementById (const std::string &elementId) const
 Find an element inside the document by its case-sensitive ID. More...
 
void registerNewButton (const std::string &buttonId, const std::string &event, const std::string &eventKey)
 Register a new button. More...
 
virtual void toggleVisibility ()
 Toggle visibility. More...
 
virtual void processViewportDimensionsChanged (int width, int height)
 

Additional Inherited Members

- Static Public Member Functions inherited from qsf::GuiDocument
static Rocket::Core::EventListener * createEventListener (const std::string &eventKey)
 Create an event listener. More...
 
static GuiDocumentgetGuiDocumentByRocketCoreElement (Rocket::Core::Element *element)
 Return a QSF GUI document instance by using a given libRocket element instance. More...
 
- Protected Member Functions inherited from qsf::GuiDocument
void createEmptyDocument ()
 

Detailed Description

EMERGENCY 5 mini-map window HUD element.

Constructor & Destructor Documentation

em5::MiniMapWindow::MiniMapWindow ( qsf::GuiContext guiContext)
explicit
virtual em5::MiniMapWindow::~MiniMapWindow ( )
virtual

Member Function Documentation

Rocket::Core::Geometry * em5::MiniMapWindow::getLibRocketGeometry ( ) const
inline
MiniMapRenderer & em5::MiniMapWindow::getRenderer ( ) const
inline
bool em5::MiniMapWindow::isUnitOverviewButtonVisible ( ) const
inline
virtual void em5::MiniMapWindow::processEvent ( const std::string &  eventKey,
Rocket::Core::Event &  event 
)
overridevirtual

Reimplemented from qsf::GuiDocument.

void em5::MiniMapWindow::rebuildGui ( bool  forceRebuild = false)
void em5::MiniMapWindow::setFilterButtonsVisible ( bool  visible)
void em5::MiniMapWindow::setMap ( qsf::Map map)
void em5::MiniMapWindow::setPingButtonVisible ( bool  visible)
void em5::MiniMapWindow::setUnitOverviewButtonVisible ( bool  visible)

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