X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Fpage-turn-view%2Fpage-turn-view-impl.h;h=3815bd83873adc1d072b6bb3c2383e9437a6c3ed;hp=91a714fbd9a70111bb10a49a0554ccea4d7036e9;hb=29540fc153880d6949c85786b78b8583ae8f1d37;hpb=bfdf7a73a4d50dfb60d0f7fa5b214f61c920bf9c diff --git a/dali-toolkit/internal/controls/page-turn-view/page-turn-view-impl.h b/dali-toolkit/internal/controls/page-turn-view/page-turn-view-impl.h index 91a714f..3815bd8 100644 --- a/dali-toolkit/internal/controls/page-turn-view/page-turn-view-impl.h +++ b/dali-toolkit/internal/controls/page-turn-view/page-turn-view-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H__ -#define __DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H__ +#ifndef DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H +#define DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2016 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,15 +21,12 @@ // EXTERNAL INCLUDES #include #include -#include -#include -#include -#include +#include // INTERNAL INCLUDES #include -#include -#include +#include +#include #include namespace Dali @@ -46,10 +43,87 @@ class PageTurnView : public Control protected: /** + * The book page class + */ + struct Page + { + /** + * Constructor + */ + Page(); + /** + * Destructor + */ + ~Page(){}; + + /** + * Set the page texture content + * @param[in] texture The content of the page. + */ + void SetTexture( Texture texture ); + + /** + * Apply an effect onto the page actor. + * @param[in] newShader The shader for rendering effect. + */ + void UseEffect(Shader newShader); + + /** + * Apply an effect onto the page actor. + * @param[in] newShader The shader for rendering effect. + * @param[in] geometry The geometry for rendering effect. + */ + void UseEffect(Shader newShader, Geometry geometry); + + /** + * Change the page turning direction. + */ + void ChangeTurnDirection(); + + /** + * Set the pan displacement property + * @param[in] value The property value + */ + void SetPanDisplacement(float value); + + /** + * Set the pan center property + * @param[in] value The property value + */ + void SetPanCenter( const Vector2& value ); + + /** + * Set the original center property to be used by shader + * @param[in] value The property value + */ + void SetOriginalCenter( const Vector2& value ); + + /** + * Set the current center property to be used by shader + * @param[in] value The property value + */ + void SetCurrentCenter( const Vector2& value ); + + Actor actor; ///< The page actor + Shader shader; ///< The shader used by the actor + TextureSet textureSet; ///< The set of textures used by the actor + Renderer renderer; ///< The renderer of the actor + bool isTurnBack; ///< The turning direction + Property::Index propertyPanDisplacement; ///< The horizontal displacement of the pan + Property::Index propertyPanCenter; ///< The current pan position + Property::Index propertyOriginalCenter; ///< The original center to be used by the shader + Property::Index propertyCurrentCenter; ///< The current center to be used by the shader + Property::Index propertyTurnDirection; ///< The turning direction property + }; + + +protected: + + /** * Constructor. * It initializes the PageTurnView members */ - PageTurnView( PageFactory& pageFactory, const Vector2& pageSize ); + PageTurnView( PageFactory& pageFactory, const Vector2& viewPageSize ); /** * A reference counted object may only be deleted by calling Unreference() @@ -60,9 +134,9 @@ public: /** * Set the page size - * @param[in] pageSize The size of pages + * @param[in] viewPageSize The size of pages */ - void SetPageSize( const Vector2& pageSize ); + void SetPageSize( const Vector2& viewPageSize ); /** * Retrieve the page size. @@ -125,15 +199,14 @@ protected: */ void OrganizePageDepth(); +private: + /** - * Set shader Effect to the actor. - * If the actor has children, the shader effect is also applied to its first child - * @param[in] actor The actor which the shader effect would be applied onto - * @param[in] shaderEffect The shader effect to be set to the actor + * Create shader from a property map. + * @param[in] shaderMap The shader property map; + * @return The created shader. */ - void SetShaderEffect( ImageActor actor, ShaderEffect shaderEffect ); - -private: + Shader CreateShader( const Property::Map& shaderMap ); /** * Set up the shadow view control to cast shadow @@ -166,6 +239,11 @@ private: */ void SliddenBack( Animation& animation ); + /** + * Stop the page turning animation and contraint. + * This method should be called when taking off stage or jump to a specified page. + */ + void StopTurning(); private: // from Control @@ -180,14 +258,14 @@ private: // from Control virtual void OnInitialize(); /** - * @copydoc CustomActorImpl::OnStageConnection() + * @copydoc CustomActorImpl::OnSceneConnection() */ - virtual void OnStageConnection( int depth ); + virtual void OnSceneConnection( int depth ); /** - * @copydoc CustomActorImpl::OnStageDisconnection() + * @copydoc CustomActorImpl::OnSceneDisconnection() */ - virtual void OnStageDisconnection(); + virtual void OnSceneDisconnection(); private: // implemented differently by PageTurnLandscapeView and PageTurnPortraitView @@ -204,7 +282,7 @@ private: // implemented differently by PageTurnLandscapeView and PageTurnPortrai * @param[in] newPage The added page actor * @param[in] isLeftSide Which side the new page is added to */ - virtual void OnAddPage( ImageActor newPage, bool isLeftSide ) { } + virtual void OnAddPage( Actor newPage, bool isLeftSide ) { } /** * This method is called when pan started or continuing @@ -223,15 +301,6 @@ private: // implemented differently by PageTurnLandscapeView and PageTurnPortrai virtual void SetPanActor( const Vector2& panPosition ) = 0; /** - * This method is called when a page is turned over or slidden back - * Remove PageTurnEffect and use a proper PageTurnBookSpineEffect - * Implemented in subclasses to provide specific behaviour. - * @param[in] actor The current page actor - * @param[in] isLeftSide Which side the current page is located - */ - virtual void SetSpineEffect(ImageActor actor, bool isLeftSide) = 0; - - /** * This method is called when pan finished to detect outwards flick * In portrait view, start an animation of turning previous page back when outwards flick is detected * In landscape view, nothing to do @@ -246,7 +315,7 @@ private: // implemented differently by PageTurnLandscapeView and PageTurnPortrai * @param[in] actor The page actor * @param[in] isLeftSide Which side the page is turned to */ - virtual void OnTurnedOver( ImageActor actor, bool isLeftSide ) { } + virtual void OnTurnedOver( Actor actor, bool isLeftSide ) { } public: //signal and property @@ -309,53 +378,50 @@ private: protected: - Vector2 mControlSize; ///< The size of the control, it is decided by the page size, the SetSize from application can not change it Layer mTurningPageLayer; ///< The layer for the turning page, to avoid possible depth conflict Toolkit::ShadowView mShadowView; ///< The shadow view control for shadow casting Actor mShadowPlaneBackground; ///< The plane for the shadow to cast on Actor mPointLight; ///< The point light used for shadow casting - PageFactory& mPageFactory; ///< The page factory which provides the page actors - Vector2 mPageSize; ///< The page size - int mTotalPageCount; ///< The total number of pages provided by the page factory + PageFactory* const mPageFactory; ///< The factory which provides the page actors + Shader mTurnEffectShader; ///< The group of PageTurnEffects + Shader mSpineEffectShader; ///< The book spine shader effect + Geometry mGeometry; ///< The grid geometry for pages - bool mPanning; ///< The boolean to indicate whether the pan gesture is continuing + std::vector mPages; ///< The vector of pages on stage + std::map mAnimationPageIdPair; ///< The map to keep track which page actor is the animation act on - std::vector mTurnEffect; ///< The group of PageTurnEffects - ShaderEffect mSpineEffectFront; ///< The book spine shader effect without flipping image content - ShaderEffect mSpineEffectBack; ///< The book spine shader effect with image content flipped + Vector2 mPageSize; ///< The page size + Vector2 mControlSize; ///< The size of the control, it is decided by the page size, the SetSize from application can not change it Vector2 mSpineShadowParameter; ///< The spine shadow parameter for all the above shader effects Vector2 mOriginalCenter; ///< The original center set to the PageTurnEffect Vector2 mCurrentCenter; ///< The current center set to the PageTurnEffect - - std::vector mPageActors; ///< The vector of pages on stage - int mCurrentPageIndex; ///< The index of the current page, between 0 ~ mTotalPageCount-1 - int mTurningPageIndex; ///< The index of the turning page - std::map mIsTurnBack; ///< The map to keep track the page actor's turning direction - std::map mAnimationPageIdPair; ///< The map to keep track which page actor is the animation act on - std::map mAnimationIndexPair; ///< The map to keep track which PageTurnEffect, PanDisplacementProperty, CurrentCenterProperty is used for the animation - int mIndex; ///< The index to keep track which PageTurnEffect, PanDisplacementProperty, CurrentCenterProperty is used for the current panning page - std::vector mIsAnimating; ///< The boolean vector to keep track which PageTurnEffect, PanDisplacementProperty, CurrentCenterProperty is available for using - std::vector mIsSliding; ///< The boolean vector to keep track whether there are animating pages sliding back - - ImageActor mPanActor; ///< The page being panned by the pan gesture Vector2 mPressDownPosition; ///< The first press down position of the pan gesture - bool mPress; ///< The boolean to keep track the state of the pageTurnEffect is activated or not - bool mPageUpdated; ///< The boolean to keep track whether is page is updated after any turning activity float mDistanceUpCorner; ///< The distance between the original center of PageTurnEffect and the top-left corner of the page float mDistanceBottomCorner; ///< The distance between the original center of PageTurnEffect and the bottom-left corner of the page - - std::vector mPropertyPanDisplacement; ///< The pan displacement property group - std::vector mPropertyCurrentCenter; ///< The current center property group float mPanDisplacement; ///< The displacement of the pan after the constrains are applied + + int mTotalPageCount; ///< The total number of pages provided by the page factory + int mCurrentPageIndex; ///< The index of the current page, between 0 ~ mTotalPageCount-1 + int mTurningPageIndex; ///< The index of the turning page + int mIndex; ///< The index to keep track which PanDisplacementProperty, CurrentCenterProperty is used for the current panning page + int mSlidingCount; ///< The boolean vector to keep track whether there are animating pages sliding back + int mAnimatingCount; ///< The boolean vector to keep track which PageTurnEffect, PanDisplacementProperty, CurrentCenterProperty is available for using + bool mConstraints; ///< The boolean to keep track the constrains are applied or not + bool mPress; ///< The boolean to keep track the state of the pageTurnEffect is activated or not + bool mPageUpdated; ///< The boolean to keep track whether is page is updated after any turning activity Toolkit::PageTurnView::PageTurnSignal mPageTurnStartedSignal; ///< The signal to notify that a page has started turning Toolkit::PageTurnView::PageTurnSignal mPageTurnFinishedSignal; ///< The signal to notify that a page has finished turning Toolkit::PageTurnView::PagePanSignal mPagePanStartedSignal; ///< The signal to notify that a page has started panning Toolkit::PageTurnView::PagePanSignal mPagePanFinishedSignal; ///< The signal to notify that a page has finished panning + static const char * const PROPERTY_TEXTURE_WIDTH; ///< The uniform name of texture width + static const char * const PROPERTY_ORIGINAL_CENTER; ///< The property name of original center, which is used to constrain the uniforms + static const char * const PROPERTY_CURRENT_CENTER; ///< The property name of current center, which is used to constrain the uniforms + static const int MAXIMUM_TURNING_NUM; ///< How many pages are allowed to animating in the same time static const int NUMBER_OF_CACHED_PAGES_EACH_SIDE; ///< The maximum number of pages kept, (MAXIMUM_ANIMATION_NUM+1) pages for each side static const int NUMBER_OF_CACHED_PAGES; ///< The maximum number of pages kept, (MAXIMUM_ANIMATION_NUM+1)*2 pages in total @@ -388,4 +454,5 @@ inline const Toolkit::Internal::PageTurnView& GetImplementation(const Toolkit::P } // namespace Toolkit } // namespace Dali -#endif /* __DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H__ */ + +#endif // DALI_TOOLKIT_INTERNAL_PAGE_TURN_VIEW_IMPL_H