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 - 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 OpacityConstraint( float& current, const PropertyInputContainer& inputs )
 301 {
 302   current = inputs[0]->GetVector4().a;
 303 }
 304
 305 } // unnamed namespace
 306
 307 TextVisualPtr TextVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
 308 {
 309   TextVisualPtr TextVisualPtr( new TextVisual( factoryCache ) );
 310   TextVisualPtr->SetProperties( properties );
 311   return TextVisualPtr;
 312 }
 313
 314 void TextVisual::ConvertStringKeysToIndexKeys( Property::Map& propertyMap )
 315 {
 316   Property::Map outMap;
 317
 318   for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
 319   {
 320     const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
 321
 322     Property::Index indexKey = keyValue.first.indexKey;
 323
 324     if ( keyValue.first.type == Property::Key::STRING )
 325     {
 326       indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
 327     }
 328
 329     outMap.Insert( indexKey, keyValue.second );
 330   }
 331
 332   propertyMap = outMap;
 333 }
 334
 335 float TextVisual::GetHeightForWidth( float width )
 336 {
 337   return mController->GetHeightForWidth( width );
 338 }
 339
 340 void TextVisual::GetNaturalSize( Vector2& naturalSize )
 341 {
 342   naturalSize = mController->GetNaturalSize().GetVectorXY();
 343 }
 344
 345 void TextVisual::DoCreatePropertyMap( Property::Map& map ) const
 346 {
 347   Property::Value value;
 348
 349   map.Clear();
 350   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
 351
 352   std::string text;
 353   mController->GetText( text );
 354   map.Insert( Toolkit::TextVisual::Property::TEXT, text );
 355
 356   map.Insert( Toolkit::TextVisual::Property::FONT_FAMILY, mController->GetDefaultFontFamily() );
 357
 358   GetFontStyleProperty( mController, value, Text::FontStyle::DEFAULT );
 359   map.Insert( Toolkit::TextVisual::Property::FONT_STYLE, value );
 360
 361   map.Insert( Toolkit::TextVisual::Property::POINT_SIZE, mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ) );
 362
 363   map.Insert( Toolkit::TextVisual::Property::MULTI_LINE, mController->IsMultiLineEnabled() );
 364
 365   map.Insert( Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, mController->GetHorizontalAlignment() );
 366
 367   map.Insert( Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, mController->GetVerticalAlignment() );
 368
 369   map.Insert( Toolkit::TextVisual::Property::TEXT_COLOR, mController->GetDefaultColor() );
 370
 371   map.Insert( Toolkit::TextVisual::Property::ENABLE_MARKUP, mController->IsMarkupProcessorEnabled() );
 372
 373   GetShadowProperties( mController, value, Text::EffectStyle::DEFAULT );
 374   map.Insert( Toolkit::TextVisual::Property::SHADOW, value );
 375
 376   GetUnderlineProperties( mController, value, Text::EffectStyle::DEFAULT );
 377   map.Insert( Toolkit::TextVisual::Property::UNDERLINE, value );
 378
 379   GetOutlineProperties( mController, value, Text::EffectStyle::DEFAULT );
 380   map.Insert( Toolkit::DevelTextVisual::Property::OUTLINE, value );
 381
 382   GetBackgroundProperties( mController, value, Text::EffectStyle::DEFAULT );
 383   map.Insert( Toolkit::DevelTextVisual::Property::BACKGROUND, value );
 384 }
 385
 386 void TextVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
 387 {
 388   map.Clear();
 389   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
 390   std::string text;
 391   mController->GetText( text );
 392   map.Insert( Toolkit::TextVisual::Property::TEXT, text );
 393 }
 394
 395
 396 TextVisual::TextVisual( VisualFactoryCache& factoryCache )
 397 : Visual::Base( factoryCache, Visual::FittingMode::FIT_KEEP_ASPECT_RATIO ),
 398   mController( Text::Controller::New() ),
 399   mTypesetter( Text::Typesetter::New( mController->GetTextModel() ) ),
 400   mAnimatableTextColorPropertyIndex( Property::INVALID_INDEX ),
 401   mRendererUpdateNeeded( false )
 402 {
 403 }
 404
 405 TextVisual::~TextVisual()
 406 {
 407 }
 408
 409 void TextVisual::DoSetProperties( const Property::Map& propertyMap )
 410 {
 411   for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
 412   {
 413     const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
 414
 415     Property::Index indexKey = keyValue.first.indexKey;
 416
 417     if( keyValue.first.type == Property::Key::STRING )
 418     {
 419       indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
 420     }
 421
 422     DoSetProperty( indexKey, keyValue.second );
 423   }
 424
 425   // Elide the text if it exceeds the boundaries.
 426   mController->SetTextElideEnabled( true );
 427
 428   // Retrieve the layout engine to set the cursor's width.
 429   Text::Layout::Engine& engine = mController->GetLayoutEngine();
 430
 431   // Sets 0 as cursor's width.
 432   engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
 433 }
 434
 435 void TextVisual::DoSetOnStage( Actor& actor )
 436 {
 437   mControl = actor;
 438
 439   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 440   Shader shader = GetTextShader(mFactoryCache, TextType::SINGLE_COLOR_TEXT, TextType::NO_EMOJI, TextType::NO_STYLES);
 441
 442   mImpl->mRenderer = Renderer::New( geometry, shader );
 443   mImpl->mRenderer.SetProperty( Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::CONTENT );
 444
 445   // Enable the pre-multiplied alpha to improve the text quality
 446   EnablePreMultipliedAlpha(true);
 447
 448   const Vector4& defaultColor = mController->GetTextModel()->GetDefaultColor();
 449   Dali::Property::Index shaderTextColorIndex = mImpl->mRenderer.RegisterProperty( "uTextColorAnimatable", defaultColor );
 450
 451   if ( mAnimatableTextColorPropertyIndex != Property::INVALID_INDEX )
 452   {
 453     // Create constraint for the animatable text's color Property with uTextColorAnimatable in the renderer.
 454     if( shaderTextColorIndex != Property::INVALID_INDEX )
 455     {
 456       Constraint colorConstraint = Constraint::New<Vector4>( mImpl->mRenderer, shaderTextColorIndex, EqualToConstraint() );
 457       colorConstraint.AddSource( Source( actor, mAnimatableTextColorPropertyIndex ) );
 458       colorConstraint.Apply();
 459
 460       Constraint opacityConstraint = Constraint::New< float >( mImpl->mRenderer, Dali::DevelRenderer::Property::OPACITY, OpacityConstraint );
 461       opacityConstraint.AddSource( Source( actor, mAnimatableTextColorPropertyIndex ) );
 462       opacityConstraint.Apply();
 463     }
 464   }
 465
 466   // Renderer needs textures and to be added to control
 467   mRendererUpdateNeeded = true;
 468
 469   UpdateRenderer();
 470 }
 471
 472 void TextVisual::DoSetOffStage( Actor& actor )
 473 {
 474   if( mImpl->mRenderer )
 475   {
 476     // Removes the renderer from the actor.
 477     actor.RemoveRenderer( mImpl->mRenderer );
 478
 479     RemoveTextureSet();
 480
 481     // Resets the renderer.
 482     mImpl->mRenderer.Reset();
 483   }
 484
 485   // Resets the control handle.
 486   mControl.Reset();
 487 }
 488
 489 void TextVisual::OnSetTransform()
 490 {
 491   UpdateRenderer();
 492 }
 493
 494 void TextVisual::DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
 495 {
 496   switch( index )
 497   {
 498     case Toolkit::TextVisual::Property::ENABLE_MARKUP:
 499     {
 500       const bool enableMarkup = propertyValue.Get<bool>();
 501       mController->SetMarkupProcessorEnabled( enableMarkup );
 502       break;
 503     }
 504     case Toolkit::TextVisual::Property::TEXT:
 505     {
 506       mController->SetText( propertyValue.Get<std::string>() );
 507       break;
 508     }
 509     case Toolkit::TextVisual::Property::FONT_FAMILY:
 510     {
 511       SetFontFamilyProperty( mController, propertyValue );
 512       break;
 513     }
 514     case Toolkit::TextVisual::Property::FONT_STYLE:
 515     {
 516       SetFontStyleProperty( mController, propertyValue, Text::FontStyle::DEFAULT );
 517       break;
 518     }
 519     case Toolkit::TextVisual::Property::POINT_SIZE:
 520     {
 521       const float pointSize = propertyValue.Get<float>();
 522       if( !Equals( mController->GetDefaultFontSize( Text::Controller::POINT_SIZE ), pointSize ) )
 523       {
 524         mController->SetDefaultFontSize( pointSize, Text::Controller::POINT_SIZE );
 525       }
 526       break;
 527     }
 528     case Toolkit::TextVisual::Property::MULTI_LINE:
 529     {
 530       mController->SetMultiLineEnabled( propertyValue.Get<bool>() );
 531       break;
 532     }
 533     case Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT:
 534     {
 535       if( mController )
 536       {
 537         Text::HorizontalAlignment::Type alignment( static_cast< Text::HorizontalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
 538         if( Toolkit::Text::GetHorizontalAlignmentEnumeration( propertyValue, alignment ) )
 539         {
 540           mController->SetHorizontalAlignment( alignment );
 541         }
 542       }
 543       break;
 544     }
 545     case Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT:
 546     {
 547       if( mController )
 548       {
 549         Toolkit::Text::VerticalAlignment::Type alignment( static_cast< Text::VerticalAlignment::Type >( -1 ) ); // Set to invalid value to ensure a valid mode does get set
 550         if( Toolkit::Text::GetVerticalAlignmentEnumeration( propertyValue, alignment) )
 551         {
 552           mController->SetVerticalAlignment( alignment );
 553         }
 554       }
 555       break;
 556     }
 557     case Toolkit::TextVisual::Property::TEXT_COLOR:
 558     {
 559       const Vector4& textColor = propertyValue.Get< Vector4 >();
 560       if( mController->GetDefaultColor() != textColor )
 561       {
 562         mController->SetDefaultColor( textColor );
 563       }
 564       break;
 565     }
 566     case Toolkit::TextVisual::Property::SHADOW:
 567     {
 568       SetShadowProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 569       break;
 570     }
 571     case Toolkit::TextVisual::Property::UNDERLINE:
 572     {
 573       SetUnderlineProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 574       break;
 575     }
 576     case Toolkit::DevelTextVisual::Property::OUTLINE:
 577     {
 578       SetOutlineProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 579       break;
 580     }
 581     case Toolkit::DevelTextVisual::Property::BACKGROUND:
 582     {
 583       SetBackgroundProperties( mController, propertyValue, Text::EffectStyle::DEFAULT );
 584       break;
 585     }
 586   }
 587 }
 588
 589 void TextVisual::UpdateRenderer()
 590 {
 591   Actor control = mControl.GetHandle();
 592   if( !control )
 593   {
 594     // Nothing to do.
 595     return;
 596   }
 597
 598   // Calculates the size to be used to relayout.
 599   Vector2 relayoutSize;
 600
 601   const bool isWidthRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.z ) < Math::MACHINE_EPSILON_1000;
 602   const bool isHeightRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.w ) < Math::MACHINE_EPSILON_1000;
 603
 604   // Round the size and offset to avoid pixel alignement issues.
 605   relayoutSize.width = floorf( 0.5f + ( isWidthRelative ? mImpl->mControlSize.width * mImpl->mTransform.mSize.x : mImpl->mTransform.mSize.width ) );
 606   relayoutSize.height = floorf( 0.5f + ( isHeightRelative ? mImpl->mControlSize.height * mImpl->mTransform.mSize.y : mImpl->mTransform.mSize.height ) );
 607
 608   std::string text;
 609   mController->GetText( text );
 610
 611   if( ( fabsf( relayoutSize.width ) < Math::MACHINE_EPSILON_1000 ) || ( fabsf( relayoutSize.height ) < Math::MACHINE_EPSILON_1000 ) || text.empty() )
 612   {
 613     // Removes the texture set.
 614     RemoveTextureSet();
 615
 616     // Remove any renderer previously set.
 617     if( mImpl->mRenderer )
 618     {
 619       control.RemoveRenderer( mImpl->mRenderer );
 620     }
 621
 622     // Nothing else to do if the relayout size is zero.
 623     ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 624     return;
 625   }
 626
 627   const Text::Controller::UpdateTextType updateTextType = mController->Relayout( relayoutSize );
 628
 629   if( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType )
 630    || mRendererUpdateNeeded )
 631   {
 632     mRendererUpdateNeeded = false;
 633
 634     // Removes the texture set.
 635     RemoveTextureSet();
 636
 637     // Remove any renderer previously set.
 638     if( mImpl->mRenderer )
 639     {
 640       control.RemoveRenderer( mImpl->mRenderer );
 641     }
 642
 643     if( ( relayoutSize.width > Math::MACHINE_EPSILON_1000 ) &&
 644         ( relayoutSize.height > Math::MACHINE_EPSILON_1000 ) )
 645     {
 646       // Check whether it is a markup text with multiple text colors
 647       const Vector4* const colorsBuffer = mController->GetTextModel()->GetColors();
 648       bool hasMultipleTextColors = ( NULL != colorsBuffer );
 649
 650       // Check whether the text contains any color glyph
 651       bool containsColorGlyph = false;
 652
 653       TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
 654       const Text::GlyphInfo* const glyphsBuffer = mController->GetTextModel()->GetGlyphs();
 655       const Text::Length numberOfGlyphs = mController->GetTextModel()->GetNumberOfGlyphs();
 656       for ( Text::Length glyphIndex = 0; glyphIndex < numberOfGlyphs; glyphIndex++ )
 657       {
 658         // Retrieve the glyph's info.
 659         const Text::GlyphInfo* const glyphInfo = glyphsBuffer + glyphIndex;
 660
 661         // Whether the current glyph is a color one.
 662         if( fontClient.IsColorGlyph( glyphInfo->fontId, glyphInfo->index ) )
 663         {
 664           containsColorGlyph = true;
 665           break;
 666         }
 667       }
 668
 669       // Check whether the text contains any style colors (e.g. underline color, shadow color, etc.)
 670
 671       bool shadowEnabled = false;
 672       const Vector2& shadowOffset = mController->GetTextModel()->GetShadowOffset();
 673       if ( fabsf( shadowOffset.x ) > Math::MACHINE_EPSILON_1 || fabsf( shadowOffset.y ) > Math::MACHINE_EPSILON_1 )
 674       {
 675         shadowEnabled = true;
 676       }
 677
 678       const bool underlineEnabled = mController->GetTextModel()->IsUnderlineEnabled();
 679       const bool outlineEnabled = ( mController->GetTextModel()->GetOutlineWidth() > Math::MACHINE_EPSILON_1 );
 680       const bool backgroundEnabled = mController->GetTextModel()->IsBackgroundEnabled();;
 681
 682       const bool styleEnabled = ( shadowEnabled || underlineEnabled || outlineEnabled || backgroundEnabled );
 683
 684       TextureSet textureSet = GetTextTexture( relayoutSize, hasMultipleTextColors, containsColorGlyph, styleEnabled );
 685       mImpl->mRenderer.SetTextures( textureSet );
 686
 687       Shader shader = GetTextShader( mFactoryCache, hasMultipleTextColors, containsColorGlyph, styleEnabled );
 688       mImpl->mRenderer.SetShader(shader);
 689
 690       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 691
 692       mImpl->mRenderer.RegisterProperty( "uHasMultipleTextColors", static_cast<float>( hasMultipleTextColors ) );
 693
 694       mImpl->mRenderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON);
 695
 696       //Register transform properties
 697       mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 698
 699       control.AddRenderer( mImpl->mRenderer );
 700
 701       // Text rendered and ready to display
 702       ResourceReady( Toolkit::Visual::ResourceStatus::READY );
 703     }
 704   }
 705 }
 706
 707 void TextVisual::RemoveTextureSet()
 708 {
 709   if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
 710   {
 711     // Removes the text's image from the texture atlas.
 712     Vector4 atlasRect;
 713
 714     const Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
 715     if( index != Property::INVALID_INDEX )
 716     {
 717       const Property::Value& atlasRectValue = mImpl->mRenderer.GetProperty( index );
 718       atlasRectValue.Get( atlasRect );
 719
 720       const TextureSet& textureSet = mImpl->mRenderer.GetTextures();
 721       mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
 722     }
 723   }
 724 }
 725
 726 TextureSet TextVisual::GetTextTexture( const Vector2& size, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled )
 727 {
 728   // Filter mode needs to be set to linear to produce better quality while scaling.
 729   Sampler sampler = Sampler::New();
 730   sampler.SetFilterMode( FilterMode::LINEAR, FilterMode::LINEAR );
 731
 732   TextureSet textureSet = TextureSet::New();
 733
 734   // Create RGBA texture if the text contains emojis or multiple text colors, otherwise L8 texture
 735   Pixel::Format textPixelFormat = ( containsColorGlyph || hasMultipleTextColors ) ? Pixel::RGBA8888 : Pixel::L8;
 736
 737   // Check the text direction
 738   Toolkit::DevelText::TextDirection::Type textDirection = mController->GetTextDirection();
 739
 740   // Create a texture for the text without any styles
 741   PixelData data = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_NO_STYLES, false, textPixelFormat );
 742
 743   // It may happen the image atlas can't handle a pixel data it exceeds the maximum size.
 744   // In that case, create a texture. TODO: should tile the text.
 745
 746   Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
 747                                   data.GetPixelFormat(),
 748                                   data.GetWidth(),
 749                                   data.GetHeight() );
 750
 751   texture.Upload( data );
 752
 753   textureSet.SetTexture( 0u, texture );
 754   textureSet.SetSampler( 0u, sampler );
 755
 756   if ( styleEnabled )
 757   {
 758     // Create RGBA texture for all the text styles (without the text itself)
 759     PixelData styleData = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_NO_TEXT, false, Pixel::RGBA8888 );
 760
 761     Texture styleTexture = Texture::New( Dali::TextureType::TEXTURE_2D,
 762                                          styleData.GetPixelFormat(),
 763                                          styleData.GetWidth(),
 764                                          styleData.GetHeight() );
 765
 766     styleTexture.Upload( styleData );
 767
 768     textureSet.SetTexture( 1u, styleTexture );
 769     textureSet.SetSampler( 1u, sampler );
 770   }
 771
 772   if ( containsColorGlyph && !hasMultipleTextColors )
 773   {
 774     // Create a L8 texture as a mask to avoid color glyphs (e.g. emojis) to be affected by text color animation
 775     PixelData maskData = mTypesetter->Render( size, textDirection, Text::Typesetter::RENDER_MASK, false, Pixel::L8 );
 776
 777     Texture maskTexture = Texture::New( Dali::TextureType::TEXTURE_2D,
 778                                         maskData.GetPixelFormat(),
 779                                         maskData.GetWidth(),
 780                                         maskData.GetHeight() );
 781
 782     maskTexture.Upload( maskData );
 783
 784     if ( !styleEnabled )
 785     {
 786       textureSet.SetTexture( 1u, maskTexture );
 787       textureSet.SetSampler( 1u, sampler );
 788     }
 789     else
 790     {
 791       textureSet.SetTexture( 2u, maskTexture );
 792       textureSet.SetSampler( 2u, sampler );
 793     }
 794   }
 795
 796   return textureSet;
 797 }
 798
 799 Shader TextVisual::GetTextShader( VisualFactoryCache& factoryCache, bool hasMultipleTextColors, bool containsColorGlyph, bool styleEnabled )
 800 {
 801   Shader shader;
 802
 803   if( hasMultipleTextColors && !styleEnabled )
 804   {
 805     // We don't animate text color if the text contains multiple colors
 806     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT );
 807     if( !shader )
 808     {
 809       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_MULTI_COLOR_TEXT );
 810       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 811       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT, shader );
 812     }
 813   }
 814   else if( hasMultipleTextColors && styleEnabled )
 815   {
 816     // We don't animate text color if the text contains multiple colors
 817     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE );
 818     if( !shader )
 819     {
 820       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE );
 821       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 822       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_MULTI_COLOR_TEXT_WITH_STYLE, shader );
 823     }
 824   }
 825   else if( !hasMultipleTextColors && !containsColorGlyph && !styleEnabled )
 826   {
 827     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT );
 828     if( !shader )
 829     {
 830       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT );
 831       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 832       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT, shader );
 833     }
 834   }
 835   else if( !hasMultipleTextColors && !containsColorGlyph && styleEnabled )
 836   {
 837     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE );
 838     if( !shader )
 839     {
 840       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE );
 841       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 842       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE, shader );
 843     }
 844   }
 845   else if( !hasMultipleTextColors && containsColorGlyph && !styleEnabled )
 846   {
 847     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI );
 848     if( !shader )
 849     {
 850       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI );
 851       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 852       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_EMOJI, shader );
 853     }
 854   }
 855   else // if( !hasMultipleTextColors && containsColorGlyph && styleEnabled )
 856   {
 857     shader = factoryCache.GetShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI );
 858     if( !shader )
 859     {
 860       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI );
 861       shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 862       factoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER_SINGLE_COLOR_TEXT_WITH_STYLE_AND_EMOJI, shader );
 863     }
 864   }
 865
 866   return shader;
 867 }
 868
 869 } // namespace Internal
 870
 871 } // namespace Toolkit
 872
 873 } // namespace Dali