X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-scroller.h;h=16e350a7b37d847345e610f4f5cce3c1f28a9996;hp=d4f92b9910668aad550e3a3737add7f708525683;hb=528aa3699cd51dab5115bca1aaebb65d4bc67c15;hpb=348f6480ca53f0a1c869d2da077ee3b5e3e405eb diff --git a/dali-toolkit/internal/text/text-scroller.h b/dali-toolkit/internal/text/text-scroller.h index d4f92b9..16e350a 100644 --- a/dali-toolkit/internal/text/text-scroller.h +++ b/dali-toolkit/internal/text/text-scroller.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_TEXT_SCROLLER_H__ -#define __DALI_TOOLKIT_TEXT_SCROLLER_H__ +#ifndef DALI_TOOLKIT_TEXT_SCROLLER_H +#define DALI_TOOLKIT_TEXT_SCROLLER_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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. @@ -22,8 +22,11 @@ #include #include #include +#include // INTERNAL INCLUDES +#include +#include #include namespace Dali @@ -58,14 +61,17 @@ public: /** * @brief Set parameters relating to source required for scrolling * - * @param[in] sourceActor source actor to be scrolled + * @param[in] scrollingTextActor actor containing the text to be scrolled + * @param[in] renderer renderer to render the text + * @param[in] textureSet texture of the text to be scrolled * @param[in] controlSize size of the control to scroll within - * @param[in] offScreenSize size of the sourceActor + * @param[in] textureSize size of the texture + * @param[in] wrapGap The gap before scrolling wraps * @param[in] direction text direction true for right to left text - * @param[in] alignmentOffset alignment of source text - * + * @param[in] horizontalAlignment horizontal alignment of the text + * @param[in] verticalAlignment vertical alignment of the text */ - void SetParameters( Actor sourceActor, const Size& controlSize, const Size& offScreenSize, CharacterDirection direction, const Vector2 alignmentOffset ); + void SetParameters( Actor scrollingTextActor, Dali::Renderer renderer, TextureSet textureSet, const Size& controlSize, const Size& textureSize, const float wrapGap, CharacterDirection direction, HorizontalAlignment::Type horizontalAlignment, VerticalAlignment::Type verticalAlignment ); /** * @brief Set the gap distance to elapse before the text wraps around @@ -104,16 +110,33 @@ public: int GetLoopCount() const; /** - * @brief Get the camera used to look at source, should be added to the parent of target actor. - * @return camera Actor + * @brief Set the delay time of scroll animation loop + * @param[in] float delay time seconds of loops + */ + void SetLoopDelay( float delay ); + + /** + * @brief Get the delay time of scroll + * @return float delay time seconds of loops + */ + float GetLoopDelay() const; + + /** + * @brief Set the mode of scrolling stop + * @param[in] stopMode type when text scrolling is stoped. */ - Actor GetSourceCamera() const; + void SetStopMode( TextLabel::AutoScrollStopMode::Type stopMode ); /** - * @brief Get the resulting scrolling text actor, add to target actor which will show scrolling text - * @return mesh Actor + * @brief Stop the auto scrolling. */ - Actor GetScrollingText() const; + void StopScrolling(); + + /** + * @brief Get the mode of scrolling stop + * @return stopMode type when text scrolling is stoped. + */ + TextLabel::AutoScrollStopMode::Type GetStopMode() const; private: // Implementation @@ -141,29 +164,27 @@ private: // Implementation /** * @brief variables required to set up scrolling animation + * @param[in] scrollingTextActor actor that shows scrolling text * @param[in] scrollAmount distance to animate text for the given duration * @param[in] scrollDuration duration of aninmation * @param[in] loopCount number of times to loop the scrolling text */ - void StartScrolling( float scrollAmount, float scrollDuration, int loopCount ); - - /** - * @brief When scrolling ended, the actors are cleaned up so no longer staged. - */ - void CleanUp(); + void StartScrolling( Actor scrollingTextActor, float scrollAmount, float scrollDuration, int loopCount ); private: - RenderTask mRenderTask; // Renders full text to a FrameBuffer which is then scrolled. - CameraActor mOffscreenCameraActor; // Camera used by render task - Actor mScrollingTextActor; // Actor used to show scrolling text ScrollerInterface& mScrollerInterface; // Interface implemented by control that requires scrolling Property::Index mScrollDeltaIndex; // Property used by shader to represent distance to scroll Animation mScrollAnimation; // Animation used to update the mScrollDeltaIndex + Dali::Renderer mRenderer; // Renderer used to render the text + Shader mShader; // Shader originally used by the renderer while not scrolling + TextureSet mTextureSet; // Texture originally used by the renderer while not scrolling - int mScrollSpeed; ///< Speed which text should automatically scroll at - int mLoopCount; ///< Number of time the text should scroll - int mWrapGap; ///< Gap before text wraps around when scrolling + int mScrollSpeed; ///< Speed which text should automatically scroll at + int mLoopCount; ///< Number of time the text should scroll + float mLoopDelay; ///< Time delay of loop start + float mWrapGap; ///< Gap before text wraps around when scrolling + TextLabel::AutoScrollStopMode::Type mStopMode; ///< Stop mode of scrolling text, when loop count is 0. }; // TextScroller class @@ -173,5 +194,5 @@ private: } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_SCROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_SCROLLER_H