dali-toolkit/internal/text/text-scroller.h

   1 #ifndef __DALI_TOOLKIT_TEXT_SCROLLER_H__
   2 #define __DALI_TOOLKIT_TEXT_SCROLLER_H__
   3
   4 /*
   5  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/camera-actor.h>
  23 #include <dali/public-api/animation/animation.h>
  24 #include <dali/public-api/render-tasks/render-task.h>
  25 #include <dali/public-api/rendering/renderer.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
  29 #include <dali-toolkit/internal/text/text-definitions.h>
  30 #include <dali-toolkit/internal/text/layouts/layout-alignment.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Text
  39 {
  40
  41 class TextScroller;
  42 class ScrollerInterface;
  43
  44 typedef IntrusivePtr<TextScroller> TextScrollerPtr;
  45
  46 /**
  47  * @brief A helper class for scrolling text
  48  */
  49 class TextScroller : public RefObject, public ConnectionTracker
  50 {
  51 public:
  52
  53   /**
  54    * @brief Text Scrolling helper, used to automatically scroll text, SetParameters should be called before scrolling is needed.
  55    * CleanUp removes the Scrolling actors from stage whilst keeping the Scroller object alive and preserving Speed, Gap and Loop count.
  56    *
  57    * @param[in] scrollerInterface scroller interface
  58    */
  59   static TextScrollerPtr New( ScrollerInterface& scrollerInterface );
  60
  61   /**
  62    * @brief Set parameters relating to source required for scrolling
  63    *
  64    * @param[in] scrollingTextActor actor containing the text to be scrolled
  65    * @param[in] renderer renderer to render the text
  66    * @param[in] textureSet texture of the text to be scrolled
  67    * @param[in] controlSize size of the control to scroll within
  68    * @param[in] textNaturalSize natural size of the text
  69    * @param[in] direction text direction true for right to left text
  70    * @param[in] horizontalAlignment horizontal alignment of the text
  71    * @param[in] verticalAlignment vertical alignment of the text
  72    */
  73   void SetParameters( Actor scrollingTextActor, Dali::Renderer renderer, TextureSet textureSet, const Size& controlSize, const Size& offScreenSize, CharacterDirection direction, Layout::HorizontalAlignment horizontalAlignment, Layout::VerticalAlignment verticalAlignment );
  74
  75   /**
  76    * @brief Set the gap distance to elapse before the text wraps around
  77    * @param[in] gap distance to elapse
  78    */
  79   void SetGap( int gap );
  80
  81   /**
  82    * @brief Get the distance before scrolling wraps
  83    * @return gap distance to elapse
  84    */
  85   int GetGap() const;
  86
  87   /**
  88    * @brief Set speed the text should scroll
  89    * @param[in] scrollSpeed pixels per second
  90    */
  91   void SetSpeed( int scrollSpeed );
  92
  93   /**
  94    * @brief Get the speed of text scrolling
  95    * @return speed in pixels per second
  96    */
  97   int GetSpeed() const;
  98
  99   /**
 100    * @brief Set the number of times the text scrolling should loop, can stop current scrolling by passing in 0;
 101    * @param[in] loopCount number of times the scrolled text should loop, 0 to stop scrolling
 102    */
 103   void SetLoopCount( int loopCount );
 104
 105   /**
 106    * @brief Get the number of loops
 107    * @return int number of loops
 108    */
 109   int GetLoopCount() const;
 110
 111   /**
 112    * @brief Set the delay time of scroll animation loop
 113    * @param[in] float delay time seconds of loops
 114    */
 115   void SetLoopDelay( float delay );
 116
 117   /**
 118    * @brief Get the delay time of scroll
 119    * @return float delay time seconds of loops
 120    */
 121   float GetLoopDelay() const;
 122
 123   /**
 124    * @brief Set the mode of scrolling stop
 125    * @param[in] stopMode type when text scrolling is stoped.
 126    */
 127   void SetStopMode( DevelTextLabel::AutoScrollStopMode::Type stopMode );
 128
 129   /**
 130    * @brief Stop the auto scrolling.
 131    */
 132   void StopScrolling();
 133
 134   /**
 135    * @brief Get the mode of scrolling stop
 136    * @return stopMode type when text scrolling is stoped.
 137    */
 138   DevelTextLabel::AutoScrollStopMode::Type GetStopMode() const;
 139
 140 private: // Implementation
 141
 142   /**
 143    * Constructor
 144    */
 145   TextScroller( ScrollerInterface& scrollerInterface );
 146
 147   /**
 148    * Destructor
 149    */
 150   ~TextScroller();
 151
 152   // Undefined
 153   TextScroller( const TextScroller& handle );
 154
 155   // Undefined
 156   TextScroller& operator=( const TextScroller& handle );
 157
 158   /**
 159    * @brief Callback for end of animation
 160    * @param[in] animation Animation handle
 161    */
 162   void AutoScrollAnimationFinished( Dali::Animation& animation );
 163
 164   /**
 165    * @brief variables required to set up scrolling animation
 166    * @param[in] scrollingTextActor actor that shows scrolling text
 167    * @param[in] scrollAmount distance to animate text for the given duration
 168    * @param[in] scrollDuration duration of aninmation
 169    * @param[in] loopCount number of times to loop the scrolling text
 170    */
 171   void StartScrolling( Actor scrollingTextActor, float scrollAmount, float scrollDuration, int loopCount );
 172
 173 private:
 174
 175   ScrollerInterface& mScrollerInterface;        // Interface implemented by control that requires scrolling
 176   Property::Index    mScrollDeltaIndex;         // Property used by shader to represent distance to scroll
 177   Animation          mScrollAnimation;          // Animation used to update the mScrollDeltaIndex
 178   Dali::Renderer     mRenderer;                 // Renderer used to render the text
 179   Shader             mShader;                   // Shader originally used by the renderer while not scrolling
 180   TextureSet         mTextureSet;               // Texture originally used by the renderer while not scrolling
 181
 182   int   mScrollSpeed;                                   ///< Speed which text should automatically scroll at
 183   int   mLoopCount;                                     ///< Number of time the text should scroll
 184   float mLoopDelay;                                     ///< Time delay of loop start
 185   float mWrapGap;                                       ///< Gap before text wraps around when scrolling
 186   DevelTextLabel::AutoScrollStopMode::Type  mStopMode;  ///< Stop mode of scrolling text, when loop count is 0.
 187
 188 }; // TextScroller class
 189
 190 } // namespace Text
 191
 192 } // namespace Toolkit
 193
 194 } // namespace Dali
 195
 196 #endif // __DALI_TOOLKIT_TEXT_SCROLLER_H__
 197