Text scrolling quality improvement

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-scroller.h

diff --git a/dali-toolkit/internal/text/text-scroller.h b/dali-toolkit/internal/text/text-scroller.h
index 2d611bb..a7a6410 100644 (file)
--- a/dali-toolkit/internal/text/text-scroller.h
+++ b/dali-toolkit/internal/text/text-scroller.h
@@ -22,11 +22,12 @@
 #include <dali/public-api/actors/camera-actor.h>
 #include <dali/public-api/animation/animation.h>
 #include <dali/public-api/render-tasks/render-task.h>
+#include <dali/public-api/rendering/renderer.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
+#include <dali-toolkit/public-api/text/text-enumerations.h>
+#include <dali-toolkit/public-api/controls/text-controls/text-label.h>
 #include <dali-toolkit/internal/text/text-definitions.h>
-#include <dali-toolkit/internal/text/layouts/layout-alignment.h>
 
 namespace Dali
 {
@@ -60,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, float alignmentOffset, Layout::HorizontalAlignment horizontalAlignment );
+  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
@@ -121,7 +125,7 @@ public:
    * @brief Set the mode of scrolling stop
    * @param[in] stopMode type when text scrolling is stoped.
    */
-  void SetStopMode( DevelTextLabel::AutoScrollStopMode::Type stopMode );
+  void SetStopMode( TextLabel::AutoScrollStopMode::Type stopMode );
 
   /**
    * @brief Stop the auto scrolling.
@@ -132,19 +136,7 @@ public:
    * @brief Get the mode of scrolling stop
    * @return stopMode type when text scrolling is stoped.
    */
-  DevelTextLabel::AutoScrollStopMode::Type GetStopMode() const;
-
-  /**
-   * @brief Get the camera used to look at source, should be added to the parent of target actor.
-   * @return camera Actor
-   */
-  Actor GetSourceCamera() const;
-
-  /**
-   * @brief Get the resulting scrolling text actor, add to target actor which will show scrolling text
-   * @return mesh Actor
-   */
-  Actor GetScrollingText() const;
+  TextLabel::AutoScrollStopMode::Type GetStopMode() const;
 
 private: // Implementation
 
@@ -172,31 +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
   float mLoopDelay;                                     ///< Time delay of loop start
   float mWrapGap;                                       ///< Gap before text wraps around when scrolling
-  DevelTextLabel::AutoScrollStopMode::Type  mStopMode;  ///< Stop mode of scrolling text, when loop count is 0.
+  TextLabel::AutoScrollStopMode::Type  mStopMode;       ///< Stop mode of scrolling text, when loop count is 0.
 
 }; // TextScroller class