1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_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/animation/constraint.h>
23 #include <dali/public-api/object/base-object.h>
24 #include <dali/public-api/object/weak-handle.h>
25 #include <dali/public-api/rendering/visual-renderer.h>
28 #include <dali-toolkit/internal/text/controller/text-controller.h>
29 #include <dali-toolkit/internal/text/rendering/text-typesetter.h>
30 #include <dali-toolkit/internal/visuals/text-visual-shader-factory.h>
31 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
40 typedef IntrusivePtr<TextVisual> TextVisualPtr;
43 * The visual which renders text
45 * The following properties are optional:
47 * | %Property Name | Type |
48 * |---------------------|---------|
49 * | renderingBackend | INTEGER |
51 * | fontFamily | STRING |
52 * | fontStyle | STRING |
53 * | pointSize | FLOAT |
54 * | multiLine | BOOLEAN |
55 * | horizontalAlignment | STRING |
56 * | verticalAlignment | STRING |
57 * | textColor | VECTOR4 |
58 * | enableMarkup | BOOLEAN |
59 * | enableAutoScroll | BOOLEAN |
60 * | autoScrollSpeed | INTEGER |
61 * | autoScrollLoopCount | INTEGER |
62 * | autoScrollGap | INTEGER |
63 * | lineSpacing | FLOAT |
64 * | underline | STRING |
66 * | outline | STRING |
69 class TextVisual : public Visual::Base
73 * @brief Create a new text visual.
75 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
76 * @param[in] shaderFactory The TextVisualShaderFactory object
77 * @param[in] properties A Property::Map containing settings for this visual
78 * @return A smart-pointer to the newly allocated visual.
80 static TextVisualPtr New(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory, const Property::Map& properties);
83 * @brief Converts all strings keys in property map to index keys. Property Map can then be merged correctly.
84 * @param[in] propertyMap containing string keys or a mix of strings and indexes.
85 * @return Property::Map containing index keys.
87 static Property::Map ConvertStringKeysToIndexKeys(const Property::Map& propertyMap);
90 * @brief Retrieve the text's controller.
91 * @param[in] visual The text visual.
92 * @return The text controller
94 static Text::ControllerPtr GetController(Toolkit::Visual::Base visual)
96 return GetVisualObject(visual).mController;
100 * @brief Set the index of the animatable text color property.
101 * @param[in] visual The text visual.
102 * @param[in] animatablePropertyIndex The index of the animatable property
104 static void SetAnimatableTextColorProperty(Toolkit::Visual::Base visual, Property::Index animatablePropertyIndex)
106 GetVisualObject(visual).mAnimatableTextColorPropertyIndex = animatablePropertyIndex;
110 * @brief Set the flag to trigger the textures to be initialized and renderer to be added to the control.
111 * @param[in] visual The text visual.
113 static void EnableRendererUpdate(Toolkit::Visual::Base visual)
115 GetVisualObject(visual).mRendererUpdateNeeded = true;
119 * @brief Instantly updates the renderer
120 * @param[in] visual The text visual.
122 static void UpdateRenderer(Toolkit::Visual::Base visual)
124 GetVisualObject(visual).UpdateRenderer();
127 public: // from Visual::Base
129 * @copydoc Visual::Base::GetHeightForWidth()
131 float GetHeightForWidth(float width) override;
134 * @copydoc Visual::Base::GetNaturalSize()
136 void GetNaturalSize(Vector2& naturalSize) override;
139 * @copydoc Visual::Base::CreatePropertyMap()
141 void DoCreatePropertyMap(Property::Map& map) const override;
144 * @copydoc Visual::Base::CreateInstancePropertyMap
146 void DoCreateInstancePropertyMap(Property::Map& map) const override;
149 * @copydoc Visual::Base::EnablePreMultipliedAlpha
151 void EnablePreMultipliedAlpha(bool preMultiplied) override;
155 * @brief Constructor.
157 * @param[in] factoryCache The VisualFactoryCache object
158 * @param[in] shaderFactory The TextVisualShaderFactory object
160 TextVisual(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory);
163 * @brief A reference counted object may only be deleted by calling Unreference().
165 virtual ~TextVisual();
168 * @copydoc Visual::Base::OnInitialize
170 void OnInitialize() override;
175 * @copydoc Visual::Base::DoSetProperties()
177 void DoSetProperties(const Property::Map& propertyMap) override;
180 * @copydoc Visual::Base::DoSetOnScene()
182 void DoSetOnScene(Actor& actor) override;
185 * @copydoc Visual::Base::DoSetOffScene()
187 void DoSetOffScene(Actor& actor) override;
190 * @copydoc Visual::Base::OnSetTransform
192 void OnSetTransform() override;
197 PixelData textPixelData;
198 PixelData stylePixelData;
199 PixelData overlayStylePixelData;
200 PixelData maskPixelData;
203 Pixel::Format textPixelFormat;
204 uint32_t offsetHeight;
205 Vector2 transformOffset;
207 TilingInfo(int32_t width, int32_t height, Pixel::Format textPixelFormat)
210 overlayStylePixelData(),
214 textPixelFormat(textPixelFormat),
216 transformOffset(0.f, 0.f)
226 * @brief Set the individual property to the given value.
228 * @param[in] index The index key used to reference this value within the initial property map.
230 * @param[in] propertyValue The value to set.
232 void DoSetProperty(Dali::Property::Index index, const Dali::Property::Value& propertyValue);
235 * @brief Updates the text's renderer.
237 void UpdateRenderer();
240 * @brief Removes the text's renderer.
242 void RemoveRenderer(Actor& actor);
245 * @brief Create a texture in textureSet and add it.
246 * @param[in] textureSet The textureSet to which the texture will be added.
247 * @param[in] data The PixelData to be uploaded to texture.
248 * @param[in] sampler The sampler.
249 * @param[in] textureSetIndex The Index of TextureSet.
251 void AddTexture(TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex);
254 * @brief Create a texture in textureSet and add it.
255 * @param[in] textureSet The textureSet to which the texture will be added.
256 * @param[in] tilingInfo The tiling infomation to be uploaded to texture.
257 * @param[in] data The PixelData to be uploaded to texture.
258 * @param[in] sampler The sampler.
259 * @param[in] textureSetIndex The Index of TextureSet.
261 void AddTilingTexture(TextureSet& textureSet, TilingInfo& tilingInfo, PixelData& data, Sampler& sampler, unsigned int textureSetIndex);
264 * @brief Create the text's texture. It will use cached shader feature for text visual.
265 * @param[in] info This is the information you need to create a Tiling.
266 * @param[in] renderer The renderer to which the TextureSet will be added.
267 * @param[in] sampler The sampler.
269 void CreateTextureSet(TilingInfo& info, VisualRenderer& renderer, Sampler& sampler);
272 * Create renderer of the text for rendering.
273 * @param[in] actor The actor.
274 * @param[in] size The texture size.
275 * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
276 * @param[in] containsColorGlyph Whether the text contains color glyph.
277 * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
278 * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
280 void AddRenderer(Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
283 * Get the texture of the text for rendering. It will use cached shader feature for text visual.
284 * @param[in] size The texture size.
286 TextureSet GetTextTexture(const Vector2& size);
289 * Get the text rendering shader.
290 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
291 * @param[in] featureBuilder Collection of current text shader's features. It will be cached as text visual.
293 Shader GetTextShader(VisualFactoryCache& factoryCache, const TextVisualShaderFeature::FeatureBuilder& featureBuilder);
296 * @brief Retrieve the TextVisual object.
297 * @param[in] visual A handle to the TextVisual
298 * @return The TextVisual object
300 static TextVisual& GetVisualObject(Toolkit::Visual::Base visual)
302 return static_cast<TextVisual&>(Toolkit::GetImplementation(visual).GetVisualObject());
306 typedef std::vector<Renderer> RendererContainer;
309 Text::ControllerPtr mController; ///< The text's controller.
310 Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
312 TextVisualShaderFactory& mTextVisualShaderFactory; ///< The shader factory for text visual.
313 TextVisualShaderFeature::FeatureBuilder mTextShaderFeatureCache; ///< The cached shader feature for text visual.
315 WeakHandle<Actor> mControl; ///< The control where the renderer is added.
316 Constraint mColorConstraint{}; ///< Color constraint
317 Constraint mOpacityConstraint{}; ///< Opacity constraint
318 Property::Index mAnimatableTextColorPropertyIndex; ///< The index of animatable text color property registered by the control.
319 Property::Index mTextColorAnimatableIndex; ///< The index of uTextColorAnimatable property.
320 bool mRendererUpdateNeeded : 1; ///< The flag to indicate whether the renderer needs to be updated.
321 RendererContainer mRendererList;
324 } // namespace Internal
326 } // namespace Toolkit
330 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */