1 #ifndef DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H
2 #define DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H
5 * Copyright (c) 2022 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/character-spacing-glyph-run.h>
30 #include <dali-toolkit/internal/text/color-run.h>
31 #include <dali-toolkit/internal/text/line-run.h>
32 #include <dali-toolkit/internal/text/strikethrough-glyph-run.h>
33 #include <dali-toolkit/internal/text/underlined-glyph-run.h>
34 #include <dali-toolkit/public-api/text/text-enumerations.h>
37 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
47 Vector<GlyphInfo> glyph;
48 Vector<Vector2> position;
53 typedef IntrusivePtr<VisualModel> VisualModelPtr;
56 * @brief A visual text model contains layout specific information.
59 * - A series of glyphs in visual order i.e. after the bidirectional reordering.
60 * - The position of each glyph within a 2D bounding box.
62 class VisualModel : public RefObject
66 * @brief Create a new instance of a VisualModel.
68 * @return A pointer to a new VisualModel.
70 static VisualModelPtr New();
75 * @brief Creates the character to glyph conversion table.
77 * @pre The glyphs per character table needs to be created first.
79 * @param[in] startIndex The character from where the conversion table is created.
80 * @param[in] startGlyphIndex The glyph from where the conversion table is created.
81 * @param[in] numberOfCharacters The number of characters.
83 void CreateCharacterToGlyphTable(CharacterIndex startIndex,
84 GlyphIndex startGlyphIndex,
85 Length numberOfCharacters);
88 * @brief Creates an array containing the number of glyphs per character.
90 * @param[in] startIndex The character from where the table is created.
91 * @param[in] startGlyphIndex The glyph from where the conversion table is created.
92 * @param[in] numberOfCharacters The number of characters.
94 void CreateGlyphsPerCharacterTable(CharacterIndex startIndex,
95 GlyphIndex startGlyphIndex,
96 Length numberOfCharacters);
99 * @brief Retrieves glyphs in the given buffer.
101 * The size of the @p glyphs buffer needs to be big enough to copy the @p numberOfGlyphs.
102 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
103 * @param[in] glyphIndex Index to the first glyph.
104 * @param[in] numberOfGlyphs Number of glyphs to be copied.
106 void GetGlyphs(GlyphInfo* glyphs,
107 GlyphIndex glyphIndex,
108 Length numberOfGlyphs) const;
110 // Position interface
113 * @brief Retrieves the glyph positions.
115 * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions.
116 * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
117 * @param[in] glyphIndex Index to the first glyph position.
118 * @param[in] numberOfGlyphs The number of positions to be copied.
120 void GetGlyphPositions(Vector2* glyphPositions,
121 GlyphIndex glyphIndex,
122 Length numberOfGlyphs) const;
127 * @brief Retrieves the total number of lines.
129 * @return The number of lines.
131 Length GetTotalNumberOfLines() const;
134 * @brief Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out.
136 * @param[in] glyphIndex Index to the first glyph.
137 * @param[in] numberOfGlyphs The number of glyph.
138 * @param[out] firstLine Index to the line containing the glyph index.
139 * @param[out] numberOfLines The number of lines.
141 void GetNumberOfLines(GlyphIndex glyphIndex,
142 Length numberOfGlyphs,
143 LineIndex& firstLine,
144 Length& numberOfLines) const;
147 * @brief Retrieves the line index where the glyph is laid-out.
149 * @param[in] glyphIndex The glyph's index.
151 * @return The line index.
153 LineIndex GetLineOfGlyph(GlyphIndex glyphIndex);
156 * @brief Retrieves the lines where the given range of glyphs is laid out.
158 * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.
160 * @param[out] lines Pointer to a buffer where the lines are copied.
161 * @param[in] glyphIndex Index to the first glyphs of the range.
162 * @param[in] numberOfGlyphs Number of glyphs in the range.
164 void GetLinesOfGlyphRange(LineRun* lines,
165 GlyphIndex glyphIndex,
166 Length numberOfGlyphs) const;
169 * @brief Retrieves the line index where the character is laid-out.
171 * @param[in] characterIndex The character's index.
173 * @return The line index.
175 LineIndex GetLineOfCharacter(CharacterIndex characterIndex);
180 * @brief Retrieves the underline runs.
182 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
183 * @param[in] index Index of the first underline run to be copied.
184 * @param[in] numberOfRuns Number of underline runs to be copied.
186 void GetUnderlineRuns(UnderlinedGlyphRun* underlineRuns,
187 UnderlineRunIndex index,
188 Length numberOfRuns) const;
193 * @brief Sets the natural size.
195 * @param[in] size The text's natural size.
197 void SetNaturalSize(const Vector2& size);
200 * @brief Retrieves the natural size.
202 * @return The text's natural size.
204 const Vector2& GetNaturalSize() const;
207 * @brief Sets the text's layout size.
209 * @param[in] size The text's size.
211 void SetLayoutSize(const Vector2& size);
214 * @brief Retrieves the text's layout size.
216 * @return The text's size.
218 const Vector2& GetLayoutSize() const;
221 * @brief Sets the size of height for width.
223 * @param[in] size The text's height for width size.
225 void SetHeightForWidth(const Vector2& size);
228 * @brief Retrieves the height for width size.
230 * @return The text's height for width size.
232 const Vector2& GetHeightForWidth() const;
235 * @brief Set the text's color
237 * @param[in] textColor The text's color
239 void SetTextColor(const Vector4& textColor);
242 * @brief Retrieve the text's color
244 * @return The text's color
246 const Vector4& GetTextColor() const;
249 * @brief Sets the text's shadow offset.
251 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
253 void SetShadowOffset(const Vector2& shadowOffset);
256 * @brief Retrieves the text's shadow offset.
258 * @return The text's shadow offset, 0,0 indicates no shadow.
260 const Vector2& GetShadowOffset() const;
263 * @brief Sets the text's shadow color.
265 * @param[in] shadowColor The shadow color.
267 void SetShadowColor(const Vector4& shadowColor);
270 * @brief Retrieves the text's shadow color.
272 * @return The text's shadow color.
274 const Vector4& GetShadowColor() const;
277 * @brief Set the shadow blur radius.
279 * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur.
281 void SetShadowBlurRadius(const float& shadowBlurRadius);
284 * @brief Retrieve the shadow blur radius.
286 * @return The shadow blur radius.
288 const float& GetShadowBlurRadius() const;
291 * @brief Sets the text's underline color.
293 * @param[in] color The text's underline color.
295 void SetUnderlineColor(const Vector4& color);
298 * @brief Retrieves the text's underline color.
300 * @return The text's underline color.
302 const Vector4& GetUnderlineColor() const;
305 * @brief Sets the text underline flag.
307 * @param[in] enabled true if underlined.
309 void SetUnderlineEnabled(bool enabled);
312 * @brief Returns whether the text is underlined or not.
314 * @return underline state.
316 bool IsUnderlineEnabled() const;
319 * @brief Clear the caches.
324 * @brief Set the override used for underline height, 0 indicates height will be come from font metrics
326 * @param[in] height The height in pixels of the underline
328 void SetUnderlineHeight(float height);
331 * @brief Set the override used for underline type.
333 * @param[in] underlineType The type of the underline.
335 void SetUnderlineType(Text::Underline::Type type);
338 * @brief Set the override used for the width of the dashes of the dashed underline.
340 * @param[in] width width of the dashes.
342 void SetDashedUnderlineWidth(float width);
345 * @brief Set the override used for the gap between the dashes of the dashed underline.
347 * @param[in] gap gap between the dashes.
349 void SetDashedUnderlineGap(float gap);
352 * @brief Retrieves the underline height override
354 * @return Returns the override height for an underline, 0 indicates that font metrics will determine the height
356 float GetUnderlineHeight() const;
359 * @brief Retrieves the underline type override.
361 * @return Returns the override type for the underline.
363 Text::Underline::Type GetUnderlineType() const;
366 * @brief Retrieves the dashed underline width.
368 * @return Returns the override width for the dashed underline.
370 float GetDashedUnderlineWidth() const;
373 * @brief Retrieves the dashed underline gap.
375 * @return Returns the override gap for the dashed underline.
377 float GetDashedUnderlineGap() const;
380 * @brief Retrieves the number of underline runs.
382 * @return The number of underline runs.
384 Length GetNumberOfUnderlineRuns() const;
387 * @brief Sets the text's outline offset.
389 * @param[in] outlineOffset The outline offset.
391 void SetOutlineOffset(const Vector2& outlineOffset);
394 * @brief Set the outline color.
396 * @param[in] color color of outline.
398 void SetOutlineColor(const Vector4& color);
401 * @brief Retrieves the text's outline offset.
403 * @return The text's outline offset.
405 const Vector2& GetOutlineOffset() const;
408 * @brief Retrieve the outline color.
410 * @return The outline color.
412 const Vector4& GetOutlineColor() const;
415 * @brief Set the outline width
417 * @param[in] width The width in pixels of the outline, 0 indicates no outline
419 void SetOutlineWidth(uint16_t width);
422 * @brief Retrieves the width of an outline
424 * @return The width of the outline.
426 uint16_t GetOutlineWidth() const;
429 * @brief Set the outline blur radius.
431 * @param[in] outlineBlurRadius The outline blur radius, 0,0 indicates no blur.
433 void SetOutlineBlurRadius(const float& outlineBlurRadius);
436 * @brief Retrieve the outline blur radius.
438 * @return The outline blur radius.
440 const float& GetOutlineBlurRadius() const;
443 * @brief Sets the text's background color.
445 * @param[in] color The text's background color.
447 void SetBackgroundColor(const Vector4& color);
450 * @brief Retrieves the text's background color.
452 * @return The text's background color.
454 const Vector4& GetBackgroundColor() const;
457 * @brief Sets whether the text has a background or not.
459 * @param[in] enabled true if the text has a background.
461 void SetBackgroundEnabled(bool enabled);
464 * @brief Returns whether the text has a background or not.
466 * @return whether the text has a background or not.
468 bool IsBackgroundEnabled() const;
471 * @brief Sets whether the text has a markup-processor or not.
473 * @param[in] enabled true if the text has a markup-processor.
475 void SetMarkupProcessorEnabled(bool enabled);
478 * @brief Returns whether the text has a markup-processor or not.
480 * @return whether the text has a markup-processor or not.
482 bool IsMarkupProcessorEnabled() const;
485 * @brief Sets ellipsis position
486 * @param[in] ellipsisPosition The ellipsis position for the text
488 void SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition);
491 * @brief Retrieves ellipsis position for text.
493 * @return The ellipsis position.
495 Toolkit::DevelText::EllipsisPosition::Type GetEllipsisPosition() const;
498 * @brief Enable or disable the text elide.
500 * @param[in] enabled Whether to enable the text elide.
502 void SetTextElideEnabled(bool enabled);
505 * @brief Whether the text elide property is enabled.
507 * @return @e true if the text elide property is enabled, @e false otherwise.
509 bool IsTextElideEnabled() const;
512 * @brief Sets the start index of laid-out glyphs.
514 * @param[in] startIndexOfElidedGlyphs The start index of laid-out glyphs.
516 void SetStartIndexOfElidedGlyphs(GlyphIndex startIndexOfElidedGlyphs);
519 * @brief Sets the end index of elided glyphs.
521 * @param[in] endIndexOfElidedGlyphs The end index of elided glyphs.
523 void SetEndIndexOfElidedGlyphs(GlyphIndex endIndexOfElidedGlyphs);
526 * @brief Sets the first middle index of elided glyphs, index before ellipsis of middle.
528 * @param[in] firstMiddleIndexOfElidedGlyphs The first middle index of elided glyphs, index before ellipsis of middle.
530 void SetFirstMiddleIndexOfElidedGlyphs(GlyphIndex firstMiddleIndexOfElidedGlyphs);
533 * @brief Sets the second middle index of elided glyphs, index of ellipsis of middle.
535 * @param[in] secondMiddleIndexOfElidedGlyphs The second middle index of elided glyphs, index of ellipsis of middle.
537 void SetSecondMiddleIndexOfElidedGlyphs(GlyphIndex secondMiddleIndexOfElidedGlyphs);
540 * @brief Retrieves the start index of laid-out glyphs.
542 * @return The start index of laid-out glyphs.
544 GlyphIndex GetStartIndexOfElidedGlyphs() const;
547 * @brief Retrieves the end index of laid-out glyphs.
549 * @return The end index of laid-out glyphs.
551 GlyphIndex GetEndIndexOfElidedGlyphs() const;
554 * @brief Retrieves the first middle index of elided glyphs, index before ellipsis of middle.
556 * @return The first middle index of elided glyphs, index before ellipsis of middle.
558 GlyphIndex GetFirstMiddleIndexOfElidedGlyphs() const;
561 * @brief Retrieves the second middle index of elided glyphs, index of ellipsis of middle.
563 * @return The second middle index of elided glyphs, index of ellipsis of middle.
565 GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() const;
568 * @brief Sets the text's strikethrough color.
570 * @param[in] color The text's strikethrough color.
572 void SetStrikethroughColor(const Vector4& color);
575 * @brief Retrieves the text's strikethrough color.
577 * @return The text's strikethrough color.
579 const Vector4& GetStrikethroughColor() const;
582 * @brief Sets the text strikethrough flag.
584 * @param[in] enabled true if strikethrough.
586 void SetStrikethroughEnabled(bool enabled);
589 * @brief Returns whether the text is strikethrough or not.
591 * @return strikethrough state.
593 bool IsStrikethroughEnabled() const;
596 * @brief Set the override used for strikethrough height, 0 indicates height will be come from font metrics
598 * @param[in] height The height in pixels of the strikethrough
600 void SetStrikethroughHeight(float height);
603 * @brief Retrieves the strikethrough height override
605 * @return Returns the override height for a strikethrough, 0 indicates that font metrics will determine the height
607 float GetStrikethroughHeight() const;
609 * @brief Set the override used for character spacing.
611 * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
613 * @param[in] characterSpacing The character spacing.
615 void SetCharacterSpacing(float characterSpacing);
618 * @brief Retrieves the characterSpacing.
620 * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
622 * @return Returns the characterSpacing.
624 const float GetCharacterSpacing() const;
627 * @brief Retrieves the Glyphs to Characters Array.
629 * @return The GlyphsToCharacters.
631 const Vector<CharacterIndex>& GetGlyphsToCharacters() const;
634 * @brief Retrieves the strikethrough runs.
636 * @param[out] strikethroughRuns Pointer to a buffer where the strikethrough runs are copied.
637 * @param[in] index Index of the first strikethrough run to be copied.
638 * @param[in] numberOfRuns Number of strikethrough runs to be copied.
640 void GetStrikethroughRuns(StrikethroughGlyphRun* strikethroughRuns,
641 StrikethroughRunIndex index,
642 Length numberOfRuns) const;
645 * @brief Retrieves the number of strikethrough runs.
647 * @return The number of strikethrough runs.
649 Length GetNumberOfStrikethroughRuns() const;
652 * @brief Retrieves the number of character-spacing glyph runs.
654 * @return The number of character-spacing glyph runs.
656 Length GetNumberOfCharacterSpacingGlyphRuns() const;
659 * @brief Retrieves the reference for character-spacing glyph runs.
661 * @return The reference for character-spacing glyph runs.
663 const Vector<CharacterSpacingGlyphRun>& GetCharacterSpacingGlyphRuns() const;
666 * @brief Sets the cutout flag.
668 * @param[in] enable true if cutouted.
670 void SetCutoutEnabled(bool enable);
673 * @brief Returns whether the text is cutouted or not.
675 * @return cutout state.
677 bool IsCutoutEnabled() const;
680 * @brief Sets the background with cutout flag.
682 * @param[in] enable true if background enabled.
684 void SetBackgroundWithCutoutEnabled(bool enable);
687 * @brief Returns whether the text is cutouted or not.
689 * @return True if enabled.
691 bool IsBackgroundWithCutoutEnabled() const;
694 * @brief Sets the Color of background with cutout.
696 * @param[in] color The color to set.
698 void SetBackgroundColorWithCutout(const Vector4& color);
701 * @brief Retrieves the Color of background with cutout.
705 const Vector4& GetBackgroundColorWithCutout() const;
708 * @brief Sets the left and top offset with cutout.
710 * @param[in] offset The offset to set.
712 void SetOffsetWithCutout(const Vector2& offset);
715 * @brief Retrieves the left and top offset with cutout.
717 * @return The offset.
719 const Vector2& GetOffsetWithCutout() const;
723 * @brief A reference counted object may only be deleted by calling Unreference().
725 virtual ~VisualModel();
729 * @brief Private constructor.
734 VisualModel(const VisualModel& handle);
737 VisualModel& operator=(const VisualModel& handle);
740 Vector<GlyphInfo> mGlyphs; ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
741 Vector<CharacterIndex> mGlyphsToCharacters; ///< For each glyph, the index of the first character.
742 Vector<GlyphIndex> mCharactersToGlyph; ///< For each character, the index of the first glyph.
743 Vector<Length> mCharactersPerGlyph; ///< For each glyph, the number of characters that form the glyph.
744 Vector<Length> mGlyphsPerCharacter; ///< For each character, the number of glyphs that are shaped.
745 Vector<Vector2> mGlyphPositions; ///< For each glyph, the position.
746 Vector<LineRun> mLines; ///< The laid out lines.
747 Vector<UnderlinedGlyphRun> mUnderlineRuns; ///< Runs of glyphs that are underlined.
748 Vector<Vector4> mColors; ///< Colors of the glyphs.
749 Vector<ColorIndex> mColorIndices; ///< Indices to the vector of colors for each glyphs.
750 Vector<Vector4> mBackgroundColors; ///< Background colors of the glyphs.
751 Vector<ColorIndex> mBackgroundColorIndices; ///< Indices to the vector of background colors for each glyphs.
752 Vector4 mTextColor; ///< The text color
753 Vector4 mShadowColor; ///< Color of drop shadow
754 Vector4 mUnderlineColor; ///< Color of underline
755 Vector4 mOutlineColor; ///< Color of outline
756 Vector4 mBackgroundColor; ///< Color of text background
757 Vector4 mStrikethroughColor; ///< Color of text background
758 Size mControlSize; ///< The size of the UI control.
759 Vector2 mShadowOffset; ///< Offset for drop shadow, 0 indicates no shadow
760 Vector2 mOutlineOffset; ///< Offset for outline
761 float mUnderlineHeight; ///< Fixed height for underline to override font metrics.
762 float mStrikethroughHeight; ///< Fixed height for strikethrough to override font metrics.
763 Text::Underline::Type mUnderlineType; ///< The type of the underline.
764 float mDashedUnderlineWidth; ///< The width of the dashes of the dashed underline.
765 float mDashedUnderlineGap; ///< The gap between the dashes of the dashed underline.
766 float mShadowBlurRadius; ///< Blur radius of shadow, 0 indicates no blur.
767 float mOutlineBlurRadius; ///< Blur radius of outline, 0 indicates no blur.
768 uint16_t mOutlineWidth; ///< Width of outline.
769 Vector<StrikethroughGlyphRun> mStrikethroughRuns; ///< Runs of glyphs that have strikethrough.
770 Vector<CharacterSpacingGlyphRun> mCharacterSpacingRuns; ///< Runs of glyphs that have character-spacing.
771 Vector4 mBackgroundColorWithCutout; ///< Background color with cutout.
772 Vector2 mOffsetWithCutout; ///< Left and top offset when cutout.
775 Size mNaturalSize; ///< Size of the text with no line wrapping.
776 Size mLayoutSize; ///< Size of the laid-out text considering the layout properties set.
777 Size mHeightForWidth; ///< Size of the text last calculated using GetHeightForWidth.
779 // Caches to increase performance in some consecutive operations.
780 LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.
782 DevelText::EllipsisPosition::Type mEllipsisPosition; ///< Where is the location the text elide
783 GlyphIndex mStartIndexOfElidedGlyphs; ///< The start index of elided glyphs.
784 GlyphIndex mEndIndexOfElidedGlyphs; ///< The end index of elided glyphs.
785 GlyphIndex mFirstMiddleIndexOfElidedGlyphs; ///< The first end index of elided glyphs, index before ellipsis of middle.
786 GlyphIndex mSecondMiddleIndexOfElidedGlyphs; ///< The first end index of elided glyphs, index of ellipsis of middle.
787 bool mTextElideEnabled : 1; ///< Whether the text's elide is enabled.
790 bool mUnderlineEnabled : 1; ///< Underline enabled flag
791 bool mUnderlineColorSet : 1; ///< Has the underline color been explicitly set?
792 bool mBackgroundEnabled : 1; ///< Background enabled flag
793 bool mMarkupProcessorEnabled : 1; ///< Markup-processor enabled flag
794 HyphenInfo mHyphen; ///< Contains hyphen glyph info & the character index to draw hyphen after.
795 bool mStrikethroughEnabled : 1; ///< Strikethrough enabled flag
796 float mCharacterSpacing; ///< Contains the value of the character spacing.
797 bool mCutoutEnabled : 1; ///< Cutout enabled flag
798 bool mBackgroundWithCutoutEnabled : 1; ///< Background with cutout enabled flag.
803 } // namespace Toolkit
807 #endif // DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H