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) 2019 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/object/base-object.h>
  23 #include <dali/public-api/object/weak-handle.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  27 #include <dali-toolkit/internal/text/rendering/text-typesetter.h>
  28 #include <dali-toolkit/internal/text/text-controller.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Internal
  37 {
  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   /**
  74    * @brief Create a new text visual.
  75    *
  76    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache 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, 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 Instantly updates the renderer
 120    * @param[in] visual The text visual.
 121    */
 122   static void UpdateRenderer( Toolkit::Visual::Base visual )
 123   {
 124     GetVisualObject( visual ).UpdateRenderer();
 125   };
 126
 127 public: // from Visual::Base
 128
 129   /**
 130    * @copydoc Visual::Base::GetHeightForWidth()
 131    */
 132   float GetHeightForWidth( float width ) override;
 133
 134   /**
 135    * @copydoc Visual::Base::GetNaturalSize()
 136    */
 137   void GetNaturalSize( Vector2& naturalSize ) override;
 138
 139   /**
 140    * @copydoc Visual::Base::CreatePropertyMap()
 141    */
 142   void DoCreatePropertyMap( Property::Map& map ) const override;
 143
 144   /**
 145    * @copydoc Visual::Base::CreateInstancePropertyMap
 146    */
 147   void DoCreateInstancePropertyMap( Property::Map& map ) const override;
 148
 149 protected:
 150
 151   /**
 152    * @brief Constructor.
 153    *
 154    * @param[in] factoryCache The VisualFactoryCache object
 155    */
 156   TextVisual( VisualFactoryCache& factoryCache );
 157
 158   /**
 159    * @brief A reference counted object may only be deleted by calling Unreference().
 160    */
 161   virtual ~TextVisual();
 162
 163   // from Visual::Base
 164
 165   /**
 166    * @copydoc Visual::Base::DoSetProperties()
 167    */
 168   void DoSetProperties( const Property::Map& propertyMap ) override;
 169
 170   /**
 171    * @copydoc Visual::Base::DoSetOnScene()
 172    */
 173   void DoSetOnScene( Actor& actor ) override;
 174
 175   /**
 176    * @copydoc Visual::Base::DoSetOffScene()
 177    */
 178   void DoSetOffScene( Actor& actor ) override;
 179
 180   /**
 181    * @copydoc Visual::Base::OnSetTransform
 182    */
 183   void OnSetTransform() override;
 184
 185 private:
 186
 187   struct TilingInfo
 188   {
 189     unsigned char* textBuffer;
 190     unsigned char* styleBuffer;
 191     unsigned char* maskBuffer;
 192     int width;
 193     int height;
 194     Pixel::Format textPixelFormat;
 195     int offsetPosition;
 196     Vector2 offSet;
 197
 198     TilingInfo( int width, int height, Pixel::Format textPixelFormat )
 199     : textBuffer( NULL ),
 200       styleBuffer( NULL ),
 201       maskBuffer( NULL ),
 202       width( width ),
 203       height( height ),
 204       textPixelFormat( textPixelFormat ),
 205       offsetPosition( 0 ),
 206       offSet( 0.f, 0.f )
 207     {
 208     }
 209
 210     ~TilingInfo()
 211     {
 212       if( textBuffer )
 213       {
 214         free( textBuffer );
 215       }
 216       if( styleBuffer )
 217       {
 218         free( styleBuffer );
 219       }
 220       if( maskBuffer )
 221       {
 222         free( maskBuffer );
 223       }
 224     }
 225
 226   };
 227
 228   /**
 229    * @brief Set the individual property to the given value.
 230    *
 231    * @param[in] index The index key used to reference this value within the initial property map.
 232    *
 233    * @param[in] propertyValue The value to set.
 234    */
 235   void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
 236
 237   /**
 238    * @brief Updates the text's renderer.
 239    */
 240   void UpdateRenderer();
 241
 242   /**
 243    * @brief Removes the text's renderer.
 244    */
 245   void RemoveRenderer( Actor& actor );
 246
 247   /**
 248    * @brief Create a texture in textureSet and add it.
 249    * @param[in] textureSet The textureSet to which the texture will be added.
 250    * @param[in] data The PixelData to be uploaded to texture
 251    * @param[in] sampler The sampler.
 252    * @param[in] textureSetIndex The Index of TextureSet.
 253    */
 254   void AddTexture( TextureSet& textureSet, PixelData& data, Sampler& sampler, unsigned int textureSetIndex );
 255
 256   /**
 257    * @brief Convert the buffer to pixelData.
 258    * @param[in] buffer The Buffer to be converted to pixelData.
 259    * @param[in] width The width of pixel data.
 260    * @param[in] height The height of pixel data.
 261    * @param[in] offsetPosition The The buffer's start position.
 262    * @param[in] textPixelFormat The PixelForma of text.
 263    */
 264   PixelData ConvertToPixelData( unsigned char* buffer, int width, int height, int offsetPosition, const Pixel::Format textPixelFormat );
 265
 266   /**
 267    * @brief Create the text's texture.
 268    * @param[in] info This is the information you need to create a Tiling.
 269    * @param[in] renderer The renderer to which the TextureSet will be added.
 270    * @param[in] sampler The sampler.
 271    * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
 272    * @param[in] containsColorGlyph Whether the text contains color glyph.
 273    * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
 274    */
 275   void CreateTextureSet( TilingInfo& info, Renderer& renderer, Sampler& sampler,  bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled );
 276
 277   /**
 278    * Create renderer of the text for rendering.
 279    * @param[in] actor The actor.
 280    * @param[in] size The texture size.
 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    */
 285   void AddRenderer( Actor& actor, const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled );
 286
 287
 288   /**
 289    * Get the texture of the text for rendering.
 290    * @param[in] size The texture size.
 291    * @param[in] hasMultipleTextColors Whether the text contains multiple colors.
 292    * @param[in] containsColorGlyph Whether the text contains color glyph.
 293    * @param[in] styleEnabled Whether the text contains any styles (e.g. shadow, underline, etc.).
 294    */
 295   TextureSet GetTextTexture( const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled );
 296
 297   /**
 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.).
 303    */
 304   Shader GetTextShader( VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled );
 305
 306   /**
 307    * @brief Retrieve the TextVisual object.
 308    * @param[in] visual A handle to the TextVisual
 309    * @return The TextVisual object
 310    */
 311   static TextVisual& GetVisualObject( Toolkit::Visual::Base visual )
 312   {
 313     return static_cast< TextVisual& >( Toolkit::GetImplementation( visual ).GetVisualObject() );
 314   };
 315
 316 private:
 317
 318   typedef std::vector< Renderer > RendererContainer;
 319
 320   /**
 321    * Used as an alternative to boolean so that it is obvious whether the text contains single or multiple text colors, and emoji and styles.
 322    */
 323   struct TextType
 324   {
 325     enum Type
 326     {
 327       SINGLE_COLOR_TEXT = 0, ///< The text contains single color only.
 328       MULTI_COLOR_TEXT = 1,  ///< The text contains multiple colorｓ.
 329       NO_EMOJI = 0,          ///< The text contains no emoji.
 330       HAS_EMOJI = 1,         ///< The text contains emoji.
 331       NO_STYLES = 0,         ///< The text contains contains no styles.
 332       HAS_SYLES = 1          ///< The text contains contains styles.
 333     };
 334   };
 335
 336
 337 private:
 338   Text::ControllerPtr mController;                        ///< The text's controller.
 339   Text::TypesetterPtr mTypesetter;                        ///< The text's typesetter.
 340   WeakHandle<Actor>   mControl;                           ///< The control where the renderer is added.
 341   Property::Index     mAnimatableTextColorPropertyIndex;  ///< The index of animatable text color property registered by the control.
 342   bool                mRendererUpdateNeeded:1;            ///< The flag to indicate whether the renderer needs to be updated.
 343   RendererContainer   mRendererList;
 344 };
 345
 346 } // namespace Internal
 347
 348 } // namespace Toolkit
 349
 350 } // namespace Dali
 351
 352 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */