Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/cd/src/lib/shell/shell.h @ 7568

Last change on this file since 7568 was 7341, checked in by bensch, 19 years ago

orxonox/trunk: shell in c++-style now

File size: 3.8 KB
Line 
1/*!
2 * @file shell.h
3 * Definition of a on-screen-shell
4 *
5 * @todo Buffer Display in different Colors for different debug mode.
6 * @todo choose color of the Font and the background.
7 */
8
9#ifndef _SHELL_H
10#define _SHELL_H
11
12#include "element_2d.h"
13#include "event_listener.h"
14
15#include "shell_input.h"
16
17#define         SHELL_DEFAULT_FONT              "fonts/dpquake_.ttf"
18#define         SHELL_DEFAULT_TEXT_COLOR        1.0f, 0.0f, 0.0f, 1.0f
19#define         SHELL_DEFAULT_BACKGROUND_COLOR  0.0f, 0.0f, 0.0f, 1.0f
20
21// FORWARD DECLARATION
22class Text;
23class ShellInput;
24class Material;
25
26//! A class that is able to redirect all output to a openGL-Shell, and that one can use to input some commands
27/**
28 * the major idea is, that all the Output can be redirected to the Shell,
29 * and does not have to be displayed to the opening Shell, this is good,
30 * for developers using Windows, where all output is otherwise redirected
31 * to stdout.txt
32 *
33 * Furthermore the Shell should enable us, to input some simple commands
34 * Each Class can check itself in to the Shell, and listen for commands.
35 *
36 * more info: @see ShellCommand
37 * @see shell_command.h
38 * @see shell_buffer.h
39 * @see shell_input.h
40 *
41 * !! note in order to keep shellbuffer to a minimal (it is included with
42 * !! debug.h) Display of it inside the Shell is located here !!
43 */
44class Shell : public Element2D, public EventListener {
45
46  public:
47    Shell();
48    virtual ~Shell();
49
50    void activate();
51    void deactivate();
52    /** @returns true if the Shell is active, false otherwise. */
53    inline bool isActive() const { return this->bActive; };
54
55    void setFont(const std::string& fontFile);
56    void setTextSize(unsigned int textSize, unsigned int lineSpacing = 1);
57    void setTextColor(float r, float g, float b, float a);
58    void setBackgroundColor(float r, float g, float b, float a);
59    void setBackgroundImage(const std::string& fileName);
60
61    void resetValues();
62
63    // BUFFERS
64    void setBufferDisplaySize(unsigned int bufferDisplaySize);
65    void printToDisplayBuffer(const std::string& text);
66    void moveDisplayBuffer(int lineCount);
67
68    void flush();
69
70    void clear();
71
72    // EventListener
73    virtual void process(const Event &event);
74    // Element2D-functions
75    virtual void draw() const;
76
77    void debug() const;
78
79  private:
80    // helpers //
81    Vector2D calculateLinePosition(unsigned int lineNumber);
82
83    //     void testI (int i);
84    //     void testS (const std::string& s);
85    //     void testB (bool b);
86    //     void testF (float f);
87    //     void testSF (const std::string& s, float f);
88
89  private:
90    // GENERAL
91    bool                        bActive;                //!< If the shell is active.
92    unsigned int                shellHeight;            //!< The hight of the Shell in Pixels.
93    unsigned int                lineSpacing;            //!< The Spacing between lines.
94    unsigned int                textSize;               //!< The size of the text.
95    float                       textColor[4];           //!< The text's color [r,g,b,a].
96    std::string                 fontFile;               //!< The file containing the font.
97    Material*                   backgroundMaterial;     //!< A material for the background.
98
99    // HANDLING TEXT INPUT
100    ShellInput                  shellInput;             //!< The inputLine of the Shell.
101    // BUFFER
102    unsigned int                bufferDisplaySize;      //!< The Size of the Display-buffer, in lines (not in characters).
103    std::list<Text*>            bufferText;             //!< A list of stored bufferTexts for the display of the buffer.
104    int                         bufferOffset;           //!< how many lines from the bottom up we display the Buffer.
105    std::list<std::string>::const_iterator  bufferIterator;         //!< used to move through and print the Buffer
106};
107
108#endif /* _SHELL_H */
Note: See TracBrowser for help on using the repository browser.