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