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

   1 /*
   2  * Copyright (c) 2016 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 // INTERNAL HEADER
  22 #include <dali-toolkit/devel-api/visuals/text-visual-properties.h>
  23 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
  24 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
  25 #include <dali-toolkit/internal/visuals/image-atlas-manager.h>
  26 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  27 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
  28 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
  29 #include <dali-toolkit/internal/text/text-font-style.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Internal
  38 {
  39
  40 namespace
  41 {
  42
  43 // Property names - common properties defined in visual-string-constants.h/cpp
  44 const char * const FONT_FAMILY_PROPERTY( "fontFamily" );
  45 const char * const FONT_STYLE_PROPERTY( "fontStyle" );
  46 const char * const POINT_SIZE_PROPERTY( "pointSize" );
  47 const char * const MULTI_LINE_PROPERTY( "multiLine" );
  48 const char * const HORIZONTAL_ALIGNMENT_PROPERTY( "horizontalAlignment" );
  49 const char * const VERTICAL_ALIGNMENT_PROPERTY( "verticalAlignment" );
  50 const char * const TEXT_COLOR_PROPERTY( "textColor" );
  51 const char * const ENABLE_MARKUP_PROPERTY( "enableMarkup" );
  52
  53 const Scripting::StringEnum HORIZONTAL_ALIGNMENT_STRING_TABLE[] =
  54 {
  55   { "BEGIN",  Toolkit::Text::Layout::HORIZONTAL_ALIGN_BEGIN  },
  56   { "CENTER", Toolkit::Text::Layout::HORIZONTAL_ALIGN_CENTER },
  57   { "END",    Toolkit::Text::Layout::HORIZONTAL_ALIGN_END    },
  58 };
  59 const unsigned int HORIZONTAL_ALIGNMENT_STRING_TABLE_COUNT = sizeof( HORIZONTAL_ALIGNMENT_STRING_TABLE ) / sizeof( HORIZONTAL_ALIGNMENT_STRING_TABLE[0] );
  60
  61 const Scripting::StringEnum VERTICAL_ALIGNMENT_STRING_TABLE[] =
  62 {
  63   { "TOP",    Toolkit::Text::Layout::VERTICAL_ALIGN_TOP    },
  64   { "CENTER", Toolkit::Text::Layout::VERTICAL_ALIGN_CENTER },
  65   { "BOTTOM", Toolkit::Text::Layout::VERTICAL_ALIGN_BOTTOM },
  66 };
  67 const unsigned int VERTICAL_ALIGNMENT_STRING_TABLE_COUNT = sizeof( VERTICAL_ALIGNMENT_STRING_TABLE ) / sizeof( VERTICAL_ALIGNMENT_STRING_TABLE[0] );
  68
  69 const Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
  70
  71 std::string GetHorizontalAlignment( Toolkit::Text::Layout::HorizontalAlignment alignment )
  72 {
  73   const char* name = Scripting::GetEnumerationName<Toolkit::Text::Layout::HorizontalAlignment>( alignment,
  74                                                                                                 HORIZONTAL_ALIGNMENT_STRING_TABLE,
  75                                                                                                 HORIZONTAL_ALIGNMENT_STRING_TABLE_COUNT );
  76
  77   return std::string( name );
  78 }
  79
  80 std::string GetVerticalAlignment( Toolkit::Text::Layout::VerticalAlignment alignment )
  81 {
  82   const char* name = Scripting::GetEnumerationName< Toolkit::Text::Layout::VerticalAlignment >( alignment,
  83                                                                                                 VERTICAL_ALIGNMENT_STRING_TABLE,
  84                                                                                                 VERTICAL_ALIGNMENT_STRING_TABLE_COUNT );
  85
  86   return std::string( name );
  87 }
  88
  89 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
  90   attribute mediump vec2 aPosition;\n
  91   uniform mediump mat4 uMvpMatrix;\n
  92   uniform mediump vec3 uSize;\n
  93   uniform mediump vec4 pixelArea;
  94
  95   uniform mediump mat4 uModelMatrix;\n
  96   uniform mediump mat4 uViewMatrix;\n
  97   uniform mediump mat4 uProjection;\n
  98
  99   varying mediump vec2 vTexCoord;\n
 100   \n
 101   //Visual size and offset
 102   uniform mediump vec2 offset;\n
 103   uniform mediump vec2 size;\n
 104   uniform mediump vec4 offsetSizeMode;\n
 105   uniform mediump vec2 origin;\n
 106   uniform mediump vec2 anchorPoint;\n
 107
 108   vec4 ComputeVertexPosition()\n
 109   {\n
 110     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
 111     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
 112     return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
 113   }\n
 114
 115   void main()\n
 116   {\n
 117     mediump vec4 nonAlignedVertex = uViewMatrix*uModelMatrix*ComputeVertexPosition();\n
 118     mediump vec4 pixelAlignedVertex = vec4 ( floor(nonAlignedVertex.xyz), 1.0 );\n
 119     mediump vec4 vertexPosition = uProjection*pixelAlignedVertex;\n
 120
 121     vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
 122     gl_Position = vertexPosition;\n
 123   }\n
 124 );
 125
 126 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
 127     varying mediump vec2 vTexCoord;\n
 128     uniform sampler2D sTexture;\n
 129     uniform mediump vec4 uAtlasRect;\n
 130     uniform lowp vec4 uColor;\n
 131     uniform lowp vec4 mixColor;\n
 132     \n
 133     void main()\n
 134     {\n
 135       mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
 136       gl_FragColor = texture2D( sTexture, texCoord ) * uColor * mixColor;\n
 137     }\n
 138 );
 139
 140 /**
 141  * Return Property index for the given string key
 142  * param[in] stringKey the string index key
 143  * return the key as an index
 144  */
 145
 146 Dali::Property::Index StringKeyToIndexKey( const std::string& stringKey )
 147 {
 148   Dali::Property::Index result = Property::INVALID_KEY;
 149
 150   if( stringKey == VISUAL_TYPE )
 151   {
 152     result = Toolkit::Visual::Property::TYPE;
 153   }
 154   else if( stringKey == TEXT_PROPERTY )
 155   {
 156     result = Toolkit::TextVisual::Property::TEXT;
 157   }
 158   else if( stringKey == FONT_FAMILY_PROPERTY )
 159   {
 160     result = Toolkit::TextVisual::Property::FONT_FAMILY;
 161   }
 162   else if( stringKey == FONT_STYLE_PROPERTY )
 163   {
 164     result = Toolkit::TextVisual::Property::FONT_STYLE;
 165   }
 166   else if( stringKey == POINT_SIZE_PROPERTY )
 167   {
 168     result = Toolkit::TextVisual::Property::POINT_SIZE;
 169   }
 170   else if( stringKey == MULTI_LINE_PROPERTY )
 171   {
 172     result = Toolkit::TextVisual::Property::MULTI_LINE;
 173   }
 174   else if( stringKey == HORIZONTAL_ALIGNMENT_PROPERTY )
 175   {
 176     result = Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT;
 177   }
 178   else if( stringKey == VERTICAL_ALIGNMENT_PROPERTY )
 179   {
 180     result = Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT;
 181   }
 182   else if( stringKey == TEXT_COLOR_PROPERTY )
 183   {
 184     result = Toolkit::TextVisual::Property::TEXT_COLOR;
 185   }
 186   else if( stringKey == ENABLE_MARKUP_PROPERTY )
 187   {
 188     result = Toolkit::TextVisual::Property::ENABLE_MARKUP;
 189   }
 190
 191   return result;
 192 }
 193
 194 } // unnamed namespace
 195
 196 TextVisualPtr TextVisual::New( VisualFactoryCache& factoryCache, const Property::Map& properties )
 197 {
 198   TextVisualPtr TextVisualPtr( new TextVisual( factoryCache ) );
 199   TextVisualPtr->SetProperties( properties );
 200   return TextVisualPtr;
 201 }
 202
 203 void TextVisual::ConvertStringKeysToIndexKeys( Property::Map& propertyMap )
 204 {
 205   Property::Map outMap;
 206
 207   for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
 208   {
 209     const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
 210
 211     Property::Index indexKey = keyValue.first.indexKey;
 212
 213     if ( keyValue.first.type == Property::Key::STRING )
 214     {
 215       indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
 216     }
 217
 218     outMap.Insert( indexKey, keyValue.second );
 219   }
 220
 221   propertyMap = outMap;
 222 }
 223
 224 float TextVisual::GetHeightForWidth( float width )
 225 {
 226   return mController->GetHeightForWidth( width );
 227 }
 228
 229 void TextVisual::GetNaturalSize( Vector2& naturalSize )
 230 {
 231   naturalSize = mController->GetNaturalSize().GetVectorXY();
 232 }
 233
 234 void TextVisual::DoCreatePropertyMap( Property::Map& map ) const
 235 {
 236   Property::Value value;
 237
 238   map.Clear();
 239   map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::DevelVisual::TEXT );
 240
 241   std::string text;
 242   mController->GetText( text );
 243   map.Insert( Toolkit::TextVisual::Property::TEXT, text );
 244
 245   map.Insert( Toolkit::TextVisual::Property::FONT_FAMILY, mController->GetDefaultFontFamily() );
 246
 247   GetFontStyleProperty( mController, value, Text::FontStyle::DEFAULT );
 248   map.Insert( Toolkit::TextVisual::Property::FONT_STYLE, value );
 249
 250   map.Insert( Toolkit::TextVisual::Property::POINT_SIZE, mController->GetDefaultPointSize() );
 251
 252   map.Insert( Toolkit::TextVisual::Property::MULTI_LINE, mController->IsMultiLineEnabled() );
 253
 254   map.Insert( Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, GetHorizontalAlignment( mController->GetHorizontalAlignment() ) );
 255
 256   map.Insert( Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, GetVerticalAlignment( mController->GetVerticalAlignment() ) );
 257
 258   map.Insert( Toolkit::TextVisual::Property::TEXT_COLOR, mController->GetDefaultColor() );
 259
 260   map.Insert( Toolkit::TextVisual::Property::ENABLE_MARKUP, mController->IsMarkupProcessorEnabled() );
 261 }
 262
 263 TextVisual::TextVisual( VisualFactoryCache& factoryCache )
 264 : Visual::Base( factoryCache ),
 265   mController( Text::Controller::New() ),
 266   mTypesetter( Text::Typesetter::New( mController->GetTextModel() ) )
 267 {
 268 }
 269
 270 TextVisual::~TextVisual()
 271 {
 272 }
 273
 274 void TextVisual::DoSetProperties( const Property::Map& propertyMap )
 275 {
 276   for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
 277   {
 278     const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
 279
 280     Property::Index indexKey = keyValue.first.indexKey;
 281
 282     if( keyValue.first.type == Property::Key::STRING )
 283     {
 284       indexKey = StringKeyToIndexKey( keyValue.first.stringKey );
 285     }
 286
 287     DoSetProperty( indexKey, keyValue.second );
 288   }
 289
 290   // Elide the text if it exceeds the boundaries.
 291   mController->SetTextElideEnabled( true );
 292
 293   // Retrieve the layout engine to set the cursor's width.
 294   Text::Layout::Engine& engine = mController->GetLayoutEngine();
 295
 296   // Sets 0 as cursor's width.
 297   engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
 298 }
 299
 300 void TextVisual::DoSetOnStage( Actor& actor )
 301 {
 302   mControl = actor;
 303
 304   Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
 305
 306   Shader shader = mFactoryCache.GetShader( VisualFactoryCache::TEXT_SHADER );
 307   if( ! shader )
 308   {
 309     shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
 310     shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
 311
 312     mFactoryCache.SaveShader( VisualFactoryCache::TEXT_SHADER, shader );
 313   }
 314
 315   mImpl->mRenderer = Renderer::New( geometry, shader );
 316   mImpl->mRenderer.SetProperty( Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::TEXT );
 317
 318   UpdateRenderer( true ); // Renderer needs textures and to be added to control
 319 }
 320
 321 void TextVisual::DoSetOffStage( Actor& actor )
 322 {
 323   if( mImpl->mRenderer )
 324   {
 325     // Removes the renderer from the actor.
 326     actor.RemoveRenderer( mImpl->mRenderer );
 327
 328     RemoveTextureSet();
 329
 330     // Resets the renderer.
 331     mImpl->mRenderer.Reset();
 332   }
 333
 334   // Resets the control handle.
 335   mControl.Reset();
 336 }
 337
 338 void TextVisual::OnSetTransform()
 339 {
 340   UpdateRenderer( false );
 341 }
 342
 343 void TextVisual::DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
 344 {
 345   switch( index )
 346   {
 347     case Toolkit::TextVisual::Property::ENABLE_MARKUP:
 348     {
 349       const bool enableMarkup = propertyValue.Get<bool>();
 350       mController->SetMarkupProcessorEnabled( enableMarkup );
 351       break;
 352     }
 353     case Toolkit::TextVisual::Property::TEXT:
 354     {
 355       mController->SetText( propertyValue.Get<std::string>() );
 356       break;
 357     }
 358     case Toolkit::TextVisual::Property::FONT_FAMILY:
 359     {
 360       SetFontFamilyProperty( mController, propertyValue );
 361       break;
 362     }
 363     case Toolkit::TextVisual::Property::FONT_STYLE:
 364     {
 365       SetFontStyleProperty( mController, propertyValue, Text::FontStyle::DEFAULT );
 366       break;
 367     }
 368     case Toolkit::TextVisual::Property::POINT_SIZE:
 369     {
 370       const float pointSize = propertyValue.Get<float>();
 371       if( !Equals( mController->GetDefaultPointSize(), pointSize ) )
 372       {
 373         mController->SetDefaultPointSize( pointSize );
 374       }
 375       break;
 376     }
 377     case Toolkit::TextVisual::Property::MULTI_LINE:
 378     {
 379       mController->SetMultiLineEnabled( propertyValue.Get<bool>() );
 380       break;
 381     }
 382     case Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT:
 383     {
 384       Toolkit::Text::Layout::HorizontalAlignment alignment( Toolkit::Text::Layout::HORIZONTAL_ALIGN_BEGIN );
 385       if( Scripting::GetEnumeration< Toolkit::Text::Layout::HorizontalAlignment >( propertyValue.Get< std::string >().c_str(),
 386                                                                                    HORIZONTAL_ALIGNMENT_STRING_TABLE,
 387                                                                                    HORIZONTAL_ALIGNMENT_STRING_TABLE_COUNT,
 388                                                                                    alignment ) )
 389       {
 390         mController->SetHorizontalAlignment( alignment );
 391       }
 392       break;
 393     }
 394     case Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT:
 395     {
 396       Toolkit::Text::Layout::VerticalAlignment alignment( Toolkit::Text::Layout::VERTICAL_ALIGN_BOTTOM );
 397       if( Scripting::GetEnumeration< Toolkit::Text::Layout::VerticalAlignment >( propertyValue.Get< std::string >().c_str(),
 398                                                                                  VERTICAL_ALIGNMENT_STRING_TABLE,
 399                                                                                  VERTICAL_ALIGNMENT_STRING_TABLE_COUNT,
 400                                                                                  alignment ) )
 401       {
 402         mController->SetVerticalAlignment( alignment );
 403       }
 404       break;
 405     }
 406     case Toolkit::TextVisual::Property::TEXT_COLOR:
 407     {
 408       const Vector4& textColor = propertyValue.Get< Vector4 >();
 409       if( mController->GetDefaultColor() != textColor )
 410       {
 411         mController->SetDefaultColor( textColor );
 412       }
 413       break;
 414     }
 415   }
 416 }
 417
 418 void TextVisual::UpdateRenderer( bool initializeRendererAndTexture )
 419 {
 420   Actor control = mControl.GetHandle();
 421   if( !control )
 422   {
 423     // Nothing to do.
 424     return;
 425   }
 426
 427   // Calculates the size to be used to relayout.
 428   Vector2 relayoutSize;
 429
 430   const bool isWidthRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.z ) < Math::MACHINE_EPSILON_1000;
 431   const bool isHeightRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.w ) < Math::MACHINE_EPSILON_1000;
 432
 433   // Round the size and offset to avoid pixel alignement issues.
 434   relayoutSize.width = floorf( 0.5f + ( isWidthRelative ? mImpl->mControlSize.width * mImpl->mTransform.mSize.x : mImpl->mTransform.mSize.width ) );
 435   relayoutSize.height = floorf( 0.5f + ( isHeightRelative ? mImpl->mControlSize.height * mImpl->mTransform.mSize.y : mImpl->mTransform.mSize.height ) );
 436
 437   if( ( fabsf( relayoutSize.width ) < Math::MACHINE_EPSILON_1000 ) || ( fabsf( relayoutSize.height ) < Math::MACHINE_EPSILON_1000 ) )
 438   {
 439     // Removes the texture set.
 440     RemoveTextureSet();
 441
 442     // Remove any renderer previously set.
 443     if( mImpl->mRenderer )
 444     {
 445       control.RemoveRenderer( mImpl->mRenderer );
 446     }
 447
 448     // Nothing else to do if the relayout size is zero.
 449     return;
 450   }
 451
 452   const Text::Controller::UpdateTextType updateTextType = mController->Relayout( relayoutSize );
 453
 454   if( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType ) || initializeRendererAndTexture )
 455   {
 456     // Removes the texture set.
 457     RemoveTextureSet();
 458
 459     // Remove any renderer previously set.
 460     if( mImpl->mRenderer )
 461     {
 462       control.RemoveRenderer( mImpl->mRenderer );
 463     }
 464
 465     if( ( relayoutSize.width > Math::MACHINE_EPSILON_1000 ) &&
 466         ( relayoutSize.height > Math::MACHINE_EPSILON_1000 ) )
 467     {
 468       PixelData data = mTypesetter->Render( relayoutSize );
 469
 470       Vector4 atlasRect = FULL_TEXTURE_RECT;
 471
 472       // Texture set not retrieved from Atlas Manager whilst pixel offset visible.
 473
 474       // It may happen the image atlas can't handle a pixel data it exceeds the maximum size.
 475       // In that case, create a texture. TODO: should tile the text.
 476
 477       Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
 478                                       data.GetPixelFormat(),
 479                                       data.GetWidth(),
 480                                       data.GetHeight() );
 481
 482       texture.Upload( data );
 483
 484       TextureSet textureSet = TextureSet::New();
 485       textureSet.SetTexture( 0u, texture );
 486
 487       mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
 488
 489       mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
 490
 491       //Register transform properties
 492       mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
 493
 494       // Filter mode needs to be set to nearest to avoid blurry text.
 495       Sampler sampler = Sampler::New();
 496       sampler.SetFilterMode( FilterMode::NEAREST, FilterMode::NEAREST );
 497       textureSet.SetSampler( 0u, sampler );
 498
 499       mImpl->mRenderer.SetTextures( textureSet );
 500
 501       control.AddRenderer( mImpl->mRenderer );
 502     }
 503   }
 504 }
 505
 506 void TextVisual::RemoveTextureSet()
 507 {
 508   if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
 509   {
 510     // Removes the text's image from the texture atlas.
 511     Vector4 atlasRect;
 512
 513     const Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
 514     if( index != Property::INVALID_INDEX )
 515     {
 516       const Property::Value& atlasRectValue = mImpl->mRenderer.GetProperty( index );
 517       atlasRectValue.Get( atlasRect );
 518
 519       const TextureSet& textureSet = mImpl->mRenderer.GetTextures();
 520       mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
 521     }
 522   }
 523 }
 524
 525 } // namespace Internal
 526
 527 } // namespace Toolkit
 528
 529 } // namespace Dali