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