Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/tutorial4/src/orxonox/overlays/InGameConsole.h @ 12141

Last change on this file since 12141 was 8858, checked in by landauf, 14 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.3 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 *      Felix Schulthess
24 *   Co-authors:
25 *      Fabian 'x3n' Landau
26 *
27 */
28
29#ifndef _InGameConsole_H__
30#define _InGameConsole_H__
31
32
33#include "OrxonoxPrereqs.h"
34
35#include <string>
36
37#include "util/OgreForwardRefs.h"
38#include "util/Singleton.h"
39#include "core/WindowEventListener.h"
40#include "core/command/Shell.h"
41
42namespace orxonox
43{
44    class _OrxonoxExport InGameConsole : public Singleton<InGameConsole>, public ShellListener, public WindowEventListener
45    {
46        friend class Singleton<InGameConsole>;
47    public: // functions
48        InGameConsole();
49        ~InGameConsole();
50
51        void initialise();
52        void setConfigValues();
53
54        void preUpdate(const Clock& time);
55
56        static void openConsole();
57        static void closeConsole();
58
59    private: // functions
60        InGameConsole(const InGameConsole& other);
61
62        void activate();
63        void deactivate();
64
65        void linesChanged();
66        void lineAdded();
67        void inputChanged();
68        void cursorChanged();
69        void executed();
70        void exit();
71
72        void shiftLines();
73        void colourLine(Shell::LineType type, int index);
74        void setCursorPosition(unsigned int pos);
75        void print(const std::string& text, Shell::LineType type, int index, bool alwaysShift = false);
76
77        void windowResized(unsigned int newWidth, unsigned int newHeight);
78
79        // config value related
80        void bHidesAllInputChanged();
81
82    private: // variables
83        Shell* shell_;
84        bool bActive_;
85        int windowW_;
86        int windowH_;
87        int desiredTextWidth_;
88        unsigned int maxCharsPerLine_;
89        unsigned int numLinesShifted_;
90        int scroll_;
91        float cursor_;
92        unsigned int inputWindowStart_;
93        bool bShowCursor_;
94        std::string displayedText_;
95        Ogre::Overlay* consoleOverlay_;
96        Ogre::OverlayContainer* consoleOverlayContainer_;
97        Ogre::PanelOverlayElement* consoleOverlayNoise_;
98        Ogre::TextAreaOverlayElement* consoleOverlayCursor_;
99        Ogre::BorderPanelOverlayElement* consoleOverlayBorder_;
100        Ogre::TextAreaOverlayElement** consoleOverlayTextAreas_;
101
102        // input related
103        InputState* inputState_;
104
105        // config values
106        float relativeWidth;
107        float relativeHeight;
108        float blinkTime;
109        float scrollSpeed_;
110        float noiseSize_;
111        char cursorSymbol_;
112        bool bHidesAllInput_;
113
114        static InGameConsole* singletonPtr_s;
115    };
116}
117
118#endif /* _InGameConsole_H__ */
Note: See TracBrowser for help on using the repository browser.