2 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/visuals/text/text-visual.h>
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>
44 const char * const TEXT_PROPERTY( "text" );
45 const char * const FONT_FAMILY_PROPERTY( "fontFamily" );
46 const char * const FONT_STYLE_PROPERTY( "fontStyle" );
47 const char * const POINT_SIZE_PROPERTY( "pointSize" );
48 const char * const MULTI_LINE_PROPERTY( "multiLine" );
49 const char * const HORIZONTAL_ALIGNMENT_PROPERTY( "horizontalAlignment" );
50 const char * const VERTICAL_ALIGNMENT_PROPERTY( "verticalAlignment" );
51 const char * const TEXT_COLOR_PROPERTY( "textColor" );
52 const char * const ENABLE_MARKUP_PROPERTY( "enableMarkup" );
54 const std::string PIXEL_AREA_UNIFORM_NAME = "pixelArea";
56 const Scripting::StringEnum HORIZONTAL_ALIGNMENT_STRING_TABLE[] =
58 { "BEGIN", Toolkit::Text::Layout::HORIZONTAL_ALIGN_BEGIN },
59 { "CENTER", Toolkit::Text::Layout::HORIZONTAL_ALIGN_CENTER },
60 { "END", Toolkit::Text::Layout::HORIZONTAL_ALIGN_END },
62 const unsigned int HORIZONTAL_ALIGNMENT_STRING_TABLE_COUNT = sizeof( HORIZONTAL_ALIGNMENT_STRING_TABLE ) / sizeof( HORIZONTAL_ALIGNMENT_STRING_TABLE[0] );
64 const Scripting::StringEnum VERTICAL_ALIGNMENT_STRING_TABLE[] =
66 { "TOP", Toolkit::Text::Layout::VERTICAL_ALIGN_TOP },
67 { "CENTER", Toolkit::Text::Layout::VERTICAL_ALIGN_CENTER },
68 { "BOTTOM", Toolkit::Text::Layout::VERTICAL_ALIGN_BOTTOM },
70 const unsigned int VERTICAL_ALIGNMENT_STRING_TABLE_COUNT = sizeof( VERTICAL_ALIGNMENT_STRING_TABLE ) / sizeof( VERTICAL_ALIGNMENT_STRING_TABLE[0] );
72 const Vector4 FULL_TEXTURE_RECT( 0.f, 0.f, 1.f, 1.f );
74 std::string GetHorizontalAlignment( Toolkit::Text::Layout::HorizontalAlignment alignment )
76 const char* name = Scripting::GetEnumerationName<Toolkit::Text::Layout::HorizontalAlignment>( alignment,
77 HORIZONTAL_ALIGNMENT_STRING_TABLE,
78 HORIZONTAL_ALIGNMENT_STRING_TABLE_COUNT );
80 return std::string( name );
83 std::string GetVerticalAlignment( Toolkit::Text::Layout::VerticalAlignment alignment )
85 const char* name = Scripting::GetEnumerationName< Toolkit::Text::Layout::VerticalAlignment >( alignment,
86 VERTICAL_ALIGNMENT_STRING_TABLE,
87 VERTICAL_ALIGNMENT_STRING_TABLE_COUNT );
89 return std::string( name );
92 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
93 attribute mediump vec2 aPosition;\n
94 uniform mediump mat4 uMvpMatrix;\n
95 uniform mediump vec3 uSize;\n
96 uniform mediump vec4 pixelArea;
97 varying mediump vec2 vTexCoord;\n
100 //Visual size and offset
101 uniform mediump vec2 offset;\n
102 uniform mediump vec2 size;\n
103 uniform mediump vec4 offsetSizeMode;\n
104 uniform mediump vec2 origin;\n
105 uniform mediump vec2 anchorPoint;\n
107 vec4 ComputeVertexPosition()\n
109 vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw );\n
110 vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
111 return vec4( (aPosition + anchorPoint)*visualSize + (visualOffset + origin)*uSize.xy, 0.0, 1.0 );\n
116 mediump vec4 vertexPosition = uMvpMatrix *ComputeVertexPosition();\n
117 vTexCoord = pixelArea.xy+pixelArea.zw*(aPosition + vec2(0.5) );\n
118 gl_Position = vertexPosition;\n
122 const char* FRAGMENT_SHADER_ATLAS_CLAMP = DALI_COMPOSE_SHADER(
123 varying mediump vec2 vTexCoord;\n
124 uniform sampler2D sTexture;\n
125 uniform mediump vec4 uAtlasRect;\n
126 uniform lowp vec4 uColor;\n
130 mediump vec2 texCoord = clamp( mix( uAtlasRect.xy, uAtlasRect.zw, vTexCoord ), uAtlasRect.xy, uAtlasRect.zw );\n
131 gl_FragColor = texture2D( sTexture, texCoord ) * uColor;\n
135 } // unnamed namespace
137 TextVisualPtr TextVisual::New( VisualFactoryCache& factoryCache )
139 return new TextVisual( factoryCache );
142 float TextVisual::GetHeightForWidth( float width )
144 return mController->GetHeightForWidth( width );
147 void TextVisual::GetNaturalSize( Vector2& naturalSize )
149 naturalSize = mController->GetNaturalSize().GetVectorXY();
152 void TextVisual::DoCreatePropertyMap( Property::Map& map ) const
154 Property::Value value;
157 map.Insert( Toolkit::DevelVisual::Property::TYPE, Toolkit::DevelVisual::TEXT );
160 mController->GetText( text );
161 map.Insert( Toolkit::TextVisual::Property::TEXT, text );
163 map.Insert( Toolkit::TextVisual::Property::FONT_FAMILY, mController->GetDefaultFontFamily() );
165 GetFontStyleProperty( mController, value, Text::FontStyle::DEFAULT );
166 map.Insert( Toolkit::TextVisual::Property::FONT_STYLE, value );
168 map.Insert( Toolkit::TextVisual::Property::POINT_SIZE, mController->GetDefaultPointSize() );
170 map.Insert( Toolkit::TextVisual::Property::MULTI_LINE, mController->IsMultiLineEnabled() );
172 map.Insert( Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, GetHorizontalAlignment( mController->GetHorizontalAlignment() ) );
174 map.Insert( Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, GetVerticalAlignment( mController->GetVerticalAlignment() ) );
176 map.Insert( Toolkit::TextVisual::Property::TEXT_COLOR, mController->GetDefaultColor() );
178 map.Insert( Toolkit::TextVisual::Property::ENABLE_MARKUP, mController->IsMarkupProcessorEnabled() );
181 TextVisual::TextVisual( VisualFactoryCache& factoryCache )
182 : Visual::Base( factoryCache ),
183 mController( Text::Controller::New() ),
184 mTypesetter( Text::Typesetter::New( mController->GetTextModel() ) )
188 TextVisual::~TextVisual()
192 void TextVisual::DoSetProperties( const Property::Map& propertyMap )
194 for( Property::Map::SizeType index = 0u, count = propertyMap.Count(); index < count; ++index )
196 const KeyValuePair& keyValue = propertyMap.GetKeyValue( index );
198 switch( keyValue.first.type )
200 case Property::Key::INDEX:
202 DoSetProperty( keyValue.first.indexKey, keyValue.second );
205 case Property::Key::STRING:
207 if( keyValue.first.stringKey == TEXT_PROPERTY )
209 DoSetProperty( Toolkit::TextVisual::Property::TEXT, keyValue.second );
211 else if( keyValue.first.stringKey == FONT_FAMILY_PROPERTY )
213 DoSetProperty( Toolkit::TextVisual::Property::FONT_FAMILY, keyValue.second );
215 else if( keyValue.first.stringKey == FONT_STYLE_PROPERTY )
217 DoSetProperty( Toolkit::TextVisual::Property::FONT_STYLE, keyValue.second );
219 else if( keyValue.first.stringKey == POINT_SIZE_PROPERTY )
221 DoSetProperty( Toolkit::TextVisual::Property::POINT_SIZE, keyValue.second );
223 else if( keyValue.first.stringKey == MULTI_LINE_PROPERTY )
225 DoSetProperty( Toolkit::TextVisual::Property::MULTI_LINE, keyValue.second );
227 else if( keyValue.first.stringKey == HORIZONTAL_ALIGNMENT_PROPERTY )
229 DoSetProperty( Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, keyValue.second );
231 else if( keyValue.first.stringKey == VERTICAL_ALIGNMENT_PROPERTY )
233 DoSetProperty( Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, keyValue.second );
235 else if( keyValue.first.stringKey == TEXT_COLOR_PROPERTY )
237 DoSetProperty( Toolkit::TextVisual::Property::TEXT_COLOR, keyValue.second );
239 else if( keyValue.first.stringKey == ENABLE_MARKUP_PROPERTY )
241 DoSetProperty( Toolkit::TextVisual::Property::ENABLE_MARKUP, keyValue.second );
248 // Elide the text if it exceeds the boundaries.
249 mController->SetTextElideEnabled( true );
251 // Retrieve the layout engine to set the cursor's width.
252 Text::Layout::Engine& engine = mController->GetLayoutEngine();
254 // Sets 0 as cursor's width.
255 engine.SetCursorWidth( 0u ); // Do not layout space for the cursor.
258 void TextVisual::DoSetOnStage( Actor& actor )
262 Geometry geometry = mFactoryCache.GetGeometry( VisualFactoryCache::QUAD_GEOMETRY );
265 geometry = VisualFactoryCache::CreateQuadGeometry();
266 mFactoryCache.SaveGeometry( VisualFactoryCache::QUAD_GEOMETRY , geometry );
269 Shader shader = mFactoryCache.GetShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP );
272 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER_ATLAS_CLAMP );
273 mFactoryCache.SaveShader( VisualFactoryCache::IMAGE_SHADER_ATLAS_DEFAULT_WRAP, shader );
275 shader.RegisterProperty( PIXEL_AREA_UNIFORM_NAME, FULL_TEXTURE_RECT );
277 mImpl->mRenderer = Renderer::New( geometry, shader );
278 mImpl->mRenderer.SetProperty( Dali::Renderer::Property::DEPTH_INDEX, Toolkit::DepthIndex::TEXT );
283 void TextVisual::DoSetOffStage( Actor& actor )
285 if( mImpl->mRenderer )
287 // Removes the renderer from the actor.
288 actor.RemoveRenderer( mImpl->mRenderer );
292 // Resets the renderer.
293 mImpl->mRenderer.Reset();
296 // Resets the control handle.
300 void TextVisual::OnSetTransform()
305 void TextVisual::DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue )
309 case Toolkit::TextVisual::Property::ENABLE_MARKUP:
311 const bool enableMarkup = propertyValue.Get<bool>();
312 mController->SetMarkupProcessorEnabled( enableMarkup );
315 case Toolkit::TextVisual::Property::TEXT:
317 mController->SetText( propertyValue.Get<std::string>() );
320 case Toolkit::TextVisual::Property::FONT_FAMILY:
322 SetFontFamilyProperty( mController, propertyValue );
325 case Toolkit::TextVisual::Property::FONT_STYLE:
327 SetFontStyleProperty( mController, propertyValue, Text::FontStyle::DEFAULT );
330 case Toolkit::TextVisual::Property::POINT_SIZE:
332 const float pointSize = propertyValue.Get<float>();
333 if( !Equals( mController->GetDefaultPointSize(), pointSize ) )
335 mController->SetDefaultPointSize( pointSize );
339 case Toolkit::TextVisual::Property::MULTI_LINE:
341 mController->SetMultiLineEnabled( propertyValue.Get<bool>() );
344 case Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT:
346 Toolkit::Text::Layout::HorizontalAlignment alignment( Toolkit::Text::Layout::HORIZONTAL_ALIGN_BEGIN );
347 if( Scripting::GetEnumeration< Toolkit::Text::Layout::HorizontalAlignment >( propertyValue.Get< std::string >().c_str(),
348 HORIZONTAL_ALIGNMENT_STRING_TABLE,
349 HORIZONTAL_ALIGNMENT_STRING_TABLE_COUNT,
352 mController->SetHorizontalAlignment( alignment );
356 case Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT:
358 Toolkit::Text::Layout::VerticalAlignment alignment( Toolkit::Text::Layout::VERTICAL_ALIGN_BOTTOM );
359 if( Scripting::GetEnumeration< Toolkit::Text::Layout::VerticalAlignment >( propertyValue.Get< std::string >().c_str(),
360 VERTICAL_ALIGNMENT_STRING_TABLE,
361 VERTICAL_ALIGNMENT_STRING_TABLE_COUNT,
364 mController->SetVerticalAlignment( alignment );
368 case Toolkit::TextVisual::Property::TEXT_COLOR:
370 const Vector4& textColor = propertyValue.Get< Vector4 >();
371 if( mController->GetDefaultColor() != textColor )
373 mController->SetDefaultColor( textColor );
380 void TextVisual::UpdateRenderer()
382 Actor control = mControl.GetHandle();
389 // Calculates the size to be used to relayout.
390 Vector2 relayoutSize;
392 const bool isWidthRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.z ) < Math::MACHINE_EPSILON_1000;
393 const bool isHeightRelative = fabsf( mImpl->mTransform.mOffsetSizeMode.w ) < Math::MACHINE_EPSILON_1000;
395 // Round the size and offset to avoid pixel alignement issues.
396 relayoutSize.width = floorf( 0.5f + ( isWidthRelative ? mImpl->mControlSize.width * mImpl->mTransform.mSize.x : mImpl->mTransform.mSize.width ) );
397 relayoutSize.height = floorf( 0.5f + ( isHeightRelative ? mImpl->mControlSize.height * mImpl->mTransform.mSize.y : mImpl->mTransform.mSize.height ) );
399 if( ( fabsf( relayoutSize.width ) < Math::MACHINE_EPSILON_1000 ) || ( fabsf( relayoutSize.height ) < Math::MACHINE_EPSILON_1000 ) )
401 // Removes the texture set.
404 // Remove any renderer previously set.
405 if( mImpl->mRenderer )
407 control.RemoveRenderer( mImpl->mRenderer );
410 // Nothing else to do if the relayout size is zero.
414 const Text::Controller::UpdateTextType updateTextType = mController->Relayout( relayoutSize );
416 if( Text::Controller::NONE_UPDATED != ( Text::Controller::MODEL_UPDATED & updateTextType ) )
418 // Removes the texture set.
421 // Remove any renderer previously set.
422 if( mImpl->mRenderer )
424 control.RemoveRenderer( mImpl->mRenderer );
427 if( ( relayoutSize.width > Math::MACHINE_EPSILON_1000 ) &&
428 ( relayoutSize.height > Math::MACHINE_EPSILON_1000 ) )
430 PixelData data = mTypesetter->Render( relayoutSize );
432 Vector4 atlasRect = FULL_TEXTURE_RECT;
433 TextureSet textureSet = mFactoryCache.GetAtlasManager()->Add( atlasRect, data );
437 mImpl->mFlags |= Impl::IS_ATLASING_APPLIED;
441 // It may happen the image atlas can't handle a pixel data it exceeds the maximum size.
442 // In that case, create a texture. TODO: should tile the text.
444 Texture texture = Texture::New( Dali::TextureType::TEXTURE_2D,
445 data.GetPixelFormat(),
449 texture.Upload( data );
451 textureSet = TextureSet::New();
452 textureSet.SetTexture( 0u, texture );
454 mImpl->mFlags &= ~Impl::IS_ATLASING_APPLIED;
457 mImpl->mRenderer.RegisterProperty( ATLAS_RECT_UNIFORM_NAME, atlasRect );
459 //Register transform properties
460 mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
462 // Filter mode needs to be set to nearest to avoid blurry text.
463 Sampler sampler = Sampler::New();
464 sampler.SetFilterMode( FilterMode::NEAREST, FilterMode::NEAREST );
465 textureSet.SetSampler( 0u, sampler );
467 mImpl->mRenderer.SetTextures( textureSet );
469 control.AddRenderer( mImpl->mRenderer );
474 void TextVisual::RemoveTextureSet()
476 if( mImpl->mFlags & Impl::IS_ATLASING_APPLIED )
478 // Removes the text's image from the texture atlas.
481 const Property::Index index = mImpl->mRenderer.GetPropertyIndex( ATLAS_RECT_UNIFORM_NAME );
482 if( index != Property::INVALID_INDEX )
484 const Property::Value& atlasRectValue = mImpl->mRenderer.GetProperty( index );
485 atlasRectValue.Get( atlasRect );
487 const TextureSet& textureSet = mImpl->mRenderer.GetTextures();
488 mFactoryCache.GetAtlasManager()->Remove( textureSet, atlasRect );
493 } // namespace Internal
495 } // namespace Toolkit