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;
94 * @brief Retrieves the glyph positions.
96 * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions.
97 * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
98 * @param[in] glyphIndex Index to the first glyph position.
99 * @param[in] numberOfGlyphs The number of positions to be copied.
101 void GetGlyphPositions( Vector2* glyphPositions,
102 GlyphIndex glyphIndex,
103 Length numberOfGlyphs ) const;
108 * @brief Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out.
110 * @param[in] glyphIndex Index to the first glyph.
111 * @param[in] numberOfGlyphs The number of glyph.
112 * @param[out] firstLine Index to the line containing the glyph index.
113 * @param[out] numberOfLines The number of lines.
115 void GetNumberOfLines( GlyphIndex glyphIndex,
116 Length numberOfGlyphs,
117 LineIndex& firstLine,
118 Length& numberOfLines ) const;
121 * @brief Retrieves the lines where the given range of glyphs is laid out.
123 * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.
125 * @param[out] lines Pointer to a buffer where the lines are copied.
126 * @param[in] glyphIndex Index to the first glyphs of the range.
127 * @param[in] numberOfGlyphs Number of glyphs in the range.
129 void GetLinesOfGlyphRange( LineRun* lines,
130 GlyphIndex glyphIndex,
131 Length numberOfGlyphs ) const;
134 * @brief Retrieves the line index where the character is laid-out.
136 * @param[in] characterIndex The character's index.
138 * @return The line index.
140 LineIndex GetLineOfCharacter( CharacterIndex characterIndex );
145 * @brief Retrieves the underline runs.
147 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
148 * @param[in] index Index of the first underline run to be copied.
149 * @param[in] numberOfRuns Number of underline runs to be copied.
151 void GetUnderlineRuns( GlyphRun* underlineRuns,
152 UnderlineRunIndex index,
153 Length numberOfRuns ) const;
158 * @brief Sets the natural size.
160 * @param[in] size The text's natural size.
162 void SetNaturalSize( const Vector2& size );
165 * @brief Retrieves the natural size.
167 * @return The text's natural size.
169 const Vector2& GetNaturalSize() const;
172 * @brief Sets the text's actual size after it has been laid out.
174 * @param[in] size The text's size.
176 void SetActualSize( const Vector2& size );
179 * @brief Retrieves the text's actual size after it has been laid out.
181 * @return The text's size.
183 const Vector2& GetActualSize() const;
186 * @brief Set the text's color
188 * @param[in] textColor The text's color
190 void SetTextColor( const Vector4& textColor );
193 * @brief Retrieve the text's color
195 * @return The text's color
197 const Vector4& GetTextColor() const;
200 * @brief Sets the text's shadow offset.
202 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
204 void SetShadowOffset( const Vector2& shadowOffset );
207 * @brief Retrieves the text's shadow offset.
209 * @return The text's shadow offset, 0,0 indicates no shadow.
211 const Vector2& GetShadowOffset() const;
214 * @brief Sets the text's shadow color.
216 * @param[in] shadowColor The shadow color.
218 void SetShadowColor( const Vector4& shadowColor );
221 * @brief Retrieves the text's shadow color.
223 * @return The text's shadow color.
225 const Vector4& GetShadowColor() const;
228 * @brief Sets the text's underline color.
230 * @param[in] color The text's underline color.
232 void SetUnderlineColor( const Vector4& color );
235 * @brief Retrieves the text's underline color.
237 * @return The text's underline color.
239 const Vector4& GetUnderlineColor() const;
242 * @brief Sets the text underline flag.
244 * @param[in] enabled true if underlined.
246 void SetUnderlineEnabled( bool enabled );
249 * @brief Returns whether the text is underlined or not.
251 * @return underline state.
253 bool IsUnderlineEnabled() const;
256 * @brief Clear the caches.
261 * @brief Set the override used for underline height, 0 indicates height will be come from font metrics
263 * @param[in] height The height in pixels of the underline
265 void SetUnderlineHeight( float height );
268 * @brief Retrieves the underline height override
270 * @return Returns the override height for an underline, 0 indicates that font metrics will determine the height
272 float GetUnderlineHeight() const;
277 * @brief A reference counted object may only be deleted by calling Unreference().
279 virtual ~VisualModel();
284 * @brief Private constructor.
289 VisualModel( const VisualModel& handle );
292 VisualModel& operator=( const VisualModel& handle );
296 Vector<GlyphInfo> mGlyphs; ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
297 Vector<CharacterIndex> mGlyphsToCharacters; ///< For each glyph, the index of the first character.
298 Vector<GlyphIndex> mCharactersToGlyph; ///< For each character, the index of the first glyph.
299 Vector<Length> mCharactersPerGlyph; ///< For each glyph, the number of characters that form the glyph.
300 Vector<Length> mGlyphsPerCharacter; ///< For each character, the number of glyphs that are shaped.
301 Vector<Vector2> mGlyphPositions; ///< For each glyph, the position.
302 Vector<LineRun> mLines; ///< The laid out lines.
303 Vector<GlyphRun> mUnderlineRuns; ///< Runs of glyphs that are underlined.
305 Vector2 mControlSize; ///< The size of the UI control the decorator is adding it's decorations to.
306 Vector4 mTextColor; ///< The text color
307 Vector4 mShadowColor; ///< Color of drop shadow
308 Vector4 mUnderlineColor; ///< Color of underline
309 Vector2 mShadowOffset; ///< Offset for drop shadow, 0 indicates no shadow
310 float mUnderlineHeight; ///< Fixed height for underline to override font metrics.
314 Size mNaturalSize; ///< Size of the text with no line wrapping.
315 Size mActualSize; ///< Size of the laid-out text considering the layout properties set.
317 // Caches to increase performance in some consecutive operations.
318 LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.
322 bool mUnderlineEnabled:1; ///< Underline enabled flag
323 bool mUnderlineColorSet:1; ///< Has the underline color been explicitly set?
329 } // namespace Toolkit
333 #endif // __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__