1 #ifndef __DALI_TOOLKIT_TEXT_SCROLLER_H__
2 #define __DALI_TOOLKIT_TEXT_SCROLLER_H__
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
27 #include <dali-toolkit/internal/text/text-definitions.h>
39 class ScrollerInterface;
41 typedef IntrusivePtr<TextScroller> TextScrollerPtr;
44 * @brief A helper class for scrolling text
46 class TextScroller : public RefObject, public ConnectionTracker
51 * @brief Text Scrolling helper, used to automatically scroll text, SetParameters should be called before scrolling is needed.
52 * CleanUp removes the Scrolling actors from stage whilst keeping the Scroller object alive and preserving Speed, Gap and Loop count.
54 * @param[in] scrollerInterface scroller interface
56 static TextScrollerPtr New( ScrollerInterface& scrollerInterface );
59 * @brief Set parameters relating to source required for scrolling
61 * @param[in] sourceActor source actor to be scrolled
62 * @param[in] controlSize size of the control to scroll within
63 * @param[in] offScreenSize size of the sourceActor
64 * @param[in] direction text direction true for right to left text
65 * @param[in] alignmentOffset alignment of source text
68 void SetParameters( Actor sourceActor, const Size& controlSize, const Size& offScreenSize, CharacterDirection direction, float alignmentOffset );
71 * @brief Set the gap distance to elapse before the text wraps around
72 * @param[in] gap distance to elapse
74 void SetGap( int gap );
77 * @brief Get the distance before scrolling wraps
78 * @return gap distance to elapse
83 * @brief Set speed the text should scroll
84 * @param[in] scrollSpeed pixels per second
86 void SetSpeed( int scrollSpeed );
89 * @brief Get the speed of text scrolling
90 * @return speed in pixels per second
95 * @brief Set the number of times the text scrolling should loop, can stop current scrolling by passing in 0;
96 * @param[in] loopCount number of times the scrolled text should loop, 0 to stop scrolling
98 void SetLoopCount( int loopCount );
101 * @brief Get the number of loops
102 * @return int number of loops
104 int GetLoopCount() const;
107 * @brief Set the delay time of scroll animation loop
108 * @param[in] float delay time seconds of loops
110 void SetLoopDelay( float delay );
113 * @brief Get the delay time of scroll
114 * @return float delay time seconds of loops
116 float GetLoopDelay() const;
119 * @brief Get the camera used to look at source, should be added to the parent of target actor.
120 * @return camera Actor
122 Actor GetSourceCamera() const;
125 * @brief Get the resulting scrolling text actor, add to target actor which will show scrolling text
128 Actor GetScrollingText() const;
130 private: // Implementation
135 TextScroller( ScrollerInterface& scrollerInterface );
143 TextScroller( const TextScroller& handle );
146 TextScroller& operator=( const TextScroller& handle );
149 * @brief Callback for end of animation
150 * @param[in] animation Animation handle
152 void AutoScrollAnimationFinished( Dali::Animation& animation );
155 * @brief variables required to set up scrolling animation
156 * @param[in] scrollAmount distance to animate text for the given duration
157 * @param[in] scrollDuration duration of aninmation
158 * @param[in] loopCount number of times to loop the scrolling text
160 void StartScrolling( float scrollAmount, float scrollDuration, int loopCount );
163 * @brief When scrolling ended, the actors are cleaned up so no longer staged.
169 RenderTask mRenderTask; // Renders full text to a FrameBuffer which is then scrolled.
170 CameraActor mOffscreenCameraActor; // Camera used by render task
171 Actor mScrollingTextActor; // Actor used to show scrolling text
172 ScrollerInterface& mScrollerInterface; // Interface implemented by control that requires scrolling
173 Property::Index mScrollDeltaIndex; // Property used by shader to represent distance to scroll
174 Animation mScrollAnimation; // Animation used to update the mScrollDeltaIndex
176 int mScrollSpeed; ///< Speed which text should automatically scroll at
177 int mLoopCount; ///< Number of time the text should scroll
178 float mLoopDelay; ///< Time delay of loop start
179 float mWrapGap; ///< Gap before text wraps around when scrolling
181 }; // TextScroller class
185 } // namespace Toolkit
189 #endif // __DALI_TOOLKIT_TEXT_SCROLLER_H__