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/vector4.h>
25 #include <dali/public-api/object/ref-object.h>
28 #include <dali-toolkit/internal/text/line-run.h>
43 typedef IntrusivePtr<VisualModel> VisualModelPtr;
46 * @brief A visual text model contains layout specific information.
49 * - A series of glyphs in visual order i.e. after the bidirectional reordering.
50 * - The position of each glyph within a 2D bounding box.
52 class VisualModel : public RefObject
57 * @brief Create a new instance of a VisualModel.
59 * @return A pointer to a new VisualModel.
61 static VisualModelPtr New();
66 * @brief Creates the character to glyph conversion table.
68 * @pre The glyphs per character table needs to be created first.
70 * @param[in] numberOfCharacters The number of characters.
72 void CreateCharacterToGlyphTable( Length numberOfCharacters = 0u );
75 * @brief Creates an array containing the number of glyphs per character.
77 * @param[in] numberOfCharacters The number of characters.
79 void CreateGlyphsPerCharacterTable( Length numberOfCharacters = 0u );
82 * @brief Retrieves glyphs in the given buffer.
84 * The size of the @p glyphs buffer needs to be big enough to copy the @p numberOfGlyphs.
85 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
86 * @param[in] glyphIndex Index to the first glyph.
87 * @param[in] numberOfGlyphs Number of glyphs to be copied.
89 void GetGlyphs( GlyphInfo* glyphs,
90 GlyphIndex glyphIndex,
91 Length numberOfGlyphs ) const;
93 // Character <--> Glyph conversion
96 * @brief Retrieves for each character the number of glyphs the character is shaped.
98 * @param[out] glyphsPerCharacter Pointer to a buffer where the number of glyphs for each character are copied.
99 * @param[in] characterIndex Index to the first character.
100 * @param[in] numberOfCharacters The number of characters.
102 void GetGlyphsPerCharacterMap( Length* glyphsPerCharacter,
103 CharacterIndex characterIndex,
104 Length numberOfCharacters ) const;
106 // Position interface
109 * @brief Retrieves the glyph positions.
111 * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions.
112 * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
113 * @param[in] glyphIndex Index to the first glyph position.
114 * @param[in] numberOfGlyphs The number of positions to be copied.
116 void GetGlyphPositions( Vector2* glyphPositions,
117 GlyphIndex glyphIndex,
118 Length numberOfGlyphs ) const;
123 * @brief Retrieves the number of lines and the index to the first line where the given range of glyphs is laid out.
125 * @param[in] glyphIndex Index to the first glyph.
126 * @param[in] numberOfGlyphs The number of glyph.
127 * @param[out] firstLine Index to the line containing the glyph index.
128 * @param[out] numberOfLines The number of lines.
130 void GetNumberOfLines( GlyphIndex glyphIndex,
131 Length numberOfGlyphs,
132 LineIndex& firstLine,
133 Length& numberOfLines ) const;
136 * @brief Retrieves the lines where the given range of glyphs is laid out.
138 * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.
140 * @param[out] lines Pointer to a buffer where the lines are copied.
141 * @param[in] glyphIndex Index to the first glyphs of the range.
142 * @param[in] numberOfGlyphs Number of glyphs in the range.
144 void GetLinesOfGlyphRange( LineRun* lines,
145 GlyphIndex glyphIndex,
146 Length numberOfGlyphs ) const;
149 * @brief Retrieves the line index where the character is laid-out.
151 * @param[in] characterIndex The character's index.
153 * @return The line index.
155 LineIndex GetLineOfCharacter( CharacterIndex characterIndex );
160 * @brief Sets the natural size.
162 * @param[in] size The text's natural size.
164 void SetNaturalSize( const Vector2& size );
167 * @brief Retrieves the natural size.
169 * @return The text's natural size.
171 const Vector2& GetNaturalSize() const;
174 * @brief Sets the text's actual size after it has been laid out.
176 * @param[in] size The text's size.
178 void SetActualSize( const Vector2& size );
181 * @brief Retrieves the text's actual size after it has been laid out.
183 * @return The text's size.
185 const Vector2& GetActualSize() const;
188 * @brief Set the text's color
190 * @param[in] textColor The text's color
192 void SetTextColor( const Vector4& textColor );
195 * @brief Retrieve the text's color
197 * @return The text's color
199 const Vector4& GetTextColor() const;
202 * @brief Sets the text's shadow offset.
204 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
206 void SetShadowOffset( const Vector2& shadowOffset );
209 * @brief Retrieves the text's shadow offset.
211 * @return The text's shadow offset, 0,0 indicates no shadow.
213 const Vector2& GetShadowOffset() const;
216 * @brief Sets the text's shadow color.
218 * @param[in] shadowColor The shadow color.
220 void SetShadowColor( const Vector4& shadowColor );
223 * @brief Retrieves the text's shadow color.
225 * @return The text's shadow color.
227 const Vector4& GetShadowColor() const;
230 * @brief Sets the text's underline color.
232 * @param[in] color The text's underline color.
234 void SetUnderlineColor( const Vector4& color );
237 * @brief Retrieves the text's underline color.
239 * @return The text's underline color.
241 const Vector4& GetUnderlineColor() const;
244 * @brief Sets the text underline flag.
246 * @param[in] enabled true if underlined.
248 void SetUnderlineEnabled( bool enabled );
251 * @brief Returns whether the text is underlined or not.
253 * @return underline state.
255 bool IsUnderlineEnabled() const;
258 * @brief Clear the caches.
263 * @brief Set the override used for underline height, 0 indicates height will be come from font metrics
265 * @param[in] height The height in pixels of the underline
267 void SetUnderlineHeight( float height );
270 * @brief Retrieves the underline height override
272 * @return Returns the override height for an underline, 0 indicates that font metrics will determine the height
274 float GetUnderlineHeight() const;
279 * @brief A reference counted object may only be deleted by calling Unreference().
281 virtual ~VisualModel();
286 * @brief Private constructor.
291 VisualModel( const VisualModel& handle );
294 VisualModel& operator=( const VisualModel& handle );
298 Vector<GlyphInfo> mGlyphs; ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
299 Vector<CharacterIndex> mGlyphsToCharacters; ///< For each glyph, the index of the first character.
300 Vector<GlyphIndex> mCharactersToGlyph; ///< For each character, the index of the first glyph.
301 Vector<Length> mCharactersPerGlyph; ///< For each glyph, the number of characters that form the glyph.
302 Vector<Length> mGlyphsPerCharacter; ///< For each character, the number of glyphs that are shaped.
303 Vector<Vector2> mGlyphPositions; ///< For each glyph, the position.
304 Vector<LineRun> mLines; ///< The laid out lines.
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.
316 Size mNaturalSize; ///< Size of the text with no line wrapping.
317 Size mActualSize; ///< Size of the laid-out text considering the layout properties set.
319 // Caches to increase performance in some consecutive operations.
320 LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.
324 bool mUnderlineEnabled:1; ///< Underline enabled flag
325 bool mUnderlineColorSet:1; ///< Has the underline color been explicitly set?
331 } // namespace Toolkit
335 #endif // __DALI_TOOLKIT_TEXT_VISUAL_MODEL_IMPL_H__