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 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
27 #include <dali/dali.h>
29 namespace Dali DALI_IMPORT_API
35 namespace Internal DALI_INTERNAL
39 * @brief PageTurnEffect implementation class.
43 } // namespace Internal
46 * @brief PageTurnEffect is a custom shader effect to achieve page turn effect for Image actors.
50 * // create shader used for doing page-turn effect\n
51 * PageTurnEffect pageTurnEffect = PageTurnEffect::New();
53 * // set image actor shader to the page-turn one\n
54 * // for portrait view, one image actor for each page\n
55 * // for landscape view, the page turned over is still visible, so back image is needed \n
56 * // in this case, create another image Actor using the back image and added to the page actor \n
57 * ImageActor pageActor = ImageActor::New(....); \n
58 * ImageActor backImageActor = ImageActor::New(....); \n
59 * pageActor.Add(backPageActor);\n
60 * pageActor.SetShaderEffect ( pageTurnEffect ); \n
62 * //set initial values
63 * pageTurnEffect.SetPageSize();\n
64 * pageTurnEffect.SetOriginalCenter();\n
65 * pageTurnEffect.SetIsTurningBack();\n
66 * pageTurnEffect.SetCurrentCenter();\n
68 * //Animate it with the current center property\n
69 * Animation animation[mAnimationIndex] = Animation::New( ... );\n
70 * animation.AnimateTo(Property( pageTurnEffect, pageTurnEffect.PageTurnEffect::GetCurrentCenterPropertyName() ),
72 * AlphaFunctions::...);\n
73 * animation[mAnimationIndex].Play(); \n
76 class PageTurnEffect : public ShaderEffect
80 * @brief Create an uninitialized PageTurnEffect; this can be initialized with PageTurnEffect::New().
82 * Calling member functions with an uninitialized Dali::Object is not allowed.
87 * @brief Virtual destructor.
89 virtual ~PageTurnEffect();
92 * @brief Create an initialized PageTurnEffect.
94 * If fake shadow is used, need to apply the ShaderEffect::HINT_BLENDING
95 * @param[in] enableBlending If true, apply HINT_BLENDING when creating the shader object; If false, disable the HINT_BLENDING
96 * @return A handle to a newly allocated Dali resource.
98 static PageTurnEffect New( bool enableBlending = true );
101 * @brief Set the page size of the PageTurnEffect.
103 * @param [in] pageSize The page size.
105 void SetPageSize(const Vector2& pageSize);
108 * @brief Set the origin point of the PageTurnEffect, the position where the mouse/finger is pushed from.
110 * @param [in] originalCenter The new origin point.
112 void SetOriginalCenter(const Vector2& originalCenter);
115 * @brief Set the center point of the PageTurnEffect, the current position of touch motion.
117 * @param [in] currentCenter The new center point.
119 void SetCurrentCenter(const Vector2& currentCenter);
122 * @brief Set whether the current page is turning forward or backward.
124 * @param [in] isTurningBack True for turning backward or False for turning forward
126 void SetIsTurningBack(bool isTurningBack);
129 * @brief Set the width of shadow to be pageSize * shadowWidth.
131 * @param [in] shadowWidth The width for the simulated shadow
133 void SetShadowWidth(float shadowWidth);
136 * @brief Set the spine shadow parameter.
138 * The two parameters are the major&minor radius (in pixels) to form an ellipse shape
139 * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow
140 * @param [in] spineShadowParameter The major&minor ellipse radius for the simulated spine shadow
142 void SetSpineShadowParameter(const Vector2& spineShadowParameter);
145 * @brief Get the name for the page size property.
147 * @return A std::string containing the property name
149 const std::string& GetPageSizePropertyName() const;
152 * @brief Get the name for the origin center property.
154 * @return A std::string containing the property name
156 const std::string& GetOriginalCenterPropertyName() const;
159 * @brief Get the name for the current center property.
161 * which can be used in Animation API's
162 * @return A std::string containing the property name
164 const std::string& GetCurrentCenterPropertyName() const;
166 public: // Not intended for application developers
168 PageTurnEffect( ShaderEffect handle, Internal::PageTurnEffect* shaderExtension );
170 }; //end of PageTurnEffect class
172 } // namespace Toolkit
179 #endif /* __DALI_TOOLKIT_SC_CURVE_EFFECT_H_ */