capi/dali-toolkit/public-api/controls/super-blur-view/super-blur-view.h

   1 #ifndef __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__
   2 #define __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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  * @addtogroup CAPI_DALI_TOOLKIT_SUPER_BLUR_VIEW_MODULE
  22  * @{
  23  */
  24
  25 // EXTERNAL INCLUDES
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/public-api/controls/control.h>
  29
  30 namespace Dali DALI_IMPORT_API
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 class SuperBlurView;
  39 }
  40
  41 /**
  42  * @brief SuperBlurView accepts an image as input, and displays/animates it with various blur strength.
  43  * Usage example:-
  44  *
  45  *  // initialise\n
  46  *  SuperBlurView blurView = SuperBlurView::New( blurLevels );\n
  47  *  blurView.SetSize();  // it is important to set the display size before set the input image!!
  48  *  Stage::GetCurrent().Add(blurView);\n
  49  *
  50  *  // Set the input image
  51  *  Image image = Image::New(...);\n
  52  *  blurView.SetImage(image);\n
  53  *
  54  *  // animate the strength of the blur - this can fade between no blur and full blur. .\n
  55  *  Animation blurAnimation = Animation::New( ... );\n
  56  *  blurAnimation.AnimateTo( Property( blurView, blurView.GetBlurStrengthPropertyIndex() ), ... );\n
  57  *  blurAnimation.Play();\n
  58  */
  59 class SuperBlurView : public Control
  60 {
  61 public:
  62   /**
  63    * @brief Signal type for notifications.
  64    */
  65   typedef SignalV2< void (SuperBlurView source) > SuperBlurViewSignal;
  66
  67   /**
  68    * @brief Creates an empty SuperBlurView handle.
  69    */
  70   SuperBlurView();
  71
  72   /**
  73    * @brief Create an initialized SuperBlurView.
  74    *
  75    * @param[in] blurLevels The final blur strength level. It decides how many filtering passes are used to create the group of blurred images.
  76    * @return A handle to a newly allocated Dali resource
  77    */
  78   static SuperBlurView New( unsigned int blurLevels );
  79
  80   /**
  81    * @brief Copy constructor.
  82    *
  83    * Creates another handle that points to the same real object.
  84    * @param[in] handle the handle to copy from
  85    */
  86   SuperBlurView( const SuperBlurView& handle );
  87
  88   /**
  89    * @brief Assignment operator.
  90    *
  91    * Changes this handle to point to another real object.
  92    * @param[in] rhs the handle to copy from
  93    * @return a reference to this
  94    */
  95   SuperBlurView& operator=( const SuperBlurView& rhs );
  96
  97   /**
  98    * @brief Virtual destructor.
  99    */
 100   virtual ~SuperBlurView();
 101
 102   /**
 103    * @brief Downcast an Object handle to SuperBlurView.
 104    *
 105    * If handle points to a SuperBlurView, the downcast produces valid handle.
 106    * If not, the returned handle is left uninitialized.
 107    * @param[in] handle Handle to an object
 108    * @return handle to a SuperBlurView or an uninitialized handle
 109    */
 110   static SuperBlurView DownCast( BaseHandle handle );
 111
 112   /**
 113    * @brief Sets a custom image to be blurred.
 114    *
 115    * @param[in] inputImage The image that the user wishes to blur
 116    */
 117   void SetImage(Image inputImage);
 118
 119   /**
 120    * @brief Get the index of the property that can be used to fade the blur in / out.
 121    *
 122    * This is the overall strength of the blur.
 123    * User can use this to animate the blur. A value of 0.0 is zero blur and 1.0 is full blur. Default is 0.0.
 124    * @return Index of the property that can be used to fade the blur in / out
 125    */
 126   Property::Index GetBlurStrengthPropertyIndex() const;
 127
 128   /**
 129    * @brief Set the blur strength to display the image.
 130    *
 131    * @param[in] blurStrength The blur strength used to display the image.
 132    */
 133   void SetBlurStrength( float blurStrength );
 134
 135   /**
 136    * @brief Get the current blur strength.
 137    *
 138    * @return The current blur strength
 139    */
 140   float GetCurrentBlurStrength() const;
 141
 142   /**
 143    * @brief Connect to this signal to be notified when the all the blurs have completed.
 144    *
 145    * @return The BlurFinished signal
 146    */
 147   SuperBlurViewSignal& BlurFinishedSignal();
 148
 149   /**
 150    * @brief Get the blurred image.
 151    *
 152    * Should wait for the BlurFinishedSignal before calling this method.
 153    * @param[in] level Indicate which blurred image to get, must be a value between 1 and  blurLevels
 154    * @return The level-th blurred image
 155    */
 156   Image GetBlurredImage( unsigned int level );
 157
 158 public: // Not intended for application developers
 159
 160   /**
 161    * @brief Creates a handle using the Toolkit::Internal implementation.
 162    *
 163    * @param[in]  implementation  The Control implementation.
 164    */
 165   DALI_INTERNAL SuperBlurView(Internal::SuperBlurView& implementation);
 166
 167   /**
 168    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 169    *
 170    * @param[in]  internal  A pointer to the internal CustomActor.
 171    */
 172   DALI_INTERNAL SuperBlurView(Dali::Internal::CustomActor* internal);
 173
 174 };
 175
 176 } // namespace Toolkit
 177
 178 } // namespace Dali
 179
 180
 181 /**
 182  * @}
 183  */
 184 #endif /* __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__ */