1 #ifndef __DALI_PAGE_TURN_BOOK_SPINE_EFFECT_H__
2 #define __DALI_PAGE_TURN_BOOK_SPINE_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 * @brief This is an assisting effect of PageTurnEffect to display a book spine on _static_ pages, and also to flip the image horizontally when needed.
37 * When the page is turned over in landscape, call
38 * SetIsBackImageVisible(true), this effect can display the back image
39 * correctly after the imageActor been rotated 180 degrees. To
40 * display the pages visually consistent with its turning state,
41 * please set the uniforms with the same values as the PageTurnEffect.
43 class PageTurnBookSpineEffect : public ShaderEffect
47 * @brief Create an uninitialized PageTurnBookSpineEffect; this can be initialized with PageTurnBookSpineEffect::New().
49 * Calling member functions with an uninitialized Dali::Object is not allowed.
51 PageTurnBookSpineEffect();
54 * @brief Virtual destructor.
56 virtual ~PageTurnBookSpineEffect();
59 * @brief Create an initialized PageTurnBookSpineEffect.
61 * @return A handle to a newly allocated Dali resource.
63 static PageTurnBookSpineEffect New();
66 * @brief Set whether the current page is with its backside visible.
68 * Need to pass the parameter as true for the page which is turned over but still visible in Landscape
69 * @param [in] isBackVisible True for page with its backside upwards
71 void SetIsBackImageVisible( bool isBackVisible );
74 * @brief Set the page width of the PageTurnBookSpineEffect.
76 * @param [in] pageWidth The width of the page size.
78 void SetPageWidth( float pageWidth );
81 * @brief Set the width of shadow to be pageSize * shadowWidth.
83 * this shadow appears at the edges of the actor which is not visible on static pages
84 * @param [in] shadowWidth The width for the simulated shadow
86 void SetShadowWidth( float shadowWidth );
89 * @brief Set the spine shadow parameter.
91 * The two parameters are the major&minor radius (in pixels) to form an ellipse shape
92 * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow
93 * @param [in] spineShadowParameter The major&minor ellipse radius for the simulated spine shadow
95 void SetSpineShadowParameter( const Vector2& spineShadowParameter );
98 private:// Helper for New()
99 PageTurnBookSpineEffect( ShaderEffect handle );
101 }; // End of PageTurnBookSpineEffect class
103 } // namespace Toolkit
110 #endif /* __DALI_PAGE_TURN_BOOK_SPINE_EFFECT_H__ */