Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/world_entities/src/lib/shell/shell.h @ 5739

Last change on this file since 5739 was 5513, checked in by bensch, 19 years ago

orxonox/trunk: color adaption in the shell
isA also with String (slow)

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