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>
25 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
28 #include <dali-toolkit/internal/text/text-definitions.h>
40 class ScrollerInterface;
42 typedef IntrusivePtr<TextScroller> TextScrollerPtr;
45 * @brief A helper class for scrolling text
47 class TextScroller : public RefObject, public ConnectionTracker
52 * @brief Text Scrolling helper, used to automatically scroll text, SetParameters should be called before scrolling is needed.
53 * CleanUp removes the Scrolling actors from stage whilst keeping the Scroller object alive and preserving Speed, Gap and Loop count.
55 * @param[in] scrollerInterface scroller interface
57 static TextScrollerPtr New( ScrollerInterface& scrollerInterface );
60 * @brief Set parameters relating to source required for scrolling
62 * @param[in] sourceActor source actor to be scrolled
63 * @param[in] controlSize size of the control to scroll within
64 * @param[in] offScreenSize size of the sourceActor
65 * @param[in] direction text direction true for right to left text
66 * @param[in] alignmentOffset alignment of source text
69 void SetParameters( Actor sourceActor, const Size& controlSize, const Size& offScreenSize, CharacterDirection direction, float alignmentOffset );
72 * @brief Set the gap distance to elapse before the text wraps around
73 * @param[in] gap distance to elapse
75 void SetGap( int gap );
78 * @brief Get the distance before scrolling wraps
79 * @return gap distance to elapse
84 * @brief Set speed the text should scroll
85 * @param[in] scrollSpeed pixels per second
87 void SetSpeed( int scrollSpeed );
90 * @brief Get the speed of text scrolling
91 * @return speed in pixels per second
96 * @brief Set the number of times the text scrolling should loop, can stop current scrolling by passing in 0;
97 * @param[in] loopCount number of times the scrolled text should loop, 0 to stop scrolling
99 void SetLoopCount( int loopCount );
102 * @brief Get the number of loops
103 * @return int number of loops
105 int GetLoopCount() const;
108 * @brief Set the delay time of scroll animation loop
109 * @param[in] float delay time seconds of loops
111 void SetLoopDelay( float delay );
114 * @brief Get the delay time of scroll
115 * @return float delay time seconds of loops
117 float GetLoopDelay() const;
120 * @brief Set the mode of scrolling stop
121 * @param[in] stopMode type when text scrolling is stoped.
123 void SetStopMode( DevelTextLabel::AutoScrollStopMode::Type stopMode );
126 * @brief Stop the auto scrolling.
128 void StopScrolling();
131 * @brief Get the mode of scrolling stop
132 * @return stopMode type when text scrolling is stoped.
134 DevelTextLabel::AutoScrollStopMode::Type GetStopMode() const;
137 * @brief Get the camera used to look at source, should be added to the parent of target actor.
138 * @return camera Actor
140 Actor GetSourceCamera() const;
143 * @brief Get the resulting scrolling text actor, add to target actor which will show scrolling text
146 Actor GetScrollingText() const;
148 private: // Implementation
153 TextScroller( ScrollerInterface& scrollerInterface );
161 TextScroller( const TextScroller& handle );
164 TextScroller& operator=( const TextScroller& handle );
167 * @brief Callback for end of animation
168 * @param[in] animation Animation handle
170 void AutoScrollAnimationFinished( Dali::Animation& animation );
173 * @brief variables required to set up scrolling animation
174 * @param[in] scrollAmount distance to animate text for the given duration
175 * @param[in] scrollDuration duration of aninmation
176 * @param[in] loopCount number of times to loop the scrolling text
178 void StartScrolling( float scrollAmount, float scrollDuration, int loopCount );
181 * @brief When scrolling ended, the actors are cleaned up so no longer staged.
187 RenderTask mRenderTask; // Renders full text to a FrameBuffer which is then scrolled.
188 CameraActor mOffscreenCameraActor; // Camera used by render task
189 Actor mScrollingTextActor; // Actor used to show scrolling text
190 ScrollerInterface& mScrollerInterface; // Interface implemented by control that requires scrolling
191 Property::Index mScrollDeltaIndex; // Property used by shader to represent distance to scroll
192 Animation mScrollAnimation; // Animation used to update the mScrollDeltaIndex
194 int mScrollSpeed; ///< Speed which text should automatically scroll at
195 int mLoopCount; ///< Number of time the text should scroll
196 float mLoopDelay; ///< Time delay of loop start
197 float mWrapGap; ///< Gap before text wraps around when scrolling
198 DevelTextLabel::AutoScrollStopMode::Type mStopMode; ///< Stop mode of scrolling text, when loop count is 0.
200 }; // TextScroller class
204 } // namespace Toolkit
208 #endif // __DALI_TOOLKIT_TEXT_SCROLLER_H__