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

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/visuals/text/text-visual.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/animation/constraints.h>
  23 #include <dali/devel-api/rendering/renderer-devel.h>
  24 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  25
  26 // INTERNAL HEADER
  27 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
  28 #include <dali-toolkit/devel-api/visuals/text-visual-properties-devel.h>
  29 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  30 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  31 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  32 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  33 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  35 #include <dali-toolkit/internal/text/text-font-style.h>
  36 #include <dali-toolkit/internal/text/text-effects-style.h>
  37 #include <dali-toolkit/internal/text/script-run.h>
  38 #include <dali-toolkit/internal/text/text-enumerations-impl.h>
  39 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
  40
  41 namespace Dali
  42 {
  43
  44 namespace Toolkit
  45 {
  46
  47 namespace Internal
  48 {
  49
  50 namespace
  51 {
  52
  53 // Property names - common properties defined in visual-string-constants.h/cpp
  54 const char * const FONT_FAMILY_PROPERTY( "fontFamily" );
  55 const char * const FONT_STYLE_PROPERTY( "fontStyle" );
  56 const char * const POINT_SIZE_PROPERTY( "pointSize" );
  57 const char * const MULTI_LINE_PROPERTY( "multiLine" );
  58 const char * const HORIZONTAL_ALIGNMENT_PROPERTY( "horizontalAlignment" );
  59 const char * const VERTICAL_ALIGNMENT_PROPERTY( "verticalAlignment" );
  60 const char * const TEXT_COLOR_PROPERTY( "textColor" );
  61 const char * const ENABLE_MARKUP_PROPERTY( "enableMarkup" );
  62 const char * const SHADOW_PROPERTY( "shadow" );
  63 const char * const UNDERLINE_PROPERTY( "underline" );
  64 const char * const OUTLINE_PROPERTY( "outline" );
  65 const char * const BACKGROUND_PROPERTY( "textBackground" );
  66
  67 const Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
  68
  69 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
  70   attribute mediump vec2 aPosition;\n
  71   uniform mediump mat4 uMvpMatrix;\n
  72   uniform mediump vec3 uSize;\n
  73   uniform mediump vec4 pixelArea;\n
  74
  75   uniform mediump mat4 uModelMatrix;\n
  76   uniform mediump mat4 uViewMatrix;\n
  77   uniform mediump mat4 uProjection;\n
  78
  79   varying mediump vec2 vTexCoord;\n
  80
  81   //Visual size and offset
  82   uniform mediump vec2 offset;\n
  83   uniform mediump vec2 size;\n
  84   uniform mediump vec4 offsetSizeMode;\n
  85   uniform mediump vec2 origin;\n
  86   uniform mediump vec2 anchorPoint;\n
  87
  88   vec4 ComputeVertexPosition()\n
  89   {\n
  90     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
  91     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
  92     return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
  93   }\n
  94
  95   void main()\n
  96   {\n
  97     mediump vec4 nonAlignedVertex = uViewMatrix*uModelMatrix*ComputeVertexPosition();\n
  98     mediump vec4 pixelAlignedVertex = vec4 ( floor(nonAlignedVertex.xyz), 1.0 );\n
  99     mediump vec4 vertexPosition = uProjection*pixelAlignedVertex;\n
 100
 101     vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
 102     gl_Position = vertexPosition;\n
 103   }\n
 104 );
 105
 106 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT = DALI_COMPOSE_SHADER(
 107   varying mediump vec2 vTexCoord;\n
 108   uniform sampler2D sTexture;\n
 109   uniform lowp vec4 uTextColorAnimatable;\n
 110   uniform lowp vec4 uColor;\n
 111   uniform lowp vec3 mixColor;\n
 112   uniform lowp float preMultipliedAlpha;\n
 113   \n
 114   void main()\n
 115   {\n
 116     mediump float textTexture = texture2D( sTexture, vTexCoord ).r;\n
 117
 118     // Set the color of the text to what it is animated to.
 119     gl_FragColor = uTextColorAnimatable * textTexture * uColor * vec4( mixColor, 1.0 );
 120   }\n
 121 );
 122
 123 const char* FRAGMENT_SHADER_MULTI_COLOR_TEXT = DALI_COMPOSE_SHADER(
 124   varying mediump vec2 vTexCoord;\n
 125   uniform sampler2D sTexture;\n
 126   uniform lowp vec4 uColor;\n
 127   uniform lowp vec3 mixColor;\n
 128   uniform lowp float preMultipliedAlpha;\n
 129   \n
 130   void main()\n
 131   {\n
 132     mediump vec4 textTexture = texture2D( sTexture, vTexCoord );\n
 133     textTexture.rgb *= mix( 1.0, textTexture.a, preMultipliedAlpha );\n
 134
 135     gl_FragColor = textTexture * uColor * vec4( mixColor, 1.0 );
 136   }\n
 137 );
 138
 139 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE = DALI_COMPOSE_SHADER(
 140   varying mediump vec2 vTexCoord;\n
 141   uniform sampler2D sTexture;\n
 142   uniform sampler2D sStyle;\n
 143   uniform lowp vec4 uTextColorAnimatable;\n
 144   uniform lowp vec4 uColor;\n
 145   uniform lowp vec3 mixColor;\n
 146   uniform lowp float preMultipliedAlpha;\n
 147   \n
 148   void main()\n
 149   {\n
 150     mediump float textTexture = texture2D( sTexture, vTexCoord ).r;\n
 151     mediump vec4 styleTexture = texture2D( sStyle, vTexCoord );\n
 152
 153     // Draw the text as overlay above the style
 154     gl_FragColor = ( uTextColorAnimatable * textTexture + styleTexture * ( 1.0 - uTextColorAnimatable.a * textTexture ) ) * uColor * vec4( mixColor, 1.0 );\n
 155   }\n
 156 );
 157
 158 const char* FRAGMENT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE = DALI_COMPOSE_SHADER(
 159   varying mediump vec2 vTexCoord;\n
 160   uniform sampler2D sTexture;\n
 161   uniform sampler2D sStyle;\n
 162   uniform lowp vec4 uColor;\n
 163   uniform lowp vec3 mixColor;\n
 164   uniform lowp float preMultipliedAlpha;\n
 165   \n
 166   void main()\n
 167   {\n
 168     mediump vec4 textTexture = texture2D( sTexture, vTexCoord );\n
 169     mediump vec4 styleTexture = texture2D( sStyle, vTexCoord );\n
 170     textTexture.rgb *= mix( 1.0, textTexture.a, preMultipliedAlpha );\n
 171
 172     // Draw the text as overlay above the style
 173     gl_FragColor = ( textTexture + styleTexture * ( 1.0 - textTexture.a ) ) * uColor * vec4( mixColor, 1.0 );\n
 174   }\n
 175 );
 176
 177 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI = DALI_COMPOSE_SHADER(
 178   varying mediump vec2 vTexCoord;\n
 179   uniform sampler2D sTexture;\n
 180   uniform sampler2D sMask;\n
 181   uniform lowp vec4 uTextColorAnimatable;\n
 182   uniform lowp vec4 uColor;\n
 183   uniform lowp vec3 mixColor;\n
 184   uniform lowp float preMultipliedAlpha;\n
 185   \n
 186   void main()\n
 187   {\n
 188     mediump vec4 textTexture = texture2D( sTexture, vTexCoord );\n
 189     mediump float maskTexture = texture2D( sMask, vTexCoord ).r;\n
 190
 191     // Set the color of non-transparent pixel in text to what it is animated to.
 192     // Markup text with multiple text colors are not animated (but can be supported later on if required).
 193     // Emoji color are not animated.
 194     mediump float vstep = step( 0.0001, textTexture.a );\n
 195     textTexture.rgb = mix( textTexture.rgb, uTextColorAnimatable.rgb, vstep * maskTexture ) * mix( 1.0, textTexture.a, preMultipliedAlpha );\n
 196
 197     // Draw the text as overlay above the style
 198     gl_FragColor = textTexture * uColor * vec4( mixColor, 1.0 );\n
 199   }\n
 200 );
 201
 202 const char* FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI = DALI_COMPOSE_SHADER(
 203   varying mediump vec2 vTexCoord;\n
 204   uniform sampler2D sTexture;\n
 205   uniform sampler2D sStyle;\n
 206   uniform sampler2D sMask;\n
 207   uniform lowp float uHasMultipleTextColors;\n
 208   uniform lowp vec4 uTextColorAnimatable;\n
 209   uniform lowp vec4 uColor;\n
 210   uniform lowp vec3 mixColor;\n
 211   uniform lowp float preMultipliedAlpha;\n
 212   \n
 213   void main()\n
 214   {\n
 215     mediump vec4 textTexture = texture2D( sTexture, vTexCoord );\n
 216     mediump vec4 styleTexture = texture2D( sStyle, vTexCoord );\n
 217     mediump float maskTexture = texture2D( sMask, vTexCoord ).r;\n
 218
 219     // Set the color of non-transparent pixel in text to what it is animated to.
 220     // Markup text with multiple text colors are not animated (but can be supported later on if required).
 221     // Emoji color are not animated.
 222     mediump float vstep = step( 0.0001, textTexture.a );\n
 223     textTexture.rgb = mix( textTexture.rgb, uTextColorAnimatable.rgb, vstep * maskTexture * ( 1.0 - uHasMultipleTextColors ) ) * mix( 1.0, textTexture.a, preMultipliedAlpha );\n
 224
 225     // Draw the text as overlay above the style
 226     gl_FragColor = ( textTexture + styleTexture * ( 1.0 - textTexture.a ) ) * uColor * vec4( mixColor, 1.0 );\n
 227   }\n
 228 );
 229
 230 /**
 231  * Return Property index for the given string key
 232  * param[in] stringKey the string index key
 233  * return the key as an index
 234  */
 235
 236 Dali::Property::Index StringKeyToIndexKey( const std::string& stringKey )
 237 {
 238   Dali::Property::Index result = Property::INVALID_KEY;
 239
 240   if( stringKey == VISUAL_TYPE )
 241   {
 242     result = Toolkit::Visual::Property::TYPE;
 243   }
 244   else if( stringKey == TEXT_PROPERTY )
 245   {
 246     result = Toolkit::TextVisual::Property::TEXT;
 247   }
 248   else if( stringKey == FONT_FAMILY_PROPERTY )
 249   {
 250     result = Toolkit::TextVisual::Property::FONT_FAMILY;
 251   }
 252   else if( stringKey == FONT_STYLE_PROPERTY )
 253   {
 254     result = Toolkit::TextVisual::Property::FONT_STYLE;
 255   }
 256   else if( stringKey == POINT_SIZE_PROPERTY )
 257   {
 258     result = Toolkit::TextVisual::Property::POINT_SIZE;
 259   }
 260   else if( stringKey == MULTI_LINE_PROPERTY )
 261   {
 262     result = Toolkit::TextVisual::Property::MULTI_LINE;
 263   }
 264   else if( stringKey == HORIZONTAL_ALIGNMENT_PROPERTY )
 265   {
 266     result = Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT;
 267   }
 268   else if( stringKey == VERTICAL_ALIGNMENT_PROPERTY )
 269   {
 270     result = Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT;
 271   }
 272   else if( stringKey == TEXT_COLOR_PROPERTY )
 273   {
 274     result = Toolkit::TextVisual::Property::TEXT_COLOR;
 275   }
 276   else if( stringKey == ENABLE_MARKUP_PROPERTY )
 277   {
 278     result = Toolkit::TextVisual::Property::ENABLE_MARKUP;
 279   }
 280   else if( stringKey == SHADOW_PROPERTY )
 281   {
 282     result = Toolkit::TextVisual::Property::SHADOW;
 283   }
 284   else if( stringKey == UNDERLINE_PROPERTY )
 285   {
 286     result = Toolkit::TextVisual::Property::UNDERLINE;
 287   }
 288   else if( stringKey == OUTLINE_PROPERTY )
 289   {
 290     result = Toolkit::DevelTextVisual::Property::OUTLINE;
 291   }
 292   else if( stringKey == BACKGROUND_PROPERTY )
 293   {
 294     result = Toolkit::DevelTextVisual::Property::BACKGROUND;
 295   }
 296
 297   return result;
 298 }
 299
 300 void TextColorConstraint( Vector4& current, const PropertyInputContainer& inputs )
 301 {
 302   Vector4 color = inputs[0]->GetVector4();
 303   current.r = color.r * color.a;
 304   current.g = color.g * color.a;
 305   current.b = color.b * color.a;
 306   current.a = color.a;
 307 }
 308
 309 void OpacityConstraint( float& current, const PropertyInputContainer& inputs )
 310 {
 311   current = inputs[0]->GetVector4().a;
 312 }
 313
 314 } // unnamed namespace
 315
 316 TextVisualPtr TextVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
 317 {
 318   TextVisualPtr TextVisualPtr( new TextVisual( factoryCache ) );
 319   TextVisualPtr->SetProperties( properties );
 320   return TextVisualPtr;
 321 }
 322
 323 void TextVisual::ConvertStringKeysToIndexKeys( Property::Map& propertyMap )
 324 {
 325   Property::Map outMap;
 326
 327   for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
 328   {
 329     const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
 330
 331     Property::Index indexKey = keyValue.first.indexKey;
 332
 333     if ( keyValue.first.type == Property::Key::STRING )
 334     {
 335       indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
 336     }
 337
 338     outMap.Insert( indexKey, keyValue.second );
 339   }
 340
 341   propertyMap = outMap;
 342 }
 343
 344 float TextVisual::GetHeightForWidth( float width )
 345 {
 346   return mController->GetHeightForWidth( width );
 347 }
 348
 349 void TextVisual::GetNaturalSize( Vector2& naturalSize )
 350 {
 351   naturalSize = mController->GetNaturalSize().GetVectorXY();
 352 }
 353
 354 void TextVisual::DoCreatePropertyMap( Property::Map& map ) const
 355 {
 356   Property::Value value;
 357
 358   map.Clear();
 359   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
 360
 361   std::string text;
 362   mController->GetText( text );
 363   map.Insert( Toolkit::TextVisual::Property::TEXT, text );
 364
 365   map.Insert( Toolkit::TextVisual::Property::FONT_FAMILY, mController->GetDefaultFontFamily() );
 366
 367   GetFontStyleProperty( mController, value, Text::FontStyle::DEFAULT );
 368   map.Insert( Toolkit::TextVisual::Property::FONT_STYLE, value );
 369
 370   map.Insert( Toolkit::TextVisual::Property::POINT_SIZE, mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ) );
 371
 372   map.Insert( Toolkit::TextVisual::Property::MULTI_LINE, mController->IsMultiLineEnabled() );
 373
 374   map.Insert( Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, mController->GetHorizontalAlignment() );
 375
 376   map.Insert( Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, mController->GetVerticalAlignment() );
 377
 378   map.Insert( Toolkit::TextVisual::Property::TEXT_COLOR, mController->GetDefaultColor() );
 379
 380   map.Insert( Toolkit::TextVisual::Property::ENABLE_MARKUP, mController->IsMarkupProcessorEnabled() );
 381
 382   GetShadowProperties( mController, value, Text::EffectStyle::DEFAULT );
 383   map.Insert( Toolkit::TextVisual::Property::SHADOW, value );
 384
 385   GetUnderlineProperties( mController, value, Text::EffectStyle::DEFAULT );
 386   map.Insert( Toolkit::TextVisual::Property::UNDERLINE, value );
 387
 388   GetOutlineProperties( mController, value, Text::EffectStyle::DEFAULT );
 389   map.Insert( Toolkit::DevelTextVisual::Property::OUTLINE, value );
 390
 391   GetBackgroundProperties( mController, value, Text::EffectStyle::DEFAULT );
 392   map.Insert( Toolkit::DevelTextVisual::Property::BACKGROUND, value );
 393 }
 394
 395 void TextVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 396 {
 397   map.Clear();
 398   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
 399   std::string text;
 400   mController->GetText( text );
 401   map.Insert( Toolkit::TextVisual::Property::TEXT, text );
 402 }
 403
 404
 405 TextVisual::TextVisual( VisualFactoryCache& factoryCache )
 406 : Visual::Base( factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ),
 407   mController( Text::Controller::New() ),
 408   mTypesetter( Text::Typesetter::New( mController->GetTextModel() ) ),
 409   mAnimatableTextColorPropertyIndex( Property::INVALID_INDEX ),
 410   mRendererUpdateNeeded( false )
 411 {
 412 }
 413
 414 TextVisual::~TextVisual()
 415 {
 416 }
 417
 418 void TextVisual::DoSetProperties( const Property::Map& propertyMap )
 419 {
 420   for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
 421   {
 422     const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
 423
 424     Property::Index indexKey = keyValue.first.indexKey;
 425
 426     if( keyValue.first.type == Property::Key::STRING )
 427     {
 428       indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
 429     }
 430
 431     DoSetProperty( indexKey, keyValue.second );
 432   }
 433
 434   // Elide the text if it exceeds the boundaries.
 435   mController->SetTextElideEnabled( true );
 436
 437   // Retrieve the layout engine to set the cursor's width.
 438   Text::Layout::Engine& engine = mController->GetLayoutEngine();
 439
 440   // Sets 0 as cursor's width.
 441   engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
 442 }
 443
 444 void TextVisual::DoSetOnStage( Actor& actor )
 445 {
 446   mControl = actor;
 447
 448   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 449   Shader shader = GetTextShader(mFactoryCache, TextType::SINGLE_COLOR_TEXT, TextType::NO_EMOJI, TextType::NO_STYLES);
 450
 451   mImpl->mRenderer = Renderer::New( geometry, shader );
 452   mImpl->mRenderer.SetProperty( Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::CONTENT );
 453
 454   // Enable the pre-multiplied alpha to improve the text quality
 455   EnablePreMultipliedAlpha(true);
 456
 457   const Vector4& defaultColor = mController->GetTextModel()->GetDefaultColor();
 458   Dali::Property::Index shaderTextColorIndex = mImpl->mRenderer.RegisterProperty( "uTextColorAnimatable", defaultColor );
 459
 460   if ( mAnimatableTextColorPropertyIndex != Property::INVALID_INDEX )
 461   {
 462     // Create constraint for the animatable text's color Property with uTextColorAnimatable in the renderer.
 463     if( shaderTextColorIndex != Property::INVALID_INDEX )
 464     {
 465       Constraint colorConstraint = Constraint::New<Vector4>( mImpl->mRenderer, shaderTextColorIndex, TextColorConstraint );
 466       colorConstraint.AddSource( Source( actor, mAnimatableTextColorPropertyIndex ) );
 467       colorConstraint.Apply();
 468
 469       Constraint opacityConstraint = Constraint::New< float >( mImpl->mRenderer, Dali::DevelRenderer::Property::OPACITY, OpacityConstraint );
 470       opacityConstraint.AddSource( Source( actor, mAnimatableTextColorPropertyIndex ) );
 471       opacityConstraint.Apply();
 472     }
 473   }
 474
 475   // Renderer needs textures and to be added to control
 476   mRendererUpdateNeeded = true;
 477
 478   UpdateRenderer();
 479 }
 480
 481 void TextVisual::DoSetOffStage( Actor& actor )
 482 {
 483   if( mImpl->mRenderer )
 484   {
 485     // Removes the renderer from the actor.
 486     actor.RemoveRenderer( mImpl->mRenderer );
 487
 488     RemoveTextureSet();
 489
 490     // Resets the renderer.
 491     mImpl->mRenderer.Reset();
 492   }
 493
 494   // Resets the control handle.
 495   mControl.Reset();
 496 }
 497
 498 void TextVisual::OnSetTransform()
 499 {
 500   UpdateRenderer();
 501 }
 502
 503 void TextVisual::DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
 504 {
 505   switch( index )
 506   {
 507     case Toolkit::TextVisual::Property::ENABLE_MARKUP:
 508     {
 509       const bool enableMarkup = propertyValue.Get<bool>();
 510       mController->SetMarkupProcessorEnabled( enableMarkup );
 511       break;
 512     }
 513     case Toolkit::TextVisual::Property::TEXT:
 514     {
 515       mController->SetText( propertyValue.Get<std::string>() );
 516       break;
 517     }
 518     case Toolkit::TextVisual::Property::FONT_FAMILY:
 519     {
 520       SetFontFamilyProperty( mController, propertyValue );
 521       break;
 522     }
 523     case Toolkit::TextVisual::Property::FONT_STYLE:
 524     {
 525       SetFontStyleProperty( mController, propertyValue, Text::FontStyle::DEFAULT );
 526       break;
 527     }
 528     case Toolkit::TextVisual::Property::POINT_SIZE:
 529     {
 530       const float pointSize = propertyValue.Get<float>();
 531       if( !Equals( mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ), pointSize ) )
 532       {
 533         mController->SetDefaultFontSize( pointSize, Text::Controller::POINT_SIZE );
 534       }
 535       break;
 536     }
 537     case Toolkit::TextVisual::Property::MULTI_LINE:
 538     {
 539       mController->SetMultiLineEnabled( propertyValue.Get<bool>() );
 540       break;
 541     }
 542     case Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT:
 543     {
 544       if( mController )
 545       {
 546         Text::HorizontalAlignment::Type alignment( static_cast< Text::HorizontalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
 547         if( Toolkit::Text::GetHorizontalAlignmentEnumeration( propertyValue, alignment ) )
 548         {
 549           mController->SetHorizontalAlignment( alignment );
 550         }
 551       }
 552       break;
 553     }
 554     case Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT:
 555     {
 556       if( mController )
 557       {
 558         Toolkit::Text::VerticalAlignment::Type alignment( static_cast< Text::VerticalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
 559         if( Toolkit::Text::GetVerticalAlignmentEnumeration( propertyValue, alignment) )
 560         {
 561           mController->SetVerticalAlignment( alignment );
 562         }
 563       }
 564       break;
 565     }
 566     case Toolkit::TextVisual::Property::TEXT_COLOR:
 567     {
 568       const Vector4& textColor = propertyValue.Get< Vector4 >();
 569       if( mController->GetDefaultColor() != textColor )
 570       {
 571         mController->SetDefaultColor( textColor );
 572       }
 573       break;
 574     }
 575     case Toolkit::TextVisual::Property::SHADOW:
 576     {
 577       SetShadowProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 578       break;
 579     }
 580     case Toolkit::TextVisual::Property::UNDERLINE:
 581     {
 582       SetUnderlineProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 583       break;
 584     }
 585     case Toolkit::DevelTextVisual::Property::OUTLINE:
 586     {
 587       SetOutlineProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 588       break;
 589     }
 590     case Toolkit::DevelTextVisual::Property::BACKGROUND:
 591     {
 592       SetBackgroundProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 593       break;
 594     }
 595   }
 596 }
 597
 598 void TextVisual::UpdateRenderer()
 599 {
 600   Actor control = mControl.GetHandle();
 601   if( !control )
 602   {
 603     // Nothing to do.
 604     return;
 605   }
 606
 607   // Calculates the size to be used to relayout.
 608   Vector2 relayoutSize;
 609
 610   const bool isWidthRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.z ) < Math::MACHINE_EPSILON_1000;
 611   const bool isHeightRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.w ) < Math::MACHINE_EPSILON_1000;
 612
 613   // Round the size and offset to avoid pixel alignement issues.
 614   relayoutSize.width = floorf( 0.5f + ( isWidthRelative ? mImpl->mControlSize.width * mImpl->mTransform.mSize.x : mImpl->mTransform.mSize.width ) );
 615   relayoutSize.height = floorf( 0.5f + ( isHeightRelative ? mImpl->mControlSize.height * mImpl->mTransform.mSize.y : mImpl->mTransform.mSize.height ) );
 616
 617   std::string text;
 618   mController->GetText( text );
 619
 620   if( ( fabsf( relayoutSize.width ) < Math::MACHINE_EPSILON_1000 ) || ( fabsf( relayoutSize.height ) < Math::MACHINE_EPSILON_1000 ) || text.empty() )
 621   {
 622     // Removes the texture set.
 623     RemoveTextureSet();
 624
 625     // Remove any renderer previously set.
 626     if( mImpl->mRenderer )
 627     {
 628       control.RemoveRenderer( mImpl->mRenderer );
 629     }
 630
 631     // Nothing else to do if the relayout size is zero.
 632     ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 633     return;
 634   }
 635
 636   const Text::Controller::UpdateTextType updateTextType = mController->Relayout( relayoutSize );
 637
 638   if( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType )
 639    || mRendererUpdateNeeded )
 640   {
 641     mRendererUpdateNeeded = false;
 642
 643     // Removes the texture set.
 644     RemoveTextureSet();
 645
 646     // Remove any renderer previously set.
 647     if( mImpl->mRenderer )
 648     {
 649       control.RemoveRenderer( mImpl->mRenderer );
 650     }
 651
 652     if( ( relayoutSize.width > Math::MACHINE_EPSILON_1000 ) &&
 653         ( relayoutSize.height > Math::MACHINE_EPSILON_1000 ) )
 654     {
 655       // Check whether it is a markup text with multiple text colors
 656       const Vector4* const colorsBuffer = mController->GetTextModel()->GetColors();
 657       bool hasMultipleTextColors = ( NULL != colorsBuffer );
 658
 659       // Check whether the text contains any color glyph
 660       bool containsColorGlyph = false;
 661
 662       TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
 663       const Text::GlyphInfo* const glyphsBuffer = mController->GetTextModel()->GetGlyphs();
 664       const Text::Length numberOfGlyphs = mController->GetTextModel()->GetNumberOfGlyphs();
 665       for ( Text::Length glyphIndex = 0; glyphIndex < numberOfGlyphs; glyphIndex++ )
 666       {
 667         // Retrieve the glyph's info.
 668         const Text::GlyphInfo* const glyphInfo = glyphsBuffer + glyphIndex;
 669
 670         // Whether the current glyph is a color one.
 671         if( fontClient.IsColorGlyph( glyphInfo->fontId, glyphInfo->index ) )
 672         {
 673           containsColorGlyph = true;
 674           break;
 675         }
 676       }
 677
 678       // Check whether the text contains any style colors (e.g. underline color, shadow color, etc.)
 679
 680       bool shadowEnabled = false;
 681       const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
 682       if ( fabsf( shadowOffset.x ) > Math::MACHINE_EPSILON_1 || fabsf( shadowOffset.y ) > Math::MACHINE_EPSILON_1 )
 683       {
 684         shadowEnabled = true;
 685       }
 686
 687       const bool underlineEnabled = mController->GetTextModel()->IsUnderlineEnabled();
 688       const bool outlineEnabled = ( mController->GetTextModel()->GetOutlineWidth() > Math::MACHINE_EPSILON_1 );
 689       const bool backgroundEnabled = mController->GetTextModel()->IsBackgroundEnabled();;
 690
 691       const bool styleEnabled = ( shadowEnabled || underlineEnabled || outlineEnabled || backgroundEnabled );
 692
 693       TextureSet textureSet = GetTextTexture( relayoutSize, hasMultipleTextColors, containsColorGlyph, styleEnabled );
 694       mImpl->mRenderer.SetTextures( textureSet );
 695
 696       Shader shader = GetTextShader( mFactoryCache, hasMultipleTextColors, containsColorGlyph, styleEnabled );
 697       mImpl->mRenderer.SetShader(shader);
 698
 699       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 700
 701       mImpl->mRenderer.RegisterProperty( "uHasMultipleTextColors", static_cast<float>( hasMultipleTextColors ) );
 702
 703       mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON);
 704
 705       //Register transform properties
 706       mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 707
 708       control.AddRenderer( mImpl->mRenderer );
 709
 710       // Text rendered and ready to display
 711       ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 712     }
 713   }
 714 }
 715
 716 void TextVisual::RemoveTextureSet()
 717 {
 718   if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
 719   {
 720     // Removes the text's image from the texture atlas.
 721     Vector4 atlasRect;
 722
 723     const Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
 724     if( index != Property::INVALID_INDEX )
 725     {
 726       const Property::Value& atlasRectValue = mImpl->mRenderer.GetProperty( index );
 727       atlasRectValue.Get( atlasRect );
 728
 729       const TextureSet& textureSet = mImpl->mRenderer.GetTextures();
 730       mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
 731     }
 732   }
 733 }
 734
 735 TextureSet TextVisual::GetTextTexture( const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled )
 736 {
 737   // Filter mode needs to be set to linear to produce better quality while scaling.
 738   Sampler sampler = Sampler::New();
 739   sampler.SetFilterMode( FilterMode::LINEAR, FilterMode::LINEAR );
 740
 741   TextureSet textureSet = TextureSet::New();
 742
 743   // Create RGBA texture if the text contains emojis or multiple text colors, otherwise L8 texture
 744   Pixel::Format textPixelFormat = ( containsColorGlyph || hasMultipleTextColors ) ? Pixel::RGBA8888 : Pixel::L8;
 745
 746   // Check the text direction
 747   Toolkit::DevelText::TextDirection::Type textDirection = mController->GetTextDirection();
 748
 749   // Create a texture for the text without any styles
 750   PixelData data = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_NO_STYLES, false, textPixelFormat );
 751
 752   // It may happen the image atlas can't handle a pixel data it exceeds the maximum size.
 753   // In that case, create a texture. TODO: should tile the text.
 754
 755   Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
 756                                   data.GetPixelFormat(),
 757                                   data.GetWidth(),
 758                                   data.GetHeight() );
 759
 760   texture.Upload( data );
 761
 762   textureSet.SetTexture( 0u, texture );
 763   textureSet.SetSampler( 0u, sampler );
 764
 765   if ( styleEnabled )
 766   {
 767     // Create RGBA texture for all the text styles (without the text itself)
 768     PixelData styleData = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_NO_TEXT, false, Pixel::RGBA8888 );
 769
 770     Texture styleTexture = Texture::New( Dali::TextureType::TEXTURE_2D,
 771                                          styleData.GetPixelFormat(),
 772                                          styleData.GetWidth(),
 773                                          styleData.GetHeight() );
 774
 775     styleTexture.Upload( styleData );
 776
 777     textureSet.SetTexture( 1u, styleTexture );
 778     textureSet.SetSampler( 1u, sampler );
 779   }
 780
 781   if ( containsColorGlyph && !hasMultipleTextColors )
 782   {
 783     // Create a L8 texture as a mask to avoid color glyphs (e.g. emojis) to be affected by text color animation
 784     PixelData maskData = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_MASK, false, Pixel::L8 );
 785
 786     Texture maskTexture = Texture::New( Dali::TextureType::TEXTURE_2D,
 787                                         maskData.GetPixelFormat(),
 788                                         maskData.GetWidth(),
 789                                         maskData.GetHeight() );
 790
 791     maskTexture.Upload( maskData );
 792
 793     if ( !styleEnabled )
 794     {
 795       textureSet.SetTexture( 1u, maskTexture );
 796       textureSet.SetSampler( 1u, sampler );
 797     }
 798     else
 799     {
 800       textureSet.SetTexture( 2u, maskTexture );
 801       textureSet.SetSampler( 2u, sampler );
 802     }
 803   }
 804
 805   return textureSet;
 806 }
 807
 808 Shader TextVisual::GetTextShader( VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled )
 809 {
 810   Shader shader;
 811
 812   if( hasMultipleTextColors && !styleEnabled )
 813   {
 814     // We don't animate text color if the text contains multiple colors
 815     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT );
 816     if( !shader )
 817     {
 818       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_MULTI_COLOR_TEXT );
 819       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 820       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT, shader );
 821     }
 822   }
 823   else if( hasMultipleTextColors && styleEnabled )
 824   {
 825     // We don't animate text color if the text contains multiple colors
 826     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE );
 827     if( !shader )
 828     {
 829       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE );
 830       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 831       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE, shader );
 832     }
 833   }
 834   else if( !hasMultipleTextColors && !containsColorGlyph && !styleEnabled )
 835   {
 836     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT );
 837     if( !shader )
 838     {
 839       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT );
 840       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 841       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT, shader );
 842     }
 843   }
 844   else if( !hasMultipleTextColors && !containsColorGlyph && styleEnabled )
 845   {
 846     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE );
 847     if( !shader )
 848     {
 849       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE );
 850       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 851       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE, shader );
 852     }
 853   }
 854   else if( !hasMultipleTextColors && containsColorGlyph && !styleEnabled )
 855   {
 856     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI );
 857     if( !shader )
 858     {
 859       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI );
 860       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 861       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI, shader );
 862     }
 863   }
 864   else // if( !hasMultipleTextColors && containsColorGlyph && styleEnabled )
 865   {
 866     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI );
 867     if( !shader )
 868     {
 869       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI );
 870       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 871       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI, shader );
 872     }
 873   }
 874
 875   return shader;
 876 }
 877
 878 } // namespace Internal
 879
 880 } // namespace Toolkit
 881
 882 } // namespace Dali