Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor|UI|Client: Added TextDrawable; used now in DocumentWidget
TextDrawable is a higher-level text drawing class that makes it easy to control the whole process. It is also asynchronous: a background thread is used to wrap the content.
- Loading branch information
Showing
5 changed files
with
326 additions
and
96 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /** @file textdrawable.h High-level GL text drawing utility. | ||
| * | ||
| * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi> | ||
| * | ||
| * @par License | ||
| * GPL: http://www.gnu.org/licenses/gpl.html | ||
| * | ||
| * <small>This program is free software; you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by the | ||
| * Free Software Foundation; either version 2 of the License, or (at your | ||
| * option) any later version. This program is distributed in the hope that it | ||
| * will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty | ||
| * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | ||
| * Public License for more details. You should have received a copy of the GNU | ||
| * General Public License along with this program; if not, see: | ||
| * http://www.gnu.org/licenses</small> | ||
| */ | ||
|
|
||
| #ifndef DENG_CLIENT_TEXTDRAWABLE_H | ||
| #define DENG_CLIENT_TEXTDRAWABLE_H | ||
|
|
||
| #include "gltextcomposer.h" | ||
| #include "fontlinewrapping.h" | ||
|
|
||
| /** | ||
| * High-level GL text drawing utility. | ||
| * | ||
| * The task of drawing text is rather complicated. There are several components | ||
| * involved: | ||
| * | ||
| * - de::EscapeParser parses style escape codes. | ||
| * - de::Font understands rich text formatting and performs the actual | ||
| * rasterizing of text onto bitmap images. | ||
| * - FontLineWrapping takes rich-formatted ("styled") text and wraps it onto | ||
| * multiple lines, taking into account tab stops and indentation. | ||
| * - GLTextComposer allocates the text lines from an Atlas and generates the | ||
| * triangle strips needed for actually drawing the text on the screen. | ||
| * | ||
| * TextDrawable is a high-level utility for controlling this entire process as | ||
| * easily as possible. If fine-grained control of the text is required, one can | ||
| * still use the lower level components directly. | ||
| * | ||
| * TextDrawable handles wrapping of text using a background thread, so content | ||
| * length is unlimited and the calling thread will not block. TextDrawable is | ||
| * an Asset, and will not be marked ready until the background wrapping is | ||
| * done. One is still required to call TextDrawable::update() before drawing, | ||
| * though. | ||
| */ | ||
| class TextDrawable : public GLTextComposer | ||
| { | ||
| public: | ||
| TextDrawable(); | ||
|
|
||
| void init(de::Atlas &atlas, de::Font const &font, | ||
| de::Font::RichFormat::IStyle const *style = 0); | ||
|
|
||
| void deinit(); | ||
|
|
||
| /** | ||
| * Sets the maximum width for text lines. | ||
| * | ||
| * @param maxWidth Maximum line width. | ||
| */ | ||
| void setLineWrapWidth(int maxLineWidth); | ||
|
|
||
| void setText(de::String const &styledText); | ||
|
|
||
| void setFont(de::Font const &font); | ||
|
|
||
| /** | ||
| * Sets the range of visible lines and releases all allocations outside | ||
| * the range. | ||
| * | ||
| * @param lineRange Range of visible lines. | ||
| */ | ||
| void setRange(de::Rangei const &lineRange); | ||
|
|
||
| /** | ||
| * Updates the status of the composer. This includes first checking if a | ||
| * background wrapping task has been completed. | ||
| * | ||
| * @return @c true, if the lines have changed and it is necessary to remake | ||
| * the geometry. @c false, if nothing further needs to be done. | ||
| */ | ||
| bool update(); | ||
|
|
||
| FontLineWrapping const &wraps() const; | ||
|
|
||
| de::Vector2i wrappedSize() const; | ||
| de::String text() const; | ||
| de::String plainText() const; | ||
| bool isBeingWrapped() const; | ||
|
|
||
| private: | ||
| DENG2_PRIVATE(d) | ||
| }; | ||
|
|
||
| #endif // DENG_CLIENT_TEXTDRAWABLE_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.