Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/bsp_model/src/lib/graphics/text_engine/text.h @ 8558

Last change on this file since 8558 was 8448, checked in by bensch, 19 years ago

merged gui back to the trunk
merged with command
merge -r8377:HEAD https://svn.orxonox.net/orxonox/branches/gui .

File size: 3.0 KB
Line 
1/*!
2 * @file text.h
3 * @brief Definition of a text Class, that is able to render text.
4 */
5
6#ifndef _TEXT_H
7#define _TEXT_H
8
9#include "element_2d.h"
10#include "color.h"
11
12#define  TEXT_ALIGN_LEFT             E2D_ALIGN_LEFT
13#define  TEXT_ALIGN_RIGHT            E2D_ALIGN_RIGHT
14#define  TEXT_ALIGN_CENTER           E2D_ALIGN_CENTER
15#define  TEXT_ALIGN_SCREEN_CENTER    E2D_ALIGN_SCREEN_CENTER
16#define  TEXT_DEFAULT_COLOR          Color(1.0, 1.0, 1.0, 1.0f) //!< the default Color (white, fully visible)
17
18#define  TEXT_DEFAULT_ALIGNMENT      TEXT_ALIGN_LEFT            //!< default alignment
19#define  TEXT_DEFAULT_SIZE           20                         //!< default size of the Text
20
21// FORWARD DECLARATION
22class Font;
23struct SDL_Surface;
24
25//! Represents one textElement.
26class Text : public Element2D
27{
28  public:
29    Text(const std::string& fontFile = "", unsigned int fontSize = TEXT_DEFAULT_SIZE);
30    Text(const Text& text);
31    virtual ~Text();
32    bool operator==(const Text& text) const;
33    bool operator==(const std::string& text) const;
34    Text& operator=(const Text& text);
35
36    /// Final Interfacing.
37    void setText(const std::string& text);
38    void append(const std::string& appendText);
39    void appendCharacter(char character);
40    const std::string& operator<<(const std::string& appendText);
41    void removeCharacters(unsigned int chars);
42
43    /// SETUP
44    void setFont(const std::string& fontFile, unsigned int renderSize);
45    /** @param blending the blending intensity to set (between 0.0 and 1.0) */
46    inline void setBlending(float blending) { this->color.a() = blending; };
47    /** @param r red @param g green @param b blue @brief sets the Color of the Text to render (values in [0-1]) */
48    void setColor(float r, float g, float b) { this->color = Color(r, g, b, this->color.a()); };
49    void setColor(float r, float g, float b, float a) { this->color = Color(r, g, b, a); };
50    void setColor(const Color& color) { this->color = color; };
51    void setSize(float size);
52
53
54    /// RETRIEVE
55    /** @returns the String this Text displays */
56    inline const std::string& getText() const { return this->text; };
57
58    /** @returns the pointer to the stored Font (not changeable) */
59    inline const Font* const getFont() const { return this->font; };
60    /** @returns the Blending Value [0 invisible 1.0 full visible */
61    inline float getBlending() const { return this->color.a(); };
62    /** @returns: a Vector(r,g,b) @brief: retrieve a Vector holding the Color of the Text */
63    inline const Color& getColor() const { return this->color; };
64    /** @returns the Size of the Text */
65    inline float getSize() const { return this->size; };
66
67    virtual void draw() const;
68
69    void debug() const;
70
71  protected:
72    virtual void setupTextWidth();
73  private:
74    void init();
75
76  private:
77    Font*             font;           //!< Font of this text
78
79    std::string       text;           //!< The text to display
80    Color             color;          //!< The color of the font.
81    float             size;           //!< The size of the Text.
82};
83
84#endif /* _TEXT_H */
Note: See TracBrowser for help on using the repository browser.