1 #ifndef __DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H__
2 #define __DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H__
5 * Copyright (c) 2014 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/devel-api/common/map-wrapper.h>
23 #include <dali/public-api/actors/layer.h>
24 #include <dali/public-api/actors/camera-actor.h>
25 #include <dali/public-api/images/frame-buffer-image.h>
26 #include <dali/public-api/render-tasks/render-task.h>
29 #include <dali-toolkit/public-api/controls/control-impl.h>
30 #include <dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h>
31 #include <dali-toolkit/public-api/controls/page-turn-view/page-factory.h>
32 #include <dali-toolkit/devel-api/controls/shadow-view/shadow-view.h>
43 class PageTurnView : public Control
49 * It initializes the PageTurnView members
51 PageTurnView( PageFactory& pageFactory, const Vector2& pageSize );
54 * A reference counted object may only be deleted by calling Unreference()
56 virtual ~PageTurnView();
62 * @param[in] pageSize The size of pages
64 void SetPageSize( const Vector2& pageSize );
67 * Retrieve the page size.
68 * @return The page size.
70 Vector2 GetPageSize();
73 * Set the spine shadow parameter to the shader effects.
74 * The two parameters are the major&minor radius (in pixels) to form an ellipse shape.
75 * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow.
76 * @param [in] spineShadowParameter The major&minor ellipse radius for the simulated spine shadow.
78 void SetSpineShadowParameter( const Vector2& spineShadowParameter );
81 * Retrieve the spine shadow parameter of the shader effects.
82 * @return The spine shadow parameter.
84 Vector2 GetSpineShadowParameter();
87 * Jump to a given page.
88 * @param[in] pageId The new current page id.
90 void GoToPage( unsigned int pageId );
93 * Retrieve the id of the current Page.
94 * @return The current page id.
96 unsigned int GetCurrentPage();
101 * This method gets a page from the factory and add to the control
102 * to keep NUMBER_OF_CACHED_PAGES_EACH_SIDE pages available in each side
103 * @param[in] pageIndex The index of the page to be added
105 void AddPage( int pageIndex );
108 * This method removes a page from the control
109 * to keep only NUMBER_OF_CACHED_PAGES_EACH_SIDE pages available in each side
110 * @param[in] pageIndex The index of the page to be removed
112 void RemovePage( int pageIndex );
115 * This method updates the actor and animation states after one page is turned over
116 * This method is a callback, connected when receiving the finished signal of a page turning over animation.
117 * @param [in] the page turning over animation handle
119 void TurnedOver( Animation& animation );
122 * This method organize the depth of the pages on stage
123 * It is called when there is page added or removed from the control
125 void OrganizePageDepth();
128 * Set shader Effect to the actor.
129 * If the actor has children, the shader effect is also applied to its first child
130 * @param[in] actor The actor which the shader effect would be applied onto
131 * @param[in] shaderEffect The shader effect to be set to the actor
133 void SetShaderEffect( ImageActor actor, ShaderEffect shaderEffect );
138 * Set up the shadow view control to cast shadow
140 void SetupShadowView();
143 * This method defines the processes when the pan started, gets called by OnPan( .. )
144 * @param[in] gesturePosition The current touch position in local page actor coordinates.
146 void PanStarted( const Vector2& gesturePosition );
149 * This method defines the processes when the pan continuing, gets called by OnPan( .. )
150 * @param[in] gesturePosition The current touch position in local page actor coordinates.
152 void PanContinuing( const Vector2& gesturePosition );
155 * This method defines the processes when the pan finished, gets called by OnPanGesture( .. )
156 * @param[in] gesturePosition The current touch position in local page actor coordinates.
157 * @param[in] gestureSpeed The speed of the pan ( in pixels per millisecond )
159 void PanFinished( const Vector2& gesturePosition, float gestureSpeed );
162 * This method updates the actor and the animation states after one page is slidden back instead of turned over
163 * This method is a callback, connected when receiving the finished signal of a page sliding back animation.
164 * @param [in] the page sliding back animation handle
166 void SliddenBack( Animation& animation );
169 private: // from Control
172 * @copydoc Toolkit::Control::OnPan
174 virtual void OnPan( const PanGesture& gesture );
177 * @copydoc Toolkit::Control::OnInitialize
179 virtual void OnInitialize();
182 * @copydoc CustomActorImpl::OnStageConnection()
184 virtual void OnStageConnection( int depth );
187 * @copydoc CustomActorImpl::OnStageDisconnection()
189 virtual void OnStageDisconnection();
191 private: // implemented differently by PageTurnLandscapeView and PageTurnPortraitView
194 * This method is called after the pageTurnView initialization.
195 * To set the size of the control size and the parent origin of turning page layer
196 * Implemented in subclasses to provide specific behaviour.
198 virtual void OnPageTurnViewInitialize() = 0;
201 * This method is called after the a new page is added to the stage.
202 * Could be re-implemented in subclasses to provide specific behaviour
203 * @param[in] newPage The added page actor
204 * @param[in] isLeftSide Which side the new page is added to
206 virtual void OnAddPage( ImageActor newPage, bool isLeftSide ) { }
209 * This method is called when pan started or continuing
210 * to calculate the pan position in local page actor coordinate given the pan position in control coordinate
211 * Implemented in subclasses to provide specific behaviour.
212 * @param[in] gesturePosition The pan position in the control coordinate
213 * @return The pan position in the page actor local coordinate
215 virtual Vector2 SetPanPosition( const Vector2& gesturePosition ) = 0;
218 * This method is called when pan started to determined which page is panned given the pan position in control coordinate
219 * Implemented in subclasses to provide specific behaviour.
220 * @param[in] gesturePosition The pan position in the control coordinate
222 virtual void SetPanActor( const Vector2& panPosition ) = 0;
225 * This method is called when a page is turned over or slidden back
226 * Remove PageTurnEffect and use a proper PageTurnBookSpineEffect
227 * Implemented in subclasses to provide specific behaviour.
228 * @param[in] actor The current page actor
229 * @param[in] isLeftSide Which side the current page is located
231 virtual void SetSpineEffect(ImageActor actor, bool isLeftSide) = 0;
234 * This method is called when pan finished to detect outwards flick
235 * In portrait view, start an animation of turning previous page back when outwards flick is detected
236 * In landscape view, nothing to do
237 * @param[in] panPosition The pan position in the page actor local coordinate
238 * @param[in] gestureSpeed The speed of the pan gesture( in pixels per millisecond )
240 virtual void OnPossibleOutwardsFlick( const Vector2& panPosition, float gestureSpeed ) { }
243 * This method is called when page is turned over
244 * In portrait view, the page on the left side is not rendered
245 * @param[in] actor The page actor
246 * @param[in] isLeftSide Which side the page is turned to
248 virtual void OnTurnedOver( ImageActor actor, bool isLeftSide ) { }
250 public: //signal and property
253 * @copydoc Toolkit::PageTurnView::PageTurnStartedSignal()
255 Toolkit::PageTurnView::PageTurnSignal& PageTurnStartedSignal();
258 * @copydoc Toolkit::PageTurnView::PageTurnFinishedSignal()
260 Toolkit::PageTurnView::PageTurnSignal& PageTurnFinishedSignal();
263 * @copydoc Toolkit::PageTurnView::PagePanStartSignal()
265 Toolkit::PageTurnView::PagePanSignal& PagePanStartedSignal();
268 * @copydoc Toolkit::PageTurnView::PagePanFinishedSignal()
270 Toolkit::PageTurnView::PagePanSignal& PagePanFinishedSignal();
273 * Connects a callback function with the object's signals.
274 * @param[in] object The object providing the signal.
275 * @param[in] tracker Used to disconnect the signal.
276 * @param[in] signalName The signal to connect to.
277 * @param[in] functor A newly allocated FunctorDelegate.
278 * @return True if the signal was connected.
279 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
281 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
286 * Called when a property of an object of this type is set.
287 * @param[in] object The object whose property is set.
288 * @param[in] index The property index.
289 * @param[in] value The new property value.
291 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
294 * Called to retrieve a property of an object of this type.
295 * @param[in] object The object whose property is to be retrieved.
296 * @param[in] index The property index.
297 * @return The current value of the property.
299 static Property::Value GetProperty( BaseObject* object, Property::Index index );
304 PageTurnView( const PageTurnView& );
307 PageTurnView& operator=(const PageTurnView& rhs);
311 Vector2 mControlSize; ///< The size of the control, it is decided by the page size, the SetSize from application can not change it
312 Layer mTurningPageLayer; ///< The layer for the turning page, to avoid possible depth conflict
313 Toolkit::ShadowView mShadowView; ///< The shadow view control for shadow casting
314 ImageActor mShadowPlane; ///< The plane for the shadow to cast on
315 Actor mPointLight; ///< The point light used for shadow casting
317 PageFactory& mPageFactory; ///< The page factory which provides the page actors
318 Vector2 mPageSize; ///< The page size
319 int mTotalPageCount; ///< The total number of pages provided by the page factory
321 bool mPanning; ///< The boolean to indicate whether the pan gesture is continuing
323 std::vector<ShaderEffect> mTurnEffect; ///< The group of PageTurnEffects
324 ShaderEffect mSpineEffectFront; ///< The book spine shader effect without flipping image content
325 ShaderEffect mSpineEffectBack; ///< The book spine shader effect with image content flipped
326 Vector2 mSpineShadowParameter; ///< The spine shadow parameter for all the above shader effects
327 Vector2 mOriginalCenter; ///< The original center set to the PageTurnEffect
328 Vector2 mCurrentCenter; ///< The current center set to the PageTurnEffect
330 std::vector<ImageActor> mPageActors; ///< The vector of pages on stage
331 int mCurrentPageIndex; ///< The index of the current page, between 0 ~ mTotalPageCount-1
332 int mTurningPageIndex; ///< The index of the turning page
333 std::map<ImageActor,bool> mIsTurnBack; ///< The map to keep track the page actor's turning direction
334 std::map<Animation,int> mAnimationPageIdPair; ///< The map to keep track which page actor is the animation act on
335 std::map<Animation, int> mAnimationIndexPair; ///< The map to keep track which PageTurnEffect, PanDisplacementProperty, CurrentCenterProperty is used for the animation
336 int mIndex; ///< The index to keep track which PageTurnEffect, PanDisplacementProperty, CurrentCenterProperty is used for the current panning page
337 std::vector<bool> mIsAnimating; ///< The boolean vector to keep track which PageTurnEffect, PanDisplacementProperty, CurrentCenterProperty is available for using
338 std::vector<bool> mIsSliding; ///< The boolean vector to keep track whether there are animating pages sliding back
340 ImageActor mPanActor; ///< The page being panned by the pan gesture
341 Vector2 mPressDownPosition; ///< The first press down position of the pan gesture
342 bool mPress; ///< The boolean to keep track the state of the pageTurnEffect is activated or not
343 bool mPageUpdated; ///< The boolean to keep track whether is page is updated after any turning activity
345 float mDistanceUpCorner; ///< The distance between the original center of PageTurnEffect and the top-left corner of the page
346 float mDistanceBottomCorner; ///< The distance between the original center of PageTurnEffect and the bottom-left corner of the page
348 std::vector<Property::Index> mPropertyPanDisplacement; ///< The pan displacement property group
349 std::vector<Property::Index> mPropertyCurrentCenter; ///< The current center property group
350 float mPanDisplacement; ///< The displacement of the pan after the constrains are applied
351 bool mConstraints; ///< The boolean to keep track the constrains are applied or not
353 Toolkit::PageTurnView::PageTurnSignal mPageTurnStartedSignal; ///< The signal to notify that a page has started turning
354 Toolkit::PageTurnView::PageTurnSignal mPageTurnFinishedSignal; ///< The signal to notify that a page has finished turning
355 Toolkit::PageTurnView::PagePanSignal mPagePanStartedSignal; ///< The signal to notify that a page has started panning
356 Toolkit::PageTurnView::PagePanSignal mPagePanFinishedSignal; ///< The signal to notify that a page has finished panning
358 static const int MAXIMUM_TURNING_NUM; ///< How many pages are allowed to animating in the same time
359 static const int NUMBER_OF_CACHED_PAGES_EACH_SIDE; ///< The maximum number of pages kept, (MAXIMUM_ANIMATION_NUM+1) pages for each side
360 static const int NUMBER_OF_CACHED_PAGES; ///< The maximum number of pages kept, (MAXIMUM_ANIMATION_NUM+1)*2 pages in total
361 static const float STATIC_PAGE_INTERVAL_DISTANCE; ///< The depth interval between stacked pages (static pages)
364 } // namespace Internal
367 // Helpers for public-api forwarding methods
369 inline Toolkit::Internal::PageTurnView& GetImplementation(Toolkit::PageTurnView& pub)
371 DALI_ASSERT_ALWAYS(pub);
373 Dali::RefObject& handle = pub.GetImplementation();
375 return static_cast<Toolkit::Internal::PageTurnView&>(handle);
378 inline const Toolkit::Internal::PageTurnView& GetImplementation(const Toolkit::PageTurnView& pub)
380 DALI_ASSERT_ALWAYS(pub);
382 const Dali::RefObject& handle = pub.GetImplementation();
384 return static_cast<const Toolkit::Internal::PageTurnView&>(handle);
387 } // namespace Toolkit
390 #endif /* __DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H__ */