1 #ifndef DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H
2 #define DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/common/dali-vector.h>
23 #include <dali/public-api/common/intrusive-ptr.h>
24 #include <dali/public-api/math/vector2.h>
25 #include <dali/public-api/math/vector4.h>
26 #include <dali/public-api/object/ref-object.h>
29 #include <dali-toolkit/internal/text/color-run.h>
30 #include <dali-toolkit/internal/text/line-run.h>
39 typedef IntrusivePtr<VisualModel> VisualModelPtr;
42 * @brief A visual text model contains layout specific information.
45 * - A series of glyphs in visual order i.e. after the bidirectional reordering.
46 * - The position of each glyph within a 2D bounding box.
48 class VisualModel : public RefObject
52 * @brief Create a new instance of a VisualModel.
54 * @return A pointer to a new VisualModel.
56 static VisualModelPtr New();
61 * @brief Creates the character to glyph conversion table.
63 * @pre The glyphs per character table needs to be created first.
65 * @param[in] startIndex The character from where the conversion table is created.
66 * @param[in] startGlyphIndex The glyph from where the conversion table is created.
67 * @param[in] numberOfCharacters The number of characters.
69 void CreateCharacterToGlyphTable(CharacterIndex startIndex,
70 GlyphIndex startGlyphIndex,
71 Length numberOfCharacters);
74 * @brief Creates an array containing the number of glyphs per character.
76 * @param[in] startIndex The character from where the table is created.
77 * @param[in] startGlyphIndex The glyph from where the conversion table is created.
78 * @param[in] numberOfCharacters The number of characters.
80 void CreateGlyphsPerCharacterTable(CharacterIndex startIndex,
81 GlyphIndex startGlyphIndex,
82 Length numberOfCharacters);
85 * @brief Retrieves glyphs in the given buffer.
87 * The size of the @p glyphs buffer needs to be big enough to copy the @p numberOfGlyphs.
88 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
89 * @param[in] glyphIndex Index to the first glyph.
90 * @param[in] numberOfGlyphs Number of glyphs to be copied.
92 void GetGlyphs(GlyphInfo* glyphs,
93 GlyphIndex glyphIndex,
94 Length numberOfGlyphs) const;
99 * @brief Retrieves the glyph positions.
101 * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions.
102 * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
103 * @param[in] glyphIndex Index to the first glyph position.
104 * @param[in] numberOfGlyphs The number of positions to be copied.
106 void GetGlyphPositions(Vector2* glyphPositions,
107 GlyphIndex glyphIndex,
108 Length numberOfGlyphs) const;
113 * @brief Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out.
115 * @param[in] glyphIndex Index to the first glyph.
116 * @param[in] numberOfGlyphs The number of glyph.
117 * @param[out] firstLine Index to the line containing the glyph index.
118 * @param[out] numberOfLines The number of lines.
120 void GetNumberOfLines(GlyphIndex glyphIndex,
121 Length numberOfGlyphs,
122 LineIndex& firstLine,
123 Length& numberOfLines) const;
126 * @brief Retrieves the lines where the given range of glyphs is laid out.
128 * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.
130 * @param[out] lines Pointer to a buffer where the lines are copied.
131 * @param[in] glyphIndex Index to the first glyphs of the range.
132 * @param[in] numberOfGlyphs Number of glyphs in the range.
134 void GetLinesOfGlyphRange(LineRun* lines,
135 GlyphIndex glyphIndex,
136 Length numberOfGlyphs) const;
139 * @brief Retrieves the line index where the character is laid-out.
141 * @param[in] characterIndex The character's index.
143 * @return The line index.
145 LineIndex GetLineOfCharacter(CharacterIndex characterIndex);
150 * @brief Retrieves the underline runs.
152 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
153 * @param[in] index Index of the first underline run to be copied.
154 * @param[in] numberOfRuns Number of underline runs to be copied.
156 void GetUnderlineRuns(GlyphRun* underlineRuns,
157 UnderlineRunIndex index,
158 Length numberOfRuns) const;
163 * @brief Sets the natural size.
165 * @param[in] size The text's natural size.
167 void SetNaturalSize(const Vector2& size);
170 * @brief Retrieves the natural size.
172 * @return The text's natural size.
174 const Vector2& GetNaturalSize() const;
177 * @brief Sets the text's layout size.
179 * @param[in] size The text's size.
181 void SetLayoutSize(const Vector2& size);
184 * @brief Retrieves the text's layout size.
186 * @return The text's size.
188 const Vector2& GetLayoutSize() const;
191 * @brief Set the text's color
193 * @param[in] textColor The text's color
195 void SetTextColor(const Vector4& textColor);
198 * @brief Retrieve the text's color
200 * @return The text's color
202 const Vector4& GetTextColor() const;
205 * @brief Sets the text's shadow offset.
207 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
209 void SetShadowOffset(const Vector2& shadowOffset);
212 * @brief Retrieves the text's shadow offset.
214 * @return The text's shadow offset, 0,0 indicates no shadow.
216 const Vector2& GetShadowOffset() const;
219 * @brief Sets the text's shadow color.
221 * @param[in] shadowColor The shadow color.
223 void SetShadowColor(const Vector4& shadowColor);
226 * @brief Retrieves the text's shadow color.
228 * @return The text's shadow color.
230 const Vector4& GetShadowColor() const;
233 * @brief Set the shadow blur radius.
235 * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur.
237 void SetShadowBlurRadius(const float& shadowBlurRadius);
240 * @brief Retrieve the shadow blur radius.
242 * @return The shadow blur radius.
244 const float& GetShadowBlurRadius() const;
247 * @brief Sets the text's underline color.
249 * @param[in] color The text's underline color.
251 void SetUnderlineColor(const Vector4& color);
254 * @brief Retrieves the text's underline color.
256 * @return The text's underline color.
258 const Vector4& GetUnderlineColor() const;
261 * @brief Sets the text underline flag.
263 * @param[in] enabled true if underlined.
265 void SetUnderlineEnabled(bool enabled);
268 * @brief Returns whether the text is underlined or not.
270 * @return underline state.
272 bool IsUnderlineEnabled() const;
275 * @brief Clear the caches.
280 * @brief Set the override used for underline height, 0 indicates height will be come from font metrics
282 * @param[in] height The height in pixels of the underline
284 void SetUnderlineHeight(float height);
287 * @brief Retrieves the underline height override
289 * @return Returns the override height for an underline, 0 indicates that font metrics will determine the height
291 float GetUnderlineHeight() const;
294 * @brief Retrieves the number of underline runs.
296 * @return The number of underline runs.
298 Length GetNumberOfUnderlineRuns() const;
301 * @brief Set the outline color.
303 * @param[in] color color of outline.
305 void SetOutlineColor(const Vector4& color);
308 * @brief Retrieve the outline color.
310 * @return The outline color.
312 const Vector4& GetOutlineColor() const;
315 * @brief Set the outline width
317 * @param[in] width The width in pixels of the outline, 0 indicates no outline
319 void SetOutlineWidth(uint16_t width);
322 * @brief Retrieves the width of an outline
324 * @return The width of the outline.
326 uint16_t GetOutlineWidth() const;
329 * @brief Sets the text's background color.
331 * @param[in] color The text's background color.
333 void SetBackgroundColor(const Vector4& color);
336 * @brief Retrieves the text's background color.
338 * @return The text's background color.
340 const Vector4& GetBackgroundColor() const;
343 * @brief Sets whether the text has a background or not.
345 * @param[in] enabled true if the text has a background.
347 void SetBackgroundEnabled(bool enabled);
350 * @brief Returns whether the text has a background or not.
352 * @return whether the text has a background or not.
354 bool IsBackgroundEnabled() const;
358 * @brief A reference counted object may only be deleted by calling Unreference().
360 virtual ~VisualModel();
364 * @brief Private constructor.
369 VisualModel(const VisualModel& handle);
372 VisualModel& operator=(const VisualModel& handle);
375 Vector<GlyphInfo> mGlyphs; ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
376 Vector<CharacterIndex> mGlyphsToCharacters; ///< For each glyph, the index of the first character.
377 Vector<GlyphIndex> mCharactersToGlyph; ///< For each character, the index of the first glyph.
378 Vector<Length> mCharactersPerGlyph; ///< For each glyph, the number of characters that form the glyph.
379 Vector<Length> mGlyphsPerCharacter; ///< For each character, the number of glyphs that are shaped.
380 Vector<Vector2> mGlyphPositions; ///< For each glyph, the position.
381 Vector<LineRun> mLines; ///< The laid out lines.
382 Vector<GlyphRun> mUnderlineRuns; ///< Runs of glyphs that are underlined.
383 Vector<Vector4> mColors; ///< Colors of the glyphs.
384 Vector<ColorIndex> mColorIndices; ///< Indices to the vector of colors for each glyphs.
385 Vector<Vector4> mBackgroundColors; ///< Background colors of the glyphs.
386 Vector<ColorIndex> mBackgroundColorIndices; ///< Indices to the vector of background colors for each glyphs.
388 Vector4 mTextColor; ///< The text color
389 Vector4 mShadowColor; ///< Color of drop shadow
390 Vector4 mUnderlineColor; ///< Color of underline
391 Vector4 mOutlineColor; ///< Color of outline
392 Vector4 mBackgroundColor; ///< Color of text background
393 Size mControlSize; ///< The size of the UI control.
394 Vector2 mShadowOffset; ///< Offset for drop shadow, 0 indicates no shadow
395 float mUnderlineHeight; ///< Fixed height for underline to override font metrics.
396 float mShadowBlurRadius; ///< Blur radius of shadow, 0 indicates no blur.
397 uint16_t mOutlineWidth; ///< Width of outline.
400 Size mNaturalSize; ///< Size of the text with no line wrapping.
401 Size mLayoutSize; ///< Size of the laid-out text considering the layout properties set.
403 // Caches to increase performance in some consecutive operations.
404 LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.
407 bool mUnderlineEnabled : 1; ///< Underline enabled flag
408 bool mUnderlineColorSet : 1; ///< Has the underline color been explicitly set?
409 bool mBackgroundEnabled : 1; ///< Background enabled flag
414 } // namespace Toolkit
418 #endif // DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H