1 #ifndef __DALI_PAGE_TURN_EFFECT_H_
2 #define __DALI_PAGE_TURN_EFFECT_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/dali.h>
24 namespace Dali DALI_IMPORT_API
30 namespace Internal DALI_INTERNAL
34 * @brief PageTurnEffect implementation class.
38 } // namespace Internal
41 * @brief PageTurnEffect is a custom shader effect to achieve page turn effect for Image actors.
45 * // create shader used for doing page-turn effect\n
46 * PageTurnEffect pageTurnEffect = PageTurnEffect::New();
48 * // set image actor shader to the page-turn one\n
49 * // for portrait view, one image actor for each page\n
50 * // for landscape view, the page turned over is still visible, so back image is needed \n
51 * // in this case, create another image Actor using the back image and added to the page actor \n
52 * ImageActor pageActor = ImageActor::New(....); \n
53 * ImageActor backImageActor = ImageActor::New(....); \n
54 * pageActor.Add(backPageActor);\n
55 * pageActor.SetShaderEffect ( pageTurnEffect ); \n
57 * //set initial values
58 * pageTurnEffect.SetPageSize();\n
59 * pageTurnEffect.SetOriginalCenter();\n
60 * pageTurnEffect.SetIsTurningBack();\n
61 * pageTurnEffect.SetCurrentCenter();\n
63 * //Animate it with the current center property\n
64 * Animation animation[mAnimationIndex] = Animation::New( ... );\n
65 * animation.AnimateTo(Property( pageTurnEffect, pageTurnEffect.PageTurnEffect::GetCurrentCenterPropertyName() ),
67 * AlphaFunctions::...);\n
68 * animation[mAnimationIndex].Play(); \n
71 class PageTurnEffect : public ShaderEffect
75 * @brief Create an uninitialized PageTurnEffect; this can be initialized with PageTurnEffect::New().
77 * Calling member functions with an uninitialized Dali::Object is not allowed.
84 * This is non-virtual since derived Handle types must not contain data or virtual methods.
89 * @brief Create an initialized PageTurnEffect.
91 * If fake shadow is used, need to apply the ShaderEffect::HINT_BLENDING
92 * @param[in] enableBlending If true, apply HINT_BLENDING when creating the shader object; If false, disable the HINT_BLENDING
93 * @return A handle to a newly allocated Dali resource.
95 static PageTurnEffect New( bool enableBlending = true );
98 * @brief Set the page size of the PageTurnEffect.
100 * @param [in] pageSize The page size.
102 void SetPageSize(const Vector2& pageSize);
105 * @brief Set the origin point of the PageTurnEffect, the position where the mouse/finger is pushed from.
107 * @param [in] originalCenter The new origin point.
109 void SetOriginalCenter(const Vector2& originalCenter);
112 * @brief Set the center point of the PageTurnEffect, the current position of touch motion.
114 * @param [in] currentCenter The new center point.
116 void SetCurrentCenter(const Vector2& currentCenter);
119 * @brief Set whether the current page is turning forward or backward.
121 * @param [in] isTurningBack True for turning backward or False for turning forward
123 void SetIsTurningBack(bool isTurningBack);
126 * @brief Set the width of shadow to be pageSize * shadowWidth.
128 * @param [in] shadowWidth The width for the simulated shadow
130 void SetShadowWidth(float shadowWidth);
133 * @brief Set the spine shadow parameter.
135 * The two parameters are the major&minor radius (in pixels) to form an ellipse shape
136 * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow
137 * @param [in] spineShadowParameter The major&minor ellipse radius for the simulated spine shadow
139 void SetSpineShadowParameter(const Vector2& spineShadowParameter);
142 * @brief Get the name for the page size property.
144 * @return A std::string containing the property name
146 const std::string& GetPageSizePropertyName() const;
149 * @brief Get the name for the origin center property.
151 * @return A std::string containing the property name
153 const std::string& GetOriginalCenterPropertyName() const;
156 * @brief Get the name for the current center property.
158 * which can be used in Animation API's
159 * @return A std::string containing the property name
161 const std::string& GetCurrentCenterPropertyName() const;
163 public: // Not intended for application developers
165 PageTurnEffect( ShaderEffect handle, Internal::PageTurnEffect* shaderExtension );
167 }; //end of PageTurnEffect class
169 } // namespace Toolkit
173 #endif /* __DALI_TOOLKIT_SC_CURVE_EFFECT_H_ */