ImageFont base class. More...
#include <imagefontbase.h>
Inheritance diagram for FIFE::ImageFontBase:
Collaboration diagram for FIFE::ImageFontBase:
Classes | |
| struct | s_glyph |
Public Member Functions | |
| ImageFontBase () | |
| Constructor. More... | |
| virtual | ~ImageFontBase () |
| Destructor. More... | |
| virtual int32_t | getWidth (const std::string &text) const |
| Get the width in pixels a given text would occupy. More... | |
| virtual int32_t | getHeight () const |
| Get the height in pixels a text line would occupy. More... | |
| virtual SDL_Surface * | renderString (const std::string &text) |
| virtual void | setColor (uint8_t r, uint8_t g, uint8_t b, uint8_t a=255) |
| Set the color the text should be rendered in. More... | |
| Public Member Functions inherited from FIFE::FontBase | |
| FontBase () | |
| virtual | ~FontBase () |
| void | invalidate () |
| void | setRowSpacing (int32_t spacing) |
| Sets the spacing between rows in pixels. More... | |
| int32_t | getRowSpacing () const |
| Gets the spacing between rows in pixels. More... | |
| void | setGlyphSpacing (int32_t spacing) |
| Sets the spacing between letters in pixels. More... | |
| int32_t | getGlyphSpacing () const |
| Gets the spacing between letters in pixels. More... | |
| virtual void | setAntiAlias (bool antiAlias) |
| Sets the use of anti aliasing. More... | |
| virtual bool | isAntiAlias () const |
| Checks if anti aliasing is used. More... | |
| virtual void | setBoldStyle (bool style) |
| Sets the use of bold style. More... | |
| virtual bool | isBoldStyle () const |
| Checks if bold style is used. More... | |
| virtual void | setItalicStyle (bool style) |
| Sets the use of italic style. More... | |
| virtual bool | isItalicStyle () const |
| Checks if italic style is used. More... | |
| virtual void | setUnderlineStyle (bool style) |
| Sets the use of underline style. More... | |
| virtual bool | isUnderlineStyle () const |
| Checks if underline style is used. More... | |
| virtual void | setStrikethroughStyle (bool style) |
| Sets the use of strikethrough style. More... | |
| virtual bool | isStrikethroughStyle () const |
| Checks if strikethrough style is used. More... | |
| virtual void | setDynamicColoring (bool coloring) |
| virtual bool | isDynamicColoring () const |
| virtual int32_t | getStringIndexAt (const std::string &text, int32_t x) const |
| Image * | getAsImage (const std::string &text) |
| Gets given text as Image The rsulting image is pooled, so it's not that time critical. More... | |
| Image * | getAsImageMultiline (const std::string &text) |
| Gets given text as Image. More... | |
| std::string | splitTextToWidth (const std::string &text, int32_t render_width) |
| SDL_Color | getColor () const |
| Get the color the text was rendered in. More... | |
| Public Member Functions inherited from FIFE::IFont | |
| virtual | ~IFont () |
Protected Types | |
| typedef std::map< int32_t, s_glyph > | type_glyphs |
Protected Attributes | |
| type_glyphs | m_glyphs |
| s_glyph | m_placeholder |
| int32_t | m_height |
| Protected Attributes inherited from FIFE::FontBase | |
| TextRenderPool | m_pool |
| SDL_Color | mColor |
| int32_t | mGlyphSpacing |
| int32_t | mRowSpacing |
| std::string | mFilename |
| bool | m_antiAlias |
| bool | m_boldStyle |
| bool | m_italicStyle |
| bool | m_underlineStyle |
| bool | m_strikeStyle |
| bool | m_coloring |
Detailed Description
ImageFont base class.
Just set the glyphs/placeholder in any derived class and the rendering is handled by this class. Also frees all glyph surfaces on destruction.
Definition at line 46 of file imagefontbase.h.
Member Typedef Documentation
◆ type_glyphs
|
protected |
Definition at line 81 of file imagefontbase.h.
Constructor & Destructor Documentation
◆ ImageFontBase()
| FIFE::ImageFontBase::ImageFontBase | ( | ) |
Constructor.
Definition at line 43 of file imagefontbase.cpp.
◆ ~ImageFontBase()
|
virtual |
Member Function Documentation
◆ getHeight()
|
virtual |
Get the height in pixels a text line would occupy.
Implements FIFE::IFont.
Definition at line 73 of file imagefontbase.cpp.
References m_height.
Referenced by renderString().
Here is the caller graph for this function:
◆ getWidth()
|
virtual |
Get the width in pixels a given text would occupy.
- Parameters
-
text The text that should be measured.
Implements FIFE::IFont.
Definition at line 54 of file imagefontbase.cpp.
References FIFE::FontBase::getGlyphSpacing(), m_glyphs, m_placeholder, utf8::next(), and FIFE::ImageFontBase::s_glyph::surface.
Referenced by renderString().
Here is the caller graph for this function:
◆ renderString()
|
virtual |
Implements FIFE::FontBase.
Definition at line 77 of file imagefontbase.cpp.
References FIFE::AMASK, FIFE::BMASK, FIFE::FontBase::getGlyphSpacing(), getHeight(), getWidth(), FIFE::GMASK, m_glyphs, m_placeholder, utf8::next(), FIFE::ImageFontBase::s_glyph::offset, FIFE::RMASK, FIFE::ImageFontBase::s_glyph::surface, FIFE::PointType2D< T >::x, and FIFE::PointType2D< T >::y.
◆ setColor()
|
virtual |
Set the color the text should be rendered in.
Implements FIFE::IFont.
Definition at line 111 of file imagefontbase.cpp.
Member Data Documentation
◆ m_glyphs
|
protected |
Definition at line 82 of file imagefontbase.h.
Referenced by getWidth(), renderString(), FIFE::SubImageFont::SubImageFont(), and ~ImageFontBase().
◆ m_height
|
protected |
Definition at line 88 of file imagefontbase.h.
Referenced by getHeight(), and FIFE::SubImageFont::SubImageFont().
◆ m_placeholder
|
protected |
Definition at line 86 of file imagefontbase.h.
Referenced by getWidth(), renderString(), and FIFE::SubImageFont::SubImageFont().
The documentation for this class was generated from the following files:
- engine/core/video/fonts/imagefontbase.h
- engine/core/video/fonts/imagefontbase.cpp
