1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_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/animation/constraint.h>
23 #include <dali/public-api/object/base-object.h>
24 #include <dali/public-api/object/weak-handle.h>
27 #include <dali-toolkit/internal/text/rendering/text-typesetter.h>
28 #include <dali-toolkit/internal/text/text-controller.h>
29 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
38 typedef IntrusivePtr<TextVisual> TextVisualPtr;
41 * The visual which renders text
43 * The following properties are optional:
45 * | %Property Name | Type |
46 * |---------------------|---------|
47 * | renderingBackend | INTEGER |
49 * | fontFamily | STRING |
50 * | fontStyle | STRING |
51 * | pointSize | FLOAT |
52 * | multiLine | BOOLEAN |
53 * | horizontalAlignment | STRING |
54 * | verticalAlignment | STRING |
55 * | textColor | VECTOR4 |
56 * | enableMarkup | BOOLEAN |
57 * | enableAutoScroll | BOOLEAN |
58 * | autoScrollSpeed | INTEGER |
59 * | autoScrollLoopCount | INTEGER |
60 * | autoScrollGap | INTEGER |
61 * | lineSpacing | FLOAT |
62 * | underline | STRING |
64 * | outline | STRING |
67 class TextVisual : public Visual::Base
71 * @brief Create a new text visual.
73 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
74 * @param[in] properties A Property::Map containing settings for this visual
75 * @return A smart-pointer to the newly allocated visual.
77 static TextVisualPtr New(VisualFactoryCache& factoryCache, const Property::Map& properties);
80 * @brief Converts all strings keys in property map to index keys. Property Map can then be merged correctly.
81 * @param[in] propertyMap containing string keys or a mix of strings and indexes.
82 * @return Property::Map containing index keys.
84 static Property::Map ConvertStringKeysToIndexKeys(const Property::Map& propertyMap);
87 * @brief Retrieve the text's controller.
88 * @param[in] visual The text visual.
89 * @return The text controller
91 static Text::ControllerPtr GetController(Toolkit::Visual::Base visual)
93 return GetVisualObject(visual).mController;
97 * @brief Set the index of the animatable text color property.
98 * @param[in] visual The text visual.
99 * @param[in] animatablePropertyIndex The index of the animatable property
101 static void SetAnimatableTextColorProperty(Toolkit::Visual::Base visual, Property::Index animatablePropertyIndex)
103 GetVisualObject(visual).mAnimatableTextColorPropertyIndex = animatablePropertyIndex;
107 * @brief Set the flag to trigger the textures to be initialized and renderer to be added to the control.
108 * @param[in] visual The text visual.
110 static void EnableRendererUpdate(Toolkit::Visual::Base visual)
112 GetVisualObject(visual).mRendererUpdateNeeded = true;
116 * @brief Instantly updates the renderer
117 * @param[in] visual The text visual.
119 static void UpdateRenderer(Toolkit::Visual::Base visual)
121 GetVisualObject(visual).UpdateRenderer();
124 public: // from Visual::Base
126 * @copydoc Visual::Base::GetHeightForWidth()
128 float GetHeightForWidth(float width) override;
131 * @copydoc Visual::Base::GetNaturalSize()
133 void GetNaturalSize(Vector2& naturalSize) override;
136 * @copydoc Visual::Base::CreatePropertyMap()
138 void DoCreatePropertyMap(Property::Map& map) const override;
141 * @copydoc Visual::Base::CreateInstancePropertyMap
143 void DoCreateInstancePropertyMap(Property::Map& map) const override;
147 * @brief Constructor.
149 * @param[in] factoryCache The VisualFactoryCache object
151 TextVisual(VisualFactoryCache& factoryCache);
154 * @brief A reference counted object may only be deleted by calling Unreference().
156 virtual ~TextVisual();
159 * @copydoc Visual::Base::OnInitialize
161 void OnInitialize() override;
166 * @copydoc Visual::Base::DoSetProperties()
168 void DoSetProperties(const Property::Map& propertyMap) override;
171 * @copydoc Visual::Base::DoSetOnScene()
173 void DoSetOnScene(Actor& actor) override;
176 * @copydoc Visual::Base::DoSetOffScene()
178 void DoSetOffScene(Actor& actor) override;
181 * @copydoc Visual::Base::OnSetTransform
183 void OnSetTransform() override;
188 unsigned char* textBuffer;
189 unsigned char* styleBuffer;
190 unsigned char* maskBuffer;
193 Pixel::Format textPixelFormat;
197 TilingInfo(int width, int height, Pixel::Format textPixelFormat)
203 textPixelFormat(textPixelFormat),
227 * @brief Set the individual property to the given value.
229 * @param[in] index The index key used to reference this value within the initial property map.
231 * @param[in] propertyValue The value to set.
233 void DoSetProperty(Dali::Property::Index index, const Dali::Property::Value& propertyValue);
236 * @brief Updates the text's renderer.
238 void UpdateRenderer();
241 * @brief Removes the text's renderer.
243 void RemoveRenderer(Actor& actor);
246 * @brief Create a texture in textureSet and add it.
247 * @param[in] textureSet The textureSet to which the texture will be added.
248 * @param[in] data The PixelData to be uploaded to texture
249 * @param[in] sampler The sampler.
250 * @param[in] textureSetIndex The Index of TextureSet.
252 void AddTexture(TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex);
255 * @brief Convert the buffer to pixelData.
256 * @param[in] buffer The Buffer to be converted to pixelData.
257 * @param[in] width The width of pixel data.
258 * @param[in] height The height of pixel data.
259 * @param[in] offsetPosition The The buffer's start position.
260 * @param[in] textPixelFormat The PixelForma of text.
262 PixelData ConvertToPixelData(unsigned char* buffer, int width, int height, int offsetPosition, const Pixel::Format textPixelFormat);
265 * @brief Create the text's texture.
266 * @param[in] info This is the information you need to create a Tiling.
267 * @param[in] renderer The renderer to which the TextureSet will be added.
268 * @param[in] sampler The sampler.
269 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
270 * @param[in] containsColorGlyph Whether the text contains color glyph.
271 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
272 * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
274 void CreateTextureSet(TilingInfo& info, Renderer& renderer, Sampler& sampler, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
277 * Create renderer of the text for rendering.
278 * @param[in] actor The actor.
279 * @param[in] size The texture size.
280 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
281 * @param[in] containsColorGlyph Whether the text contains color glyph.
282 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
283 * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
285 void AddRenderer(Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
288 * Get the texture of the text for rendering.
289 * @param[in] size The texture size.
290 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
291 * @param[in] containsColorGlyph Whether the text contains color glyph.
292 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
293 * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
295 TextureSet GetTextTexture(const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
298 * Get the text rendering shader.
299 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
300 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
301 * @param[in] containsColorGlyph Whether the text contains color glyph.
302 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
304 Shader GetTextShader(VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled);
307 * @brief Retrieve the TextVisual object.
308 * @param[in] visual A handle to the TextVisual
309 * @return The TextVisual object
311 static TextVisual& GetVisualObject(Toolkit::Visual::Base visual)
313 return static_cast<TextVisual&>(Toolkit::GetImplementation(visual).GetVisualObject());
317 typedef std::vector<Renderer> RendererContainer;
320 * Used as an alternative to boolean so that it is obvious whether the text contains single or multiple text colors, and emoji and styles.
326 SINGLE_COLOR_TEXT = 0, ///< The text contains single color only.
327 MULTI_COLOR_TEXT = 1, ///< The text contains multiple colors.
328 NO_EMOJI = 0, ///< The text contains no emoji.
329 HAS_EMOJI = 1, ///< The text contains emoji.
330 NO_STYLES = 0, ///< The text contains contains no styles.
331 HAS_SYLES = 1 ///< The text contains contains styles.
336 Text::ControllerPtr mController; ///< The text's controller.
337 Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
338 WeakHandle<Actor> mControl; ///< The control where the renderer is added.
339 Constraint mColorConstraint{}; ///< Color constraint
340 Constraint mOpacityConstraint{}; ///< Opacity constraint
341 Property::Index mAnimatableTextColorPropertyIndex; ///< The index of animatable text color property registered by the control.
342 Property::Index mTextColorAnimatableIndex; ///< The index of uTextColorAnimatable property.
343 bool mRendererUpdateNeeded : 1; ///< The flag to indicate whether the renderer needs to be updated.
344 RendererContainer mRendererList;
347 } // namespace Internal
349 } // namespace Toolkit
353 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */