X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-scroller.cpp;h=cec40817507808b7081ca23d2d6010a578a67194;hb=27b34b7f9c8ba9936ee38db06f22f18fcf04c826;hp=ee1d241f2a9ed606edc6d0a1526594a9dfbf5660;hpb=f4c1e7f52d49c3ce033b9ee4c3c7414b06a22d45;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/text/text-scroller.cpp b/dali-toolkit/internal/text/text-scroller.cpp index ee1d241..cec4081 100644 --- a/dali-toolkit/internal/text/text-scroller.cpp +++ b/dali-toolkit/internal/text/text-scroller.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,292 +19,277 @@ #include // EXTERNAL INCLUDES -#include -#include -#include -#include -#include -#include -#include -#include #include // INTERNAL INCLUDES +#include #include -#include namespace Dali { - namespace Toolkit { - -namespace Text -{ -extern const int MINIMUM_SCROLL_SPEED; -} // namespace - namespace { - -#if defined ( DEBUG_ENABLED ) - Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_SCROLLING"); +#if defined(DEBUG_ENABLED) +Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_SCROLLING"); #endif -const char* VERTEX_SHADER_SCROLL = DALI_COMPOSE_SHADER( - attribute mediump vec2 aPosition;\n - varying highp vec2 vTexCoord;\n - varying highp float vRatio;\n - uniform mediump mat4 uMvpMatrix;\n - uniform mediump vec3 uSize;\n - uniform mediump float uDelta;\n - uniform mediump vec2 uTextureSize; - uniform mediump float uGap;\n - uniform mediump float uRtl;\n - \n - void main()\n - {\n - {\n - mediump vec4 vertexPosition = vec4(aPosition*uSize.xy, 0.0, 1.0);\n - float smallTextPadding = max(uSize.x - uTextureSize.x, 0. );\n - float gap = max( uGap, smallTextPadding );\n - vTexCoord.x = ( uDelta + ( uRtl * ( uTextureSize.x - uSize.x ) ) + ( aPosition.x * uSize.x ) )/ ( uTextureSize.x+gap );\n - vTexCoord.y = aPosition.y;\n - vRatio = uTextureSize.x / ( uTextureSize.x + gap );\n - gl_Position = uMvpMatrix * vertexPosition;\n - }\n - }\n -); - -const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER( - varying mediump vec2 vTexCoord;\n - varying highp float vRatio;\n - uniform sampler2D sTexture;\n - \n - void main()\n - {\n - mediump vec2 texCoord;\n - texCoord.y = vTexCoord.y;\n - texCoord.x = fract( vTexCoord.x ) / vRatio;\n - if ( texCoord.x > 1.0 )\n - discard;\n - \n - gl_FragColor = texture2D( sTexture, texCoord );\n - }\n -); - -/** - * @brief Create and set up a camera for the render task to use - * - * @param[in] sizeOfTarget size of the source camera to look at - * @param[out] offscreenCamera custom camera - */ -void CreateCameraActor( const Size& sizeOfTarget, CameraActor& offscreenCamera ) -{ - offscreenCamera = CameraActor::New(); - offscreenCamera.SetOrthographicProjection( sizeOfTarget ); - offscreenCamera.SetInvertYAxis( true ); -} +const int MINIMUM_SCROLL_SPEED = 1; // Speed should be set by Property system. /** - * @brief Create a render task + * @brief How the text should be aligned horizontally when scrolling the text. * - * @param[in] sourceActor actor to be used as source - * @param[in] cameraActor camera looking at source - * @param[in] offscreenTarget resulting image from render task - * @param[out] renderTask render task that has been setup + * -0.5f aligns the text to the left, 0.0f aligns the text to the center, 0.5f aligns the text to the right. + * The final alignment depends on two factors: + * 1) The alignment value of the text label (Use Text::HorizontalAlignment enumerations). + * 2) The text direction, i.e. whether it's LTR or RTL (0 = LTR, 1 = RTL). */ -void CreateRenderTask( Actor sourceActor, CameraActor cameraActor , FrameBufferImage offscreenTarget, RenderTask& renderTask ) -{ - Stage stage = Stage::GetCurrent(); - RenderTaskList taskList = stage.GetRenderTaskList(); - renderTask = taskList.CreateTask(); - renderTask.SetSourceActor( sourceActor ); - renderTask.SetExclusive( true ); - renderTask.SetInputEnabled( false ); - renderTask.SetClearEnabled( true ); - renderTask.SetCameraActor( cameraActor ); - renderTask.SetTargetFrameBuffer( offscreenTarget ); - renderTask.SetClearColor( Color::TRANSPARENT ); - renderTask.SetCullMode( false ); -} +const float HORIZONTAL_ALIGNMENT_TABLE[Text::HorizontalAlignment::END + 1][2] = + { + // HorizontalAlignment::BEGIN + { + -0.5f, // LTR + 0.5f // RTL + }, + + // HorizontalAlignment::CENTER + { + 0.0f, // LTR + 0.0f // RTL + }, + + // HorizontalAlignment::END + { + 0.5f, // LTR + -0.5f // RTL + }}; /** - * @brief Create quad geometry for the mesh + * @brief How the text should be aligned vertically when scrolling the text. * - * @param[out] geometry quad geometry that can be used for a mesh + * -0.5f aligns the text to the top, 0.0f aligns the text to the center, 0.5f aligns the text to the bottom. + * The alignment depends on the alignment value of the text label (Use Text::VerticalAlignment enumerations). */ -void CreateGeometry( Geometry& geometry ) -{ - struct QuadVertex { Vector2 position; }; - - QuadVertex quadVertexData[4] = +const float VERTICAL_ALIGNMENT_TABLE[Text::VerticalAlignment::BOTTOM + 1] = { - { Vector2( 0.0f, 0.0f) }, - { Vector2( 1.0f, 0.0f) }, - { Vector2( 0.0f, 1.0f) }, - { Vector2( 1.0f, 1.0f) }, - }; + -0.5f, // VerticalAlignment::TOP + 0.0f, // VerticalAlignment::CENTER + 0.5f // VerticalAlignment::BOTTOM +}; - const unsigned short indices[6] = - { - 3,1,0,0,2,3 - }; +} // namespace - Property::Map quadVertexFormat; - quadVertexFormat["aPosition"] = Property::VECTOR2; - PropertyBuffer quadVertices = PropertyBuffer::New( quadVertexFormat ); - quadVertices.SetData(quadVertexData, 4 ); +namespace Text +{ +TextScrollerPtr TextScroller::New(ScrollerInterface& scrollerInterface) +{ + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::New\n"); - geometry = Geometry::New(); - geometry.AddVertexBuffer( quadVertices ); - geometry.SetIndexBuffer( indices, sizeof(indices)/sizeof(indices[0]) ); + TextScrollerPtr textScroller(new TextScroller(scrollerInterface)); + return textScroller; } +void TextScroller::SetGap(int gap) +{ + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::SetGap gap[%d]\n", gap); + mWrapGap = static_cast(gap); +} -/** - * @brief Create a renderer - * - * @param[in] frameBufferImage texture to be used - * @param[out] renderer mesh renderer using the supplied texture - */ -void CreateRenderer( FrameBufferImage frameBufferImage, Dali::Renderer& renderer ) +int TextScroller::GetGap() const { - Shader shader = Shader::New( VERTEX_SHADER_SCROLL , FRAGMENT_SHADER, Shader::Hint::NONE ); + return static_cast(mWrapGap); +} - Sampler sampler = Sampler::New(); - sampler.SetFilterMode(FilterMode::NEAREST, FilterMode::NEAREST ); +void TextScroller::SetSpeed(int scrollSpeed) +{ + mScrollSpeed = std::max(MINIMUM_SCROLL_SPEED, scrollSpeed); +} - TextureSet textureSet = TextureSet::New(); - TextureSetImage( textureSet, 0u, frameBufferImage ); - textureSet.SetSampler( 0u, sampler ); +int TextScroller::GetSpeed() const +{ + return mScrollSpeed; +} - Geometry meshGeometry; - CreateGeometry( meshGeometry ); +void TextScroller::SetLoopCount(int loopCount) +{ + if(loopCount >= 0) + { + mLoopCount = loopCount; + } - renderer = Renderer::New( meshGeometry, shader ); - renderer.SetTextures( textureSet ); + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::SetLoopCount [%d] Status[%s]\n", mLoopCount, (loopCount) ? "looping" : "stop"); } -} // namespace +int TextScroller::GetLoopCount() const +{ + return mLoopCount; +} -namespace Text +void TextScroller::SetLoopDelay(float delay) { + mLoopDelay = delay; +} -TextScrollerPtr TextScroller::New( ScrollerInterface& scrollerInterface ) +float TextScroller::GetLoopDelay() const { - DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::New\n" ); + return mLoopDelay; +} - TextScrollerPtr textScroller( new TextScroller( scrollerInterface) ); - return textScroller; +void TextScroller::SetStopMode(TextLabel::AutoScrollStopMode::Type stopMode) +{ + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::SetAutoScrollStopMode [%s]\n", (stopMode == TextLabel::AutoScrollStopMode::IMMEDIATE) ? "IMMEDIATE" : "FINISH_LOOP"); + mStopMode = stopMode; } -Actor TextScroller::GetSourceCamera() const +void TextScroller::StopScrolling() { - return mOffscreenCameraActor; + if(mScrollAnimation && mScrollAnimation.GetState() == Animation::PLAYING) + { + switch(mStopMode) + { + case TextLabel::AutoScrollStopMode::IMMEDIATE: + { + mScrollAnimation.Stop(); + mScrollerInterface.ScrollingFinished(); + break; + } + case TextLabel::AutoScrollStopMode::FINISH_LOOP: + { + mScrollAnimation.SetLoopCount(1); // As animation already playing this allows the current animation to finish instead of trying to stop mid-way + break; + } + default: + { + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "Undifined AutoScrollStopMode\n"); + } + } + } + else + { + mScrollerInterface.ScrollingFinished(); + } } -Actor TextScroller::GetScrollingText() const +TextLabel::AutoScrollStopMode::Type TextScroller::GetStopMode() const { - return mScrollingTextActor; + return mStopMode; } -TextScroller::TextScroller( ScrollerInterface& scrollerInterface ) -: mScrollerInterface( scrollerInterface ), - mScrollDeltaIndex( Property::INVALID_INDEX ) +TextScroller::TextScroller(ScrollerInterface& scrollerInterface) +: mScrollerInterface(scrollerInterface), + mScrollDeltaIndex(Property::INVALID_INDEX), + mScrollSpeed(MINIMUM_SCROLL_SPEED), + mLoopCount(1), + mLoopDelay(0.0f), + mWrapGap(0.0f), + mStopMode(TextLabel::AutoScrollStopMode::FINISH_LOOP) { - DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller Default Constructor\n" ); + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller Default Constructor\n"); } TextScroller::~TextScroller() { - CleanUp(); } -void TextScroller::StartScrolling( Actor sourceActor, - const ScrollerData& data ) +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) { - DALI_LOG_INFO( gLogFilter, - Debug::Verbose, - "TextScroller::StartScrolling controlSize[%f,%f] offscreenSize[%f,%f] direction[%d] alignmentOffset[%f]\n", - data.mControlSize.x, data.mControlSize.y, - data.mOffscreenSize.x, data.mOffscreenSize.y, - data.mAutoScrollDirectionRTL, - data.mAlignmentOffset ); - - FrameBufferImage offscreenRenderTargetForText = FrameBufferImage::New( data.mOffscreenSize.width, data.mOffscreenSize.height, Pixel::RGBA8888 ); - Renderer renderer; - - CreateCameraActor( data.mOffscreenSize, mOffscreenCameraActor ); - CreateRenderer( offscreenRenderTargetForText, renderer ); - CreateRenderTask( sourceActor, mOffscreenCameraActor, offscreenRenderTargetForText, mRenderTask ); - - // Reposition camera to match alignment of target, RTL text has direction=true - if( data.mAutoScrollDirectionRTL ) + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::SetParameters controlSize[%f,%f] textureSize[%f,%f] direction[%d]\n", controlSize.x, controlSize.y, textureSize.x, textureSize.y, direction); + + mRenderer = renderer; + + float animationProgress = 0.0f; + int remainedLoop = mLoopCount; + if(mScrollAnimation) { - mOffscreenCameraActor.SetX( data.mAlignmentOffset + data.mOffscreenSize.width * 0.5f ); + if(mScrollAnimation.GetState() == Animation::PLAYING) + { + animationProgress = mScrollAnimation.GetCurrentProgress(); + + if(mLoopCount > 0) // If not a ininity loop, then calculate remained loop + { + remainedLoop = mLoopCount - (mScrollAnimation.GetCurrentLoop()); + remainedLoop = (remainedLoop <= 0 ? 1 : remainedLoop); + } + } + mScrollAnimation.Clear(); + + // Reset to the original shader and texture before scrolling + mRenderer.SetShader(mShader); + if(mTextureSet) + { + mRenderer.SetTextures(mTextureSet); + } + } + + mShader = mRenderer.GetShader(); + mTextureSet = mRenderer.GetTextures(); + + // Set the shader and texture for scrolling + Shader shader = Shader::New(SHADER_TEXT_SCROLLER_SHADER_VERT, SHADER_TEXT_SCROLLER_SHADER_FRAG, Shader::Hint::NONE); + mRenderer.SetShader(shader); + mRenderer.SetTextures(textureSet); + + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::SetParameters wrapGap[%f]\n", wrapGap); + + float horizontalAlign; + + if(textureSize.x > controlSize.x) + { + // if Text is elided, scroll should start at the begin of text. + horizontalAlign = HORIZONTAL_ALIGNMENT_TABLE[HorizontalAlignment::BEGIN][direction]; } else { - mOffscreenCameraActor.SetX( data.mOffscreenSize.width * 0.5f ); + horizontalAlign = HORIZONTAL_ALIGNMENT_TABLE[horizontalAlignment][direction]; } - mOffscreenCameraActor.SetY( data.mOffscreenSize.height * 0.5f ); + const float verticalAlign = VERTICAL_ALIGNMENT_TABLE[verticalAlignment]; - DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetParameters mWrapGap[%f]\n", data.mWrapGap ) + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::SetParameters horizontalAlign[%f], verticalAlign[%f]\n", horizontalAlign, verticalAlign); - mScrollingTextActor = Actor::New(); - mScrollingTextActor.AddRenderer( renderer ); - mScrollingTextActor.RegisterProperty( "uTextureSize", data.mOffscreenSize ); - mScrollingTextActor.RegisterProperty( "uRtl", ( data.mAutoScrollDirectionRTL ? 1.f : 0.f ) ); - mScrollingTextActor.RegisterProperty( "uGap", data.mWrapGap ); - mScrollingTextActor.SetSize( data.mControlSize.width, std::min( data.mOffscreenSize.height, data.mControlSize.height ) ); - mScrollDeltaIndex = mScrollingTextActor.RegisterProperty( "uDelta", 0.0f ); + shader.RegisterProperty("uTextureSize", textureSize); + shader.RegisterProperty("uHorizontalAlign", horizontalAlign); + shader.RegisterProperty("uVerticalAlign", verticalAlign); + shader.RegisterProperty("uGap", wrapGap); + mScrollDeltaIndex = shader.RegisterProperty("uDelta", 0.0f); - float scrollAmount = std::max( data.mOffscreenSize.width + data.mWrapGap, data.mControlSize.width ); - float scrollSpeed = std::max( MINIMUM_SCROLL_SPEED, data.mScrollSpeed ); - float scrollDuration = scrollAmount / scrollSpeed; + float scrollAmount = std::max(textureSize.width, controlSize.width); + float scrollDuration = scrollAmount / mScrollSpeed; - if( data.mAutoScrollDirectionRTL ) + if(direction) { - scrollAmount = -scrollAmount; // reverse direction of scrollung + scrollAmount = -scrollAmount; // reverse direction of scrolling } - mScrollAnimation = Animation::New( scrollDuration ); - mScrollAnimation.AnimateTo( Property( mScrollingTextActor, mScrollDeltaIndex ), scrollAmount ); - mScrollAnimation.SetEndAction( Animation::Discard ); - mScrollAnimation.SetLoopCount( data.mLoopCount ); - mScrollAnimation.FinishedSignal().Connect( this, &TextScroller::AutoScrollAnimationFinished ); - mScrollAnimation.Play(); + StartScrolling(scrollingTextActor, scrollAmount, scrollDuration, remainedLoop); + mScrollAnimation.SetCurrentProgress(animationProgress); } -void TextScroller::StopScrolling() +void TextScroller::AutoScrollAnimationFinished(Dali::Animation& animation) { - if( mScrollAnimation && - ( mScrollAnimation.GetState() == Animation::PLAYING ) ) + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::AutoScrollAnimationFinished\n"); + mScrollerInterface.ScrollingFinished(); + + // Revert to the original shader and texture after scrolling + mRenderer.SetShader(mShader); + if(mTextureSet) { - DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::SetLoopCount Single loop forced\n" ); - mScrollAnimation.SetLoopCount( 1 ); // As animation already playing this allows the current animation to finish instead of trying to stop mid-way + mRenderer.SetTextures(mTextureSet); } } -void TextScroller::AutoScrollAnimationFinished( Dali::Animation& animation ) -{ - DALI_LOG_INFO( gLogFilter, Debug::Verbose, "TextScroller::AutoScrollAnimationFinished\n" ); - CleanUp(); - mScrollerInterface.ScrollingFinished(); -} - -void TextScroller::CleanUp() +void TextScroller::StartScrolling(Actor scrollingTextActor, float scrollAmount, float scrollDuration, int loopCount) { - if ( Stage::IsInstalled() ) - { - Stage stage = Stage::GetCurrent(); - RenderTaskList taskList = stage.GetRenderTaskList(); - UnparentAndReset( mScrollingTextActor ); - UnparentAndReset( mOffscreenCameraActor ); - taskList.RemoveTask( mRenderTask ); - } + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "TextScroller::StartScrolling scrollAmount[%f] scrollDuration[%f], loop[%d] speed[%d]\n", scrollAmount, scrollDuration, loopCount, mScrollSpeed); + + Shader shader = mRenderer.GetShader(); + mScrollAnimation = Animation::New(scrollDuration); + mScrollAnimation.AnimateTo(Property(shader, mScrollDeltaIndex), scrollAmount, TimePeriod(mLoopDelay, scrollDuration)); + mScrollAnimation.SetEndAction(Animation::DISCARD); + mScrollAnimation.SetLoopCount(loopCount); + mScrollAnimation.FinishedSignal().Connect(this, &TextScroller::AutoScrollAnimationFinished); + mScrollAnimation.Play(); } } // namespace Text