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) 2022 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/rendering/text-typesetter.h>
  29 #include <dali-toolkit/internal/text/text-controller.h>
  30 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  31
  32 namespace Dali
  33 {
  34 namespace Toolkit
  35 {
  36 namespace Internal
  37 {
  38 class TextVisual;
  39 typedef IntrusivePtr<TextVisual> TextVisualPtr;
  40
  41 /**
  42  * The visual which renders text
  43  *
  44  * The following properties are optional:
  45  *
  46  * | %Property Name      | Type    |
  47  * |---------------------|---------|
  48  * | renderingBackend    | INTEGER |
  49  * | text                | STRING  |
  50  * | fontFamily          | STRING  |
  51  * | fontStyle           | STRING  |
  52  * | pointSize           | FLOAT   |
  53  * | multiLine           | BOOLEAN |
  54  * | horizontalAlignment | STRING  |
  55  * | verticalAlignment   | STRING  |
  56  * | textColor           | VECTOR4 |
  57  * | enableMarkup        | BOOLEAN |
  58  * | enableAutoScroll    | BOOLEAN |
  59  * | autoScrollSpeed     | INTEGER |
  60  * | autoScrollLoopCount | INTEGER |
  61  * | autoScrollGap       | INTEGER |
  62  * | lineSpacing         | FLOAT   |
  63  * | underline           | STRING  |
  64  * | shadow              | STRING  |
  65  * | outline             | STRING  |
  66  *
  67  */
  68 class TextVisual : public Visual::Base
  69 {
  70 public:
  71   /**
  72    * @brief Create a new text visual.
  73    *
  74    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  75    * @param[in] properties A Property::Map containing settings for this visual
  76    * @return A smart-pointer to the newly allocated visual.
  77    */
  78   static TextVisualPtr New(VisualFactoryCache& factoryCache, const Property::Map& properties);
  79
  80   /**
  81    * @brief Converts all strings keys in property map to index keys.  Property Map can then be merged correctly.
  82    * @param[in] propertyMap containing string keys or a mix of strings and indexes.
  83    * @return Property::Map containing index keys.
  84    */
  85   static Property::Map ConvertStringKeysToIndexKeys(const Property::Map& propertyMap);
  86
  87   /**
  88    * @brief Retrieve the text's controller.
  89    * @param[in] visual The text visual.
  90    * @return The text controller
  91    */
  92   static Text::ControllerPtr GetController(Toolkit::Visual::Base visual)
  93   {
  94     return GetVisualObject(visual).mController;
  95   };
  96
  97   /**
  98    * @brief Set the index of the animatable text color property.
  99    * @param[in] visual The text visual.
 100    * @param[in] animatablePropertyIndex The index of the animatable property
 101    */
 102   static void SetAnimatableTextColorProperty(Toolkit::Visual::Base visual, Property::Index animatablePropertyIndex)
 103   {
 104     GetVisualObject(visual).mAnimatableTextColorPropertyIndex = animatablePropertyIndex;
 105   };
 106
 107   /**
 108    * @brief Set the flag to trigger the textures to be initialized and renderer to be added to the control.
 109    * @param[in] visual The text visual.
 110    */
 111   static void EnableRendererUpdate(Toolkit::Visual::Base visual)
 112   {
 113     GetVisualObject(visual).mRendererUpdateNeeded = true;
 114   };
 115
 116   /**
 117    * @brief Instantly updates the renderer
 118    * @param[in] visual The text visual.
 119    */
 120   static void UpdateRenderer(Toolkit::Visual::Base visual)
 121   {
 122     GetVisualObject(visual).UpdateRenderer();
 123   };
 124
 125 public: // from Visual::Base
 126   /**
 127    * @copydoc Visual::Base::GetHeightForWidth()
 128    */
 129   float GetHeightForWidth(float width) override;
 130
 131   /**
 132    * @copydoc Visual::Base::GetNaturalSize()
 133    */
 134   void GetNaturalSize(Vector2& naturalSize) override;
 135
 136   /**
 137    * @copydoc Visual::Base::CreatePropertyMap()
 138    */
 139   void DoCreatePropertyMap(Property::Map& map) const override;
 140
 141   /**
 142    * @copydoc Visual::Base::CreateInstancePropertyMap
 143    */
 144   void DoCreateInstancePropertyMap(Property::Map& map) const override;
 145
 146   /**
 147    * @copydoc Visual::Base::EnablePreMultipliedAlpha
 148    */
 149   void EnablePreMultipliedAlpha(bool preMultiplied) override;
 150
 151 protected:
 152   /**
 153    * @brief Constructor.
 154    *
 155    * @param[in] factoryCache The VisualFactoryCache object
 156    */
 157   TextVisual(VisualFactoryCache& factoryCache);
 158
 159   /**
 160    * @brief A reference counted object may only be deleted by calling Unreference().
 161    */
 162   virtual ~TextVisual();
 163
 164   /**
 165    * @copydoc Visual::Base::OnInitialize
 166    */
 167   void OnInitialize() override;
 168
 169   // from Visual::Base
 170
 171   /**
 172    * @copydoc Visual::Base::DoSetProperties()
 173    */
 174   void DoSetProperties(const Property::Map& propertyMap) override;
 175
 176   /**
 177    * @copydoc Visual::Base::DoSetOnScene()
 178    */
 179   void DoSetOnScene(Actor& actor) override;
 180
 181   /**
 182    * @copydoc Visual::Base::DoSetOffScene()
 183    */
 184   void DoSetOffScene(Actor& actor) override;
 185
 186   /**
 187    * @copydoc Visual::Base::OnSetTransform
 188    */
 189   void OnSetTransform() override;
 190
 191 private:
 192   struct TilingInfo
 193   {
 194     unsigned char* textBuffer;
 195     unsigned char* styleBuffer;
 196     unsigned char* overlayStyleBuffer;
 197     unsigned char* maskBuffer;
 198     int            width;
 199     int            height;
 200     Pixel::Format  textPixelFormat;
 201     int            offsetPosition;
 202     Vector2        offSet;
 203
 204     TilingInfo(int width, int height, Pixel::Format textPixelFormat)
 205     : textBuffer(NULL),
 206       styleBuffer(NULL),
 207       overlayStyleBuffer(NULL),
 208       maskBuffer(NULL),
 209       width(width),
 210       height(height),
 211       textPixelFormat(textPixelFormat),
 212       offsetPosition(0),
 213       offSet(0.f, 0.f)
 214     {
 215     }
 216
 217     ~TilingInfo()
 218     {
 219       if(textBuffer)
 220       {
 221         free(textBuffer);
 222       }
 223       if(styleBuffer)
 224       {
 225         free(styleBuffer);
 226       }
 227       if(overlayStyleBuffer)
 228       {
 229         free(overlayStyleBuffer);
 230       }
 231       if(maskBuffer)
 232       {
 233         free(maskBuffer);
 234       }
 235     }
 236   };
 237
 238   /**
 239    * @brief Set the individual property to the given value.
 240    *
 241    * @param[in] index The index key used to reference this value within the initial property map.
 242    *
 243    * @param[in] propertyValue The value to set.
 244    */
 245   void DoSetProperty(Dali::Property::Index index, const Dali::Property::Value& propertyValue);
 246
 247   /**
 248    * @brief Updates the text's renderer.
 249    */
 250   void UpdateRenderer();
 251
 252   /**
 253    * @brief Removes the text's renderer.
 254    */
 255   void RemoveRenderer(Actor& actor);
 256
 257   /**
 258    * @brief Create a texture in textureSet and add it.
 259    * @param[in] textureSet The textureSet to which the texture will be added.
 260    * @param[in] data The PixelData to be uploaded to texture
 261    * @param[in] sampler The sampler.
 262    * @param[in] textureSetIndex The Index of TextureSet.
 263    */
 264   void AddTexture(TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex);
 265
 266   /**
 267    * @brief Convert the buffer to pixelData.
 268    * @param[in] buffer The Buffer to be converted to pixelData.
 269    * @param[in] width The width of pixel data.
 270    * @param[in] height The height of pixel data.
 271    * @param[in] offsetPosition The The buffer's start position.
 272    * @param[in] textPixelFormat The PixelForma of text.
 273    */
 274   PixelData ConvertToPixelData(unsigned char* buffer, int width, int height, int offsetPosition, const Pixel::Format textPixelFormat);
 275
 276   /**
 277    * @brief Create the text's texture.
 278    * @param[in] info This is the information you need to create a Tiling.
 279    * @param[in] renderer The renderer to which the TextureSet will be added.
 280    * @param[in] sampler The sampler.
 281    * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
 282    * @param[in] containsColorGlyph Whether the text contains color glyph.
 283    * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
 284    * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
 285    */
 286   void CreateTextureSet(TilingInfo& info, VisualRenderer& renderer, Sampler& sampler, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
 287
 288   /**
 289    * Create renderer of the text for rendering.
 290    * @param[in] actor The actor.
 291    * @param[in] size The texture size.
 292    * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
 293    * @param[in] containsColorGlyph Whether the text contains color glyph.
 294    * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
 295    * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
 296    */
 297   void AddRenderer(Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
 298
 299   /**
 300    * Get the texture of the text for rendering.
 301    * @param[in] size The texture size.
 302    * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
 303    * @param[in] containsColorGlyph Whether the text contains color glyph.
 304    * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
 305    * @param[in] isOverlayStyle Whether the style needs to overlay on the text (e.g. strikethrough, underline, etc.).
 306    */
 307   TextureSet GetTextTexture(const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled, bool isOverlayStyle);
 308
 309   /**
 310    * Get the text rendering shader.
 311    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
 312    * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
 313    * @param[in] containsColorGlyph Whether the text contains color glyph.
 314    * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
 315    */
 316   Shader GetTextShader(VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled);
 317
 318   /**
 319    * @brief Retrieve the TextVisual object.
 320    * @param[in] visual A handle to the TextVisual
 321    * @return The TextVisual object
 322    */
 323   static TextVisual& GetVisualObject(Toolkit::Visual::Base visual)
 324   {
 325     return static_cast<TextVisual&>(Toolkit::GetImplementation(visual).GetVisualObject());
 326   };
 327
 328 private:
 329   typedef std::vector<Renderer> RendererContainer;
 330
 331   /**
 332    * Used as an alternative to boolean so that it is obvious whether the text contains single or multiple text colors, and emoji and styles.
 333    */
 334   struct TextType
 335   {
 336     enum Type
 337     {
 338       SINGLE_COLOR_TEXT = 0, ///< The text contains single color only.
 339       MULTI_COLOR_TEXT  = 1, ///< The text contains multiple colorｓ.
 340       NO_EMOJI          = 0, ///< The text contains no emoji.
 341       HAS_EMOJI         = 1, ///< The text contains emoji.
 342       NO_STYLES         = 0, ///< The text contains contains no styles.
 343       HAS_SYLES         = 1  ///< The text contains contains styles.
 344     };
 345   };
 346
 347 private:
 348   Text::ControllerPtr mController;                       ///< The text's controller.
 349   Text::TypesetterPtr mTypesetter;                       ///< The text's typesetter.
 350   WeakHandle<Actor>   mControl;                          ///< The control where the renderer is added.
 351   Constraint          mColorConstraint{};                ///< Color constraint
 352   Constraint          mOpacityConstraint{};              ///< Opacity constraint
 353   Property::Index     mAnimatableTextColorPropertyIndex; ///< The index of animatable text color property registered by the control.
 354   Property::Index     mTextColorAnimatableIndex;         ///< The index of uTextColorAnimatable property.
 355   bool                mRendererUpdateNeeded : 1;         ///< The flag to indicate whether the renderer needs to be updated.
 356   RendererContainer   mRendererList;
 357 };
 358
 359 } // namespace Internal
 360
 361 } // namespace Toolkit
 362
 363 } // namespace Dali
 364
 365 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */