dali-toolkit/internal/text/text-scroller.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/text/text-scroller.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/stage.h>
  23 #include <dali/integration-api/debug.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/text-scroller-interface.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace
  35 {
  36
  37 #if defined ( DEBUG_ENABLED )
  38   Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_SCROLLING");
  39 #endif
  40
  41 const int MINIMUM_SCROLL_SPEED = 1; // Speed should be set by Property system.
  42
  43 const char* VERTEX_SHADER_SCROLL = DALI_COMPOSE_SHADER(
  44   attribute mediump vec2 aPosition;\n
  45   varying highp vec2 vTexCoord;\n
  46   uniform mediump vec3 uSize;\n
  47   uniform mediump float uDelta;\n
  48   uniform mediump vec2 uTextureSize;\n
  49   uniform mediump float uGap;\n
  50   uniform mediump float uHorizontalAlign;\n
  51   uniform mediump float uVerticalAlign;\n
  52   \n
  53   uniform mediump mat4 uModelMatrix;\n
  54   uniform mediump mat4 uViewMatrix;\n
  55   uniform mediump mat4 uProjection;\n
  56   \n
  57   //Visual size and offset
  58   uniform mediump vec2 offset;\n
  59   uniform mediump vec2 size;\n
  60   uniform mediump vec4 offsetSizeMode;\n
  61   uniform mediump vec2 origin;\n
  62   uniform mediump vec2 anchorPoint;\n
  63
  64   void main()\n
  65   {\n
  66     mediump vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy );\n
  67     mediump vec2 visualSize = mix( uSize.xy * size, size, offsetSizeMode.zw );\n
  68     \n
  69     vTexCoord.x = ( uDelta + uHorizontalAlign * ( uTextureSize.x - visualSize.x - uGap ) + floor( aPosition.x * visualSize.x ) + 0.5 - uGap * 0.5 ) / uTextureSize.x + 0.5;\n
  70     vTexCoord.y = ( uVerticalAlign * ( uTextureSize.y - visualSize.y ) + floor( aPosition.y * visualSize.y ) + 0.5 ) / ( uTextureSize.y ) + 0.5;\n
  71     \n
  72     mediump vec4 vertexPosition = vec4( floor( ( aPosition + anchorPoint ) * visualSize + ( visualOffset + origin ) * uSize.xy ), 0.0, 1.0 );\n
  73     \n
  74     gl_Position = uProjection * uViewMatrix * uModelMatrix * vertexPosition;\n
  75   }\n
  76 );
  77
  78 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
  79   varying highp vec2 vTexCoord;\n
  80   uniform sampler2D sTexture;\n
  81   uniform lowp vec4 uColor;\n
  82   uniform lowp vec3 mixColor;\n
  83   \n
  84   void main()\n
  85   {\n
  86     if ( vTexCoord.y > 1.0 )\n
  87       discard;\n
  88     \n
  89     mediump vec4 textTexture = texture2D( sTexture, vTexCoord );\n
  90     \n
  91     gl_FragColor = textTexture * uColor * vec4( mixColor, 1.0 );
  92   }\n
  93 );
  94
  95 /**
  96  * @brief How the text should be aligned horizontally when scrolling the text.
  97  *
  98  * -0.5f aligns the text to the left, 0.0f aligns the text to the center, 0.5f aligns the text to the right.
  99  * The final alignment depends on two factors:
 100  *   1) The alignment value of the text label (Use Text::HorizontalAlignment enumerations).
 101  *   2) The text direction, i.e. whether it's LTR or RTL (0 = LTR, 1 = RTL).
 102  */
 103 const float HORIZONTAL_ALIGNMENT_TABLE[ Text::HorizontalAlignment::END+1 ][ 2 ] =
 104 {
 105   // HorizontalAlignment::BEGIN
 106   {
 107     -0.5f, // LTR
 108     0.5f   // RTL
 109   },
 110
 111   // HorizontalAlignment::CENTER
 112   {
 113     0.0f,  // LTR
 114     0.0f   // RTL
 115   },
 116
 117   // HorizontalAlignment::END
 118   {
 119     0.5f,  // LTR
 120     -0.5f  // RTL
 121   }
 122 };
 123
 124 /**
 125  * @brief How the text should be aligned vertically when scrolling the text.
 126  *
 127  * -0.5f aligns the text to the top, 0.0f aligns the text to the center, 0.5f aligns the text to the bottom.
 128  * The alignment depends on the alignment value of the text label (Use Text::VerticalAlignment enumerations).
 129  */
 130 const float VERTICAL_ALIGNMENT_TABLE[ Text::VerticalAlignment::BOTTOM+1 ] =
 131 {
 132   -0.5f, // VerticalAlignment::TOP
 133   0.0f,  // VerticalAlignment::CENTER
 134   0.5f   // VerticalAlignment::BOTTOM
 135 };
 136
 137 } // namespace
 138
 139 namespace Text
 140 {
 141
 142 TextScrollerPtr TextScroller::New( ScrollerInterface& scrollerInterface )
 143 {
 144   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::New\n" );
 145
 146   TextScrollerPtr textScroller( new TextScroller( scrollerInterface) );
 147   return textScroller;
 148 }
 149
 150 void TextScroller::SetGap( int gap )
 151 {
 152   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetGap gap[%d]\n", gap );
 153   mWrapGap = static_cast<float>(gap);
 154 }
 155
 156 int TextScroller::GetGap() const
 157 {
 158   return static_cast<int>(mWrapGap);
 159 }
 160
 161 void TextScroller::SetSpeed( int scrollSpeed )
 162 {
 163   mScrollSpeed = std::max( MINIMUM_SCROLL_SPEED, scrollSpeed );
 164 }
 165
 166 int TextScroller::GetSpeed() const
 167 {
 168   return mScrollSpeed;
 169 }
 170
 171 void TextScroller::SetLoopCount( int loopCount )
 172 {
 173   if ( loopCount >= 0 )
 174   {
 175     mLoopCount = loopCount;
 176   }
 177
 178   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetLoopCount [%d] Status[%s]\n", mLoopCount, (loopCount)?"looping":"stop" );
 179 }
 180
 181 int TextScroller::GetLoopCount() const
 182 {
 183   return mLoopCount;
 184 }
 185
 186 void TextScroller::SetLoopDelay( float delay )
 187 {
 188   mLoopDelay = delay;
 189 }
 190
 191 float TextScroller::GetLoopDelay() const
 192 {
 193   return mLoopDelay;
 194 }
 195
 196 void TextScroller::SetStopMode( TextLabel::AutoScrollStopMode::Type stopMode )
 197 {
 198   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetAutoScrollStopMode [%s]\n",(stopMode == TextLabel::AutoScrollStopMode::IMMEDIATE)?"IMMEDIATE":"FINISH_LOOP" );
 199   mStopMode = stopMode;
 200 }
 201
 202 void TextScroller::StopScrolling()
 203 {
 204   if ( mScrollAnimation && mScrollAnimation.GetState() == Animation::PLAYING )
 205   {
 206     switch( mStopMode )
 207     {
 208       case TextLabel::AutoScrollStopMode::IMMEDIATE:
 209       {
 210         mScrollAnimation.Stop();
 211         mScrollerInterface.ScrollingFinished();
 212         break;
 213       }
 214       case TextLabel::AutoScrollStopMode::FINISH_LOOP:
 215       {
 216         mScrollAnimation.SetLoopCount( 1 ); // As animation already playing this allows the current animation to finish instead of trying to stop mid-way
 217         break;
 218       }
 219       default:
 220       {
 221         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Undifined AutoScrollStopMode\n" );
 222       }
 223     }
 224   }
 225   else
 226   {
 227     mScrollerInterface.ScrollingFinished();
 228   }
 229 }
 230
 231 TextLabel::AutoScrollStopMode::Type TextScroller::GetStopMode() const
 232 {
 233   return mStopMode;
 234 }
 235
 236 TextScroller::TextScroller( ScrollerInterface& scrollerInterface )
 237 : mScrollerInterface( scrollerInterface ),
 238   mScrollDeltaIndex( Property::INVALID_INDEX ),
 239   mScrollSpeed( MINIMUM_SCROLL_SPEED ),
 240   mLoopCount( 1 ),
 241   mLoopDelay( 0.0f ),
 242   mWrapGap( 0.0f ),
 243   mStopMode( TextLabel::AutoScrollStopMode::FINISH_LOOP )
 244 {
 245   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller Default Constructor\n" );
 246 }
 247
 248 TextScroller::~TextScroller()
 249 {
 250 }
 251
 252 void TextScroller::SetParameters( Actor scrollingTextActor, Renderer renderer, TextureSet textureSet, const Size& controlSize, const Size& textureSize, const float wrapGap, CharacterDirection direction, HorizontalAlignment::Type horizontalAlignment, VerticalAlignment::Type verticalAlignment )
 253 {
 254   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetParameters controlSize[%f,%f] textureSize[%f,%f] direction[%d]\n",
 255                  controlSize.x, controlSize.y, textureSize.x, textureSize.y, direction );
 256
 257   mRenderer = renderer;
 258
 259   float animationProgress = 0.0f;
 260   int   remainedLoop = mLoopCount;
 261   if ( mScrollAnimation )
 262   {
 263     if( mScrollAnimation.GetState() == Animation::PLAYING )
 264     {
 265       animationProgress = mScrollAnimation.GetCurrentProgress();
 266
 267       if( mLoopCount > 0 ) // If not a ininity loop, then calculate remained loop
 268       {
 269         remainedLoop = mLoopCount - ( mScrollAnimation.GetCurrentLoop() );
 270         remainedLoop = ( remainedLoop <= 0 ? 1 : remainedLoop );
 271       }
 272     }
 273     mScrollAnimation.Clear();
 274
 275     // Reset to the original shader and texture before scrolling
 276     mRenderer.SetShader(mShader);
 277     mRenderer.SetTextures( mTextureSet );
 278   }
 279
 280   mShader = mRenderer.GetShader();
 281   mTextureSet = mRenderer.GetTextures();
 282
 283   // Set the shader and texture for scrolling
 284   Shader shader = Shader::New( VERTEX_SHADER_SCROLL, FRAGMENT_SHADER, Shader::Hint::NONE );
 285   mRenderer.SetShader( shader );
 286   mRenderer.SetTextures( textureSet );
 287
 288   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetParameters wrapGap[%f]\n", wrapGap );
 289
 290   float horizontalAlign;
 291
 292   if( textureSize.x > controlSize.x )
 293   {
 294     // if Text is elided, scroll should start at the begin of text.
 295     horizontalAlign = HORIZONTAL_ALIGNMENT_TABLE[HorizontalAlignment::BEGIN][ direction ];
 296   }
 297   else
 298   {
 299     horizontalAlign = HORIZONTAL_ALIGNMENT_TABLE[ horizontalAlignment ][ direction ];
 300   }
 301
 302   const float verticalAlign = VERTICAL_ALIGNMENT_TABLE[ verticalAlignment ];
 303
 304   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetParameters horizontalAlign[%f], verticalAlign[%f]\n", horizontalAlign, verticalAlign );
 305
 306   scrollingTextActor.RegisterProperty( "uTextureSize", textureSize );
 307   scrollingTextActor.RegisterProperty( "uHorizontalAlign", horizontalAlign );
 308   scrollingTextActor.RegisterProperty( "uVerticalAlign", verticalAlign );
 309   scrollingTextActor.RegisterProperty( "uGap", wrapGap );
 310   mScrollDeltaIndex = scrollingTextActor.RegisterProperty( "uDelta", 0.0f );
 311
 312   float scrollAmount = std::max( textureSize.width, controlSize.width );
 313   float scrollDuration =  scrollAmount / mScrollSpeed;
 314
 315   if ( direction  )
 316   {
 317      scrollAmount = -scrollAmount; // reverse direction of scrolling
 318   }
 319
 320   StartScrolling( scrollingTextActor, scrollAmount, scrollDuration, remainedLoop );
 321   mScrollAnimation.SetCurrentProgress(animationProgress);
 322 }
 323
 324 void TextScroller::AutoScrollAnimationFinished( Dali::Animation& animation )
 325 {
 326   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::AutoScrollAnimationFinished\n" );
 327   mScrollerInterface.ScrollingFinished();
 328
 329   // Revert to the original shader and texture after scrolling
 330   mRenderer.SetShader(mShader);
 331   if ( mTextureSet )
 332   {
 333     mRenderer.SetTextures( mTextureSet );
 334   }
 335 }
 336
 337 void TextScroller::StartScrolling( Actor scrollingTextActor, float scrollAmount, float scrollDuration, int loopCount )
 338 {
 339   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::StartScrolling scrollAmount[%f] scrollDuration[%f], loop[%d] speed[%d]\n", scrollAmount, scrollDuration, loopCount, mScrollSpeed );
 340
 341   mScrollAnimation = Animation::New( scrollDuration );
 342   mScrollAnimation.AnimateTo( Property( scrollingTextActor, mScrollDeltaIndex ), scrollAmount, TimePeriod( mLoopDelay, scrollDuration ) );
 343   mScrollAnimation.SetEndAction( Animation::Discard );
 344   mScrollAnimation.SetLoopCount( loopCount );
 345   mScrollAnimation.FinishedSignal().Connect( this, &TextScroller::AutoScrollAnimationFinished );
 346   mScrollAnimation.Play();
 347 }
 348
 349 } // namespace Text
 350
 351 } // namespace Toolkit
 352
 353 } // namespace Dali