1 #ifndef __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__
2 #define __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__
5 * Copyright (c) 2015 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/line-run.h>
41 typedef IntrusivePtr<VisualModel> VisualModelPtr;
44 * @brief A visual text model contains layout specific information.
47 * - A series of glyphs in visual order i.e. after the bidirectional reordering.
48 * - The position of each glyph within a 2D bounding box.
50 class VisualModel : public RefObject
55 * @brief Create a new instance of a VisualModel.
57 * @return A pointer to a new VisualModel.
59 static VisualModelPtr New();
64 * @brief Creates the character to glyph conversion table.
66 * @pre The glyphs per character table needs to be created first.
68 * @param[in] numberOfCharacters The number of characters.
70 void CreateCharacterToGlyphTable( Length numberOfCharacters = 0u );
73 * @brief Creates an array containing the number of glyphs per character.
75 * @param[in] numberOfCharacters The number of characters.
77 void CreateGlyphsPerCharacterTable( Length numberOfCharacters = 0u );
80 * @brief Retrieves glyphs in the given buffer.
82 * The size of the @p glyphs buffer needs to be big enough to copy the @p numberOfGlyphs.
83 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
84 * @param[in] glyphIndex Index to the first glyph.
85 * @param[in] numberOfGlyphs Number of glyphs to be copied.
87 void GetGlyphs( GlyphInfo* glyphs,
88 GlyphIndex glyphIndex,
89 Length numberOfGlyphs ) const;
91 // Character <--> Glyph conversion
94 * @brief Retrieves for each character the number of glyphs the character is shaped.
96 * @param[out] glyphsPerCharacter Pointer to a buffer where the number of glyphs for each character are copied.
97 * @param[in] characterIndex Index to the first character.
98 * @param[in] numberOfCharacters The number of characters.
100 void GetGlyphsPerCharacterMap( Length* glyphsPerCharacter,
101 CharacterIndex characterIndex,
102 Length numberOfCharacters ) const;
104 // Position interface
107 * @brief Retrieves the glyph positions.
109 * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions.
110 * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
111 * @param[in] glyphIndex Index to the first glyph position.
112 * @param[in] numberOfGlyphs The number of positions to be copied.
114 void GetGlyphPositions( Vector2* glyphPositions,
115 GlyphIndex glyphIndex,
116 Length numberOfGlyphs ) const;
121 * @brief Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out.
123 * @param[in] glyphIndex Index to the first glyph.
124 * @param[in] numberOfGlyphs The number of glyph.
125 * @param[out] firstLine Index to the line containing the glyph index.
126 * @param[out] numberOfLines The number of lines.
128 void GetNumberOfLines( GlyphIndex glyphIndex,
129 Length numberOfGlyphs,
130 LineIndex& firstLine,
131 Length& numberOfLines ) const;
134 * @brief Retrieves the lines where the given range of glyphs is laid out.
136 * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.
138 * @param[out] lines Pointer to a buffer where the lines are copied.
139 * @param[in] glyphIndex Index to the first glyphs of the range.
140 * @param[in] numberOfGlyphs Number of glyphs in the range.
142 void GetLinesOfGlyphRange( LineRun* lines,
143 GlyphIndex glyphIndex,
144 Length numberOfGlyphs ) const;
147 * @brief Retrieves the line index where the character is laid-out.
149 * @param[in] characterIndex The character's index.
151 * @return The line index.
153 LineIndex GetLineOfCharacter( CharacterIndex characterIndex );
158 * @brief Retrieves the underline runs.
160 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
161 * @param[in] index Index of the first underline run to be copied.
162 * @param[in] numberOfRuns Number of underline runs to be copied.
164 void GetUnderlineRuns( GlyphRun* underlineRuns,
165 UnderlineRunIndex index,
166 Length numberOfRuns ) const;
171 * @brief Sets the natural size.
173 * @param[in] size The text's natural size.
175 void SetNaturalSize( const Vector2& size );
178 * @brief Retrieves the natural size.
180 * @return The text's natural size.
182 const Vector2& GetNaturalSize() const;
185 * @brief Sets the text's actual size after it has been laid out.
187 * @param[in] size The text's size.
189 void SetActualSize( const Vector2& size );
192 * @brief Retrieves the text's actual size after it has been laid out.
194 * @return The text's size.
196 const Vector2& GetActualSize() const;
199 * @brief Set the text's color
201 * @param[in] textColor The text's color
203 void SetTextColor( const Vector4& textColor );
206 * @brief Retrieve the text's color
208 * @return The text's color
210 const Vector4& GetTextColor() const;
213 * @brief Sets the text's shadow offset.
215 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
217 void SetShadowOffset( const Vector2& shadowOffset );
220 * @brief Retrieves the text's shadow offset.
222 * @return The text's shadow offset, 0,0 indicates no shadow.
224 const Vector2& GetShadowOffset() const;
227 * @brief Sets the text's shadow color.
229 * @param[in] shadowColor The shadow color.
231 void SetShadowColor( const Vector4& shadowColor );
234 * @brief Retrieves the text's shadow color.
236 * @return The text's shadow color.
238 const Vector4& GetShadowColor() const;
241 * @brief Sets the text's underline color.
243 * @param[in] color The text's underline color.
245 void SetUnderlineColor( const Vector4& color );
248 * @brief Retrieves the text's underline color.
250 * @return The text's underline color.
252 const Vector4& GetUnderlineColor() const;
255 * @brief Sets the text underline flag.
257 * @param[in] enabled true if underlined.
259 void SetUnderlineEnabled( bool enabled );
262 * @brief Returns whether the text is underlined or not.
264 * @return underline state.
266 bool IsUnderlineEnabled() const;
269 * @brief Clear the caches.
274 * @brief Set the override used for underline height, 0 indicates height will be come from font metrics
276 * @param[in] height The height in pixels of the underline
278 void SetUnderlineHeight( float height );
281 * @brief Retrieves the underline height override
283 * @return Returns the override height for an underline, 0 indicates that font metrics will determine the height
285 float GetUnderlineHeight() const;
290 * @brief A reference counted object may only be deleted by calling Unreference().
292 virtual ~VisualModel();
297 * @brief Private constructor.
302 VisualModel( const VisualModel& handle );
305 VisualModel& operator=( const VisualModel& handle );
309 Vector<GlyphInfo> mGlyphs; ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
310 Vector<CharacterIndex> mGlyphsToCharacters; ///< For each glyph, the index of the first character.
311 Vector<GlyphIndex> mCharactersToGlyph; ///< For each character, the index of the first glyph.
312 Vector<Length> mCharactersPerGlyph; ///< For each glyph, the number of characters that form the glyph.
313 Vector<Length> mGlyphsPerCharacter; ///< For each character, the number of glyphs that are shaped.
314 Vector<Vector2> mGlyphPositions; ///< For each glyph, the position.
315 Vector<LineRun> mLines; ///< The laid out lines.
316 Vector<GlyphRun> mUnderlineRuns; ///< Runs of glyphs that are underlined.
318 Vector2 mControlSize; ///< The size of the UI control the decorator is adding it's decorations to.
319 Vector4 mTextColor; ///< The text color
320 Vector4 mShadowColor; ///< Color of drop shadow
321 Vector4 mUnderlineColor; ///< Color of underline
322 Vector2 mShadowOffset; ///< Offset for drop shadow, 0 indicates no shadow
323 float mUnderlineHeight; ///< Fixed height for underline to override font metrics.
327 Size mNaturalSize; ///< Size of the text with no line wrapping.
328 Size mActualSize; ///< Size of the laid-out text considering the layout properties set.
330 // Caches to increase performance in some consecutive operations.
331 LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.
335 bool mUnderlineEnabled:1; ///< Underline enabled flag
336 bool mUnderlineColorSet:1; ///< Has the underline color been explicitly set?
342 } // namespace Toolkit
346 #endif // __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__