Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/script_engine/src/lib/graphics/text_engine/text.h @ 8232

Last change on this file since 8232 was 7919, checked in by bensch, 19 years ago

orxonox/trunk: merged the gui branche back
merged with command:
https://svn.orxonox.net/orxonox/branches/gui
no conflicts

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
11#define  TEXT_ALIGN_LEFT             E2D_ALIGN_LEFT
12#define  TEXT_ALIGN_RIGHT            E2D_ALIGN_RIGHT
13#define  TEXT_ALIGN_CENTER           E2D_ALIGN_CENTER
14#define  TEXT_ALIGN_SCREEN_CENTER    E2D_ALIGN_SCREEN_CENTER
15#define  TEXT_DEFAULT_COLOR          Vector(1.0, 1.0, 1.0)      //!< the default Color (white)
16#define  TEXT_DEFAULT_BLENDING       1.0f                       //!< the default blending of the text, (no blending at all)
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->blending = 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 = Vector(r, g, b); };
49    void setSize(float size);
50
51
52    /// RETRIEVE
53    /** @returns the String this Text displays */
54    inline const std::string& getText() const { return this->text; };
55
56    /** @returns the pointer to the stored Font (not changeable) */
57    inline const Font* const getFont() const { return this->font; };
58    /** @returns the Blending Value [0 invisible 1.0 full visible */
59    inline float getBlending() const { return this->blending; };
60    /** @returns: a Vector(r,g,b) @brief: retrieve a Vector holding the Color of the Text */
61    inline const Vector& getColor() const { return this->color; };
62    /** @returns the Size of the Text */
63    inline float getSize() const { return this->size; };
64
65    virtual void draw() const;
66
67    void debug() const;
68
69  protected:
70    virtual void setupTextWidth();
71  private:
72    void init();
73
74  private:
75    Font*             font;           //!< Font of this text
76
77    std::string       text;           //!< The text to display
78    Vector            color;          //!< The color of the font.
79    float             blending;       //!< The blending intensity.
80    float             size;           //!< The size of the Text.
81};
82
83#endif /* _TEXT_H */
Note: See TracBrowser for help on using the repository browser.