Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/SpaceshipNavigation2/src/modules/overlays/GUIOverlay.cc @ 9689

Last change on this file since 9689 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 3.1 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Benjamin Knecht
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "GUIOverlay.h"
30
31#include <string>
32
33#include "util/Convert.h"
34#include "core/input/InputManager.h"
35#include "core/CoreIncludes.h"
36#include "core/GUIManager.h"
37#include "core/XMLPort.h"
38#include "infos/PlayerInfo.h"
39#include "worldentities/ControllableEntity.h"
40
41namespace orxonox
42{
43    CreateFactory(GUIOverlay);
44
45    GUIOverlay::GUIOverlay(BaseObject* creator) : OrxonoxOverlay(creator)
46    {
47        RegisterObject(GUIOverlay);
48    }
49
50    GUIOverlay::~GUIOverlay()
51    {
52    }
53
54    void GUIOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)
55    {
56        SUPER(GUIOverlay, XMLPort, xmlelement, mode);
57
58        XMLPortParam(GUIOverlay, "guiname", setGUIName, getGUIName, xmlelement, mode);
59    }
60
61    void GUIOverlay::changedVisibility()
62    {
63        SUPER(GUIOverlay, changedVisibility);
64
65        //Setting player now.
66        if (this->getOwner())
67        {
68            ControllableEntity* entity = orxonox_cast<ControllableEntity*>(this->getOwner());
69            if (entity)
70                GUIManager::getInstance().setPlayer(this->guiName_, entity->getPlayer());
71        }
72
73        if (this->isVisible())
74        {
75            const std::string& str = multi_cast<std::string>(reinterpret_cast<long>(this));
76            GUIManager::getInstance().showGUIExtra(this->guiName_, str);
77
78            orxout(verbose, context::misc::gui) << "Showing GUI " << this->guiName_ << endl;
79        }
80        else
81        {
82            GUIManager::hideGUI(this->guiName_);
83            orxout(verbose, context::misc::gui) << "Hiding GUI " << this->guiName_ << endl;
84        }
85    }
86
87    void GUIOverlay::setGUIName(const std::string& name)
88    {
89        this->guiName_ = name;
90        if (this->getOwner())
91        {
92            ControllableEntity* entity = orxonox_cast<ControllableEntity*>(this->getOwner());
93            if (entity)
94                GUIManager::getInstance().setPlayer(name, entity->getPlayer()); //Set Player is going to be NULL, so it needs to be set in changedVisibility() as well.
95        }
96    }
97
98    void GUIOverlay::changedOwner()
99    {
100        SUPER(GUIOverlay, changedOwner);
101        if (!this->getGUIName().empty())
102            this->setGUIName(this->getGUIName());
103    }
104}
Note: See TracBrowser for help on using the repository browser.