capi/dali-toolkit/public-api/shader-effects/page-turn-book-spine-effect.h

   1 #ifndef __DALI_PAGE_TURN_BOOK_SPINE_EFFECT_H__
   2 #define __DALI_PAGE_TURN_BOOK_SPINE_EFFECT_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 /**
  22  * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/dali.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 namespace Toolkit
  33 {
  34 /**
  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.
  36  *
  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.
  42  **/
  43 class PageTurnBookSpineEffect : public ShaderEffect
  44 {
  45 public:
  46   /**
  47    * @brief Create an uninitialized PageTurnBookSpineEffect; this can be initialized with PageTurnBookSpineEffect::New().
  48    *
  49    * Calling member functions with an uninitialized Dali::Object is not allowed.
  50    */
  51   PageTurnBookSpineEffect();
  52
  53   /**
  54    * @brief Destructor
  55    *
  56    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  57    */
  58   ~PageTurnBookSpineEffect();
  59
  60   /**
  61    * @brief Create an initialized PageTurnBookSpineEffect.
  62    *
  63    * @return A handle to a newly allocated Dali resource.
  64    */
  65   static PageTurnBookSpineEffect New();
  66
  67   /**
  68    * @brief Set whether the current page is with its backside visible.
  69    *
  70    * Need to pass the parameter as true for the page which is turned over but still visible in Landscape
  71    * @param [in] isBackVisible True for page with its backside upwards
  72    */
  73   void SetIsBackImageVisible( bool isBackVisible );
  74
  75   /**
  76    * @brief Set the page width of the PageTurnBookSpineEffect.
  77    *
  78    * @param [in] pageWidth The width of the page size.
  79    */
  80   void SetPageWidth( float pageWidth );
  81
  82   /**
  83    * @brief Set the width of shadow to be pageSize * shadowWidth.
  84    *
  85    * this shadow appears at the edges of the actor which is not visible on static pages
  86    * @param [in] shadowWidth The width for the simulated shadow
  87    */
  88   void SetShadowWidth( float shadowWidth );
  89
  90   /**
  91    * @brief Set the spine shadow parameter.
  92    *
  93    * The two parameters are the major&minor radius (in pixels) to form an ellipse shape
  94    * The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow
  95    * @param [in] spineShadowParameter The major&minor ellipse radius for the simulated spine shadow
  96    */
  97   void SetSpineShadowParameter( const Vector2& spineShadowParameter );
  98
  99
 100 private:// Helper for New()
 101   PageTurnBookSpineEffect( ShaderEffect handle );
 102
 103 }; // End of PageTurnBookSpineEffect class
 104
 105 } // namespace Toolkit
 106
 107 } // namespace Dali
 108
 109 /**
 110  * @}
 111  */
 112 #endif /* __DALI_PAGE_TURN_BOOK_SPINE_EFFECT_H__ */