dali-toolkit/internal/visuals/text/text-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2024 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  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>
  26
  27 // INTERNAL INCLUDES
  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>
  32
  33 namespace Dali
  34 {
  35 namespace Toolkit
  36 {
  37 namespace Internal
  38 {
  39 class TextVisual;
  40 typedef IntrusivePtr<TextVisual> TextVisualPtr;
  41
  42 /**
  43  * The visual which renders text
  44  *
  45  * The following properties are optional:
  46  *
  47  * | %Property Name      | Type    |
  48  * |---------------------|---------|
  49  * | renderingBackend    | INTEGER |
  50  * | text                | STRING  |
  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  |
  65  * | shadow              | STRING  |
  66  * | outline             | STRING  |
  67  *
  68  */
  69 class TextVisual : public Visual::Base
  70 {
  71 public:
  72   /**
  73    * @brief Create a new text visual.
  74    *
  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.
  79    */
  80   static TextVisualPtr New(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory, const Property::Map& properties);
  81
  82   /**
  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.
  86    */
  87   static Property::Map ConvertStringKeysToIndexKeys(const Property::Map& propertyMap);
  88
  89   /**
  90    * @brief Retrieve the text's controller.
  91    * @param[in] visual The text visual.
  92    * @return The text controller
  93    */
  94   static Text::ControllerPtr GetController(Toolkit::Visual::Base visual)
  95   {
  96     return GetVisualObject(visual).mController;
  97   };
  98
  99   /**
 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
 103    */
 104   static void SetAnimatableTextColorProperty(Toolkit::Visual::Base visual, Property::Index animatablePropertyIndex)
 105   {
 106     GetVisualObject(visual).mAnimatableTextColorPropertyIndex = animatablePropertyIndex;
 107   };
 108
 109   /**
 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.
 112    */
 113   static void EnableRendererUpdate(Toolkit::Visual::Base visual)
 114   {
 115     GetVisualObject(visual).mRendererUpdateNeeded = true;
 116   };
 117
 118   /**
 119    * @brief Set the text to be always rendered
 120    * @param[in] visual The text visual.
 121    * @param[in] requireRender Whether to text always rendered.
 122    */
 123   static void SetRequireRender(Toolkit::Visual::Base visual, bool requireRender)
 124   {
 125     GetVisualObject(visual).SetRequireRender(requireRender);
 126   };
 127
 128   /**
 129    * @brief Instantly updates the renderer
 130    * @param[in] visual The text visual.
 131    */
 132   static void UpdateRenderer(Toolkit::Visual::Base visual)
 133   {
 134     GetVisualObject(visual).UpdateRenderer();
 135   };
 136
 137 public: // from Visual::Base
 138   /**
 139    * @copydoc Visual::Base::GetHeightForWidth()
 140    */
 141   float GetHeightForWidth(float width) override;
 142
 143   /**
 144    * @copydoc Visual::Base::GetNaturalSize()
 145    */
 146   void GetNaturalSize(Vector2& naturalSize) override;
 147
 148   /**
 149    * @copydoc Visual::Base::CreatePropertyMap()
 150    */
 151   void DoCreatePropertyMap(Property::Map& map) const override;
 152
 153   /**
 154    * @copydoc Visual::Base::CreateInstancePropertyMap
 155    */
 156   void DoCreateInstancePropertyMap(Property::Map& map) const override;
 157
 158   /**
 159    * @copydoc Visual::Base::EnablePreMultipliedAlpha
 160    */
 161   void EnablePreMultipliedAlpha(bool preMultiplied) override;
 162
 163 protected:
 164   /**
 165    * @brief Constructor.
 166    *
 167    * @param[in] factoryCache The VisualFactoryCache object
 168    * @param[in] shaderFactory The TextVisualShaderFactory object
 169    */
 170   TextVisual(VisualFactoryCache& factoryCache, TextVisualShaderFactory& shaderFactory);
 171
 172   /**
 173    * @brief A reference counted object may only be deleted by calling Unreference().
 174    */
 175   virtual ~TextVisual();
 176
 177   /**
 178    * @copydoc Visual::Base::OnInitialize
 179    */
 180   void OnInitialize() override;
 181
 182   // from Visual::Base
 183
 184   /**
 185    * @copydoc Visual::Base::DoSetProperties()
 186    */
 187   void DoSetProperties(const Property::Map& propertyMap) override;
 188
 189   /**
 190    * @copydoc Visual::Base::DoSetOnScene()
 191    */
 192   void DoSetOnScene(Actor& actor) override;
 193
 194   /**
 195    * @copydoc Visual::Base::DoSetOffScene()
 196    */
 197   void DoSetOffScene(Actor& actor) override;
 198
 199   /**
 200    * @copydoc Visual::Base::OnSetTransform
 201    */
 202   void OnSetTransform() override;
 203
 204 private:
 205   struct TilingInfo
 206   {
 207     PixelData     textPixelData;
 208     PixelData     stylePixelData;
 209     PixelData     overlayStylePixelData;
 210     PixelData     maskPixelData;
 211     int32_t       width;
 212     int32_t       height;
 213     Pixel::Format textPixelFormat;
 214     uint32_t      offsetHeight;
 215     Vector2       transformOffset;
 216
 217     TilingInfo(int32_t width, int32_t height, Pixel::Format textPixelFormat)
 218     : textPixelData(),
 219       stylePixelData(),
 220       overlayStylePixelData(),
 221       maskPixelData(),
 222       width(width),
 223       height(height),
 224       textPixelFormat(textPixelFormat),
 225       offsetHeight(0u),
 226       transformOffset(0.f, 0.f)
 227     {
 228     }
 229
 230     ~TilingInfo()
 231     {
 232     }
 233   };
 234
 235   /**
 236    * @brief Set the individual property to the given value.
 237    *
 238    * @param[in] index The index key used to reference this value within the initial property map.
 239    *
 240    * @param[in] propertyValue The value to set.
 241    */
 242   void DoSetProperty(Dali::Property::Index index, const Dali::Property::Value& propertyValue);
 243
 244   /**
 245    * @brief Updates the text's renderer.
 246    */
 247   void UpdateRenderer();
 248
 249   /**
 250    * @brief Removes the text's renderer.
 251    */
 252   void RemoveRenderer(Actor& actor, bool removeDefaultRenderer);
 253
 254   /**
 255    * @brief Create a texture in textureSet and add it.
 256    * @param[in] textureSet The textureSet to which the texture will be added.
 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.
 260    */
 261   void AddTexture(TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex);
 262
 263   /**
 264    * @brief Create a texture in textureSet and add it.
 265    * @param[in] textureSet The textureSet to which the texture will be added.
 266    * @param[in] tilingInfo The tiling infomation to be uploaded to texture.
 267    * @param[in] data The PixelData to be uploaded to texture.
 268    * @param[in] sampler The sampler.
 269    * @param[in] textureSetIndex The Index of TextureSet.
 270    */
 271   void AddTilingTexture(TextureSet& textureSet, TilingInfo& tilingInfo, PixelData& data, Sampler& sampler, unsigned int textureSetIndex);
 272
 273   /**
 274    * @brief Create the text's texture. It will use cached shader feature for text visual.
 275    * @param[in] info This is the information you need to create a Tiling.
 276    * @param[in] renderer The renderer to which the TextureSet will be added.
 277    * @param[in] sampler The sampler.
 278    */
 279   void CreateTextureSet(TilingInfo& info, VisualRenderer& renderer, Sampler& sampler);
 280
 281   /**
 282    * Create renderer of the text for rendering.
 283    * @param[in] actor The actor.
 284    * @param[in] size The texture size.
 285    * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
 286    * @param[in] containsColorGlyph Whether the text contains color glyph.
 287    * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
 288    * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
 289    */
 290   void AddRenderer(Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
 291
 292   /**
 293    * Get the texture of the text for rendering. It will use cached shader feature for text visual.
 294    * @param[in] size The texture size.
 295    */
 296   TextureSet GetTextTexture(const Vector2& size);
 297
 298   /**
 299    * Get the text rendering shader.
 300    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 301    * @param[in] featureBuilder Collection of current text shader's features. It will be cached as text visual.
 302    */
 303   Shader GetTextShader(VisualFactoryCache& factoryCache, const TextVisualShaderFeature::FeatureBuilder& featureBuilder);
 304
 305   /**
 306    * @brief Set the text to be always rendered
 307    * @param[in] requireRender Whether to text always rendered.
 308    */
 309   void SetRequireRender(bool requireRender);
 310
 311   /**
 312    * @brief Retrieve the TextVisual object.
 313    * @param[in] visual A handle to the TextVisual
 314    * @return The TextVisual object
 315    */
 316   static TextVisual& GetVisualObject(Toolkit::Visual::Base visual)
 317   {
 318     return static_cast<TextVisual&>(Toolkit::GetImplementation(visual).GetVisualObject());
 319   };
 320
 321 private:
 322   typedef std::vector<Renderer> RendererContainer;
 323
 324 private:
 325   Text::ControllerPtr mController; ///< The text's controller.
 326   Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
 327
 328   TextVisualShaderFactory&                mTextVisualShaderFactory; ///< The shader factory for text visual.
 329   TextVisualShaderFeature::FeatureBuilder mTextShaderFeatureCache;  ///< The cached shader feature for text visual.
 330
 331   WeakHandle<Actor> mControl;                          ///< The control where the renderer is added.
 332   Constraint        mColorConstraint{};                ///< Color constraint
 333   Constraint        mOpacityConstraint{};              ///< Opacity constraint
 334   Property::Index   mHasMultipleTextColorsIndex;       ///< The index of uHasMultipleTextColors proeprty.
 335   Property::Index   mAnimatableTextColorPropertyIndex; ///< The index of animatable text color property registered by the control.
 336   Property::Index   mTextColorAnimatableIndex;         ///< The index of uTextColorAnimatable property.
 337   Property::Index   mTextRequireRenderPropertyIndex;   ///< The index of requireRender property.
 338   bool              mRendererUpdateNeeded : 1;         ///< The flag to indicate whether the renderer needs to be updated.
 339   bool              mTextRequireRender : 1;            ///< The flag to indicate whether the text needs to be rendered.
 340   RendererContainer mRendererList;
 341 };
 342
 343 } // namespace Internal
 344
 345 } // namespace Toolkit
 346
 347 } // namespace Dali
 348
 349 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */