diff options
author | Johannes Schickel | 2014-06-09 18:54:49 +0200 |
---|---|---|
committer | Johannes Schickel | 2014-09-03 22:55:48 +0200 |
commit | d55cd8f3b44de42d9be09280634584b6424945f9 (patch) | |
tree | 3f4b89405c8d4dd8e34f46382ebb2f13d4dfd998 /graphics/font.h | |
parent | 58bfb3b43588152490efc55c24ca8c94e8f39e38 (diff) | |
download | scummvm-rg350-d55cd8f3b44de42d9be09280634584b6424945f9.tar.gz scummvm-rg350-d55cd8f3b44de42d9be09280634584b6424945f9.tar.bz2 scummvm-rg350-d55cd8f3b44de42d9be09280634584b6424945f9.zip |
GRAPHICS: Allow to query the bounding box of chars/strings drawn with Font API.
Diffstat (limited to 'graphics/font.h')
-rw-r--r-- | graphics/font.h | 54 |
1 files changed, 52 insertions, 2 deletions
diff --git a/graphics/font.h b/graphics/font.h index f333107780..35f6792d7f 100644 --- a/graphics/font.h +++ b/graphics/font.h @@ -25,6 +25,7 @@ #include "common/str.h" #include "common/ustr.h" +#include "common/rect.h" namespace Common { template<class T> class Array; @@ -84,10 +85,51 @@ public: virtual int getKerningOffset(uint32 left, uint32 right) const; /** + * Calculate the bounding box of a character. It is assumed that + * the character shall be drawn at position (0, 0). + * + * The idea here is that the character might be drawn outside the + * rect (0, 0) to (getCharWidth(chr), getFontHeight()) for some fonts. + * This is common among TTF fonts. + * + * The default implementation simply returns the rect with a width + * of getCharWidth(chr) and height of getFontHeight(). + * + * @param chr The character to draw. + * @return The bounding box of the drawn glyph. + */ + virtual Common::Rect getBoundingBox(uint32 chr) const; + + /** + * Return the bounding box of a string drawn with drawString. + * + * @param x The x position where to start drawing + * @param y The y position where to start drawing + * @param w The width of the text area. This can be 0 to allow for + * obtaining the whole bounding box for a string. Note that this + * does not work with an align different from kTextAlignLeft or + * with useEllipsis. + * @param align The text alignment. This can be used to center a string + * in the given area or to align it to the right. + * @param delatx Offset to the x starting position of the string. + * @param useEllipsis Try to fit the string in the area by inserting an + * ellipsis. Be ware that the default is false for this + * one unlike for drawString! + * @return The actual area where the string is drawn. + */ + Common::Rect getBoundingBox(const Common::String &str, int x = 0, int y = 0, const int w = 0, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const; + Common::Rect getBoundingBox(const Common::U32String &str, int x = 0, int y = 0, const int w = 0, TextAlign align = kTextAlignLeft) const; + + /** * Draw a character at a specific point on a surface. * - * Note that the point describes the top left edge point of the - * character's bounding box. + * Note that the point describes the top left edge point where to draw + * the character. This can be different from top left edge point of the + * character's bounding box! For example, TTF fonts sometimes move + * characters like 't' one (or more) pixels to the left to create better + * visual results. To query the actual bounding box of a character use + * getBoundingBox. + * @see getBoundingBox * * The Font implemenation should take care of not drawing outside of the * specified surface. @@ -106,6 +148,11 @@ public: /** * Compute and return the width the string str has when rendered using this font. + * This describes the logical width of the string when drawn at (0, 0). + * This can be different from the actual bounding box of the string. Use + * getBoundingBox when you need the bounding box of a drawn string. + * @see getBoundingBox + * @see drawChar */ int getStringWidth(const Common::String &str) const; int getStringWidth(const Common::U32String &str) const; @@ -125,6 +172,9 @@ public: */ int wordWrapText(const Common::String &str, int maxWidth, Common::Array<Common::String> &lines) const; int wordWrapText(const Common::U32String &str, int maxWidth, Common::Array<Common::U32String> &lines) const; + +private: + Common::String handleEllipsis(const Common::String &str, int w) const; }; } // End of namespace Graphics |