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_FRAMEWORK
  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  * 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    * Signal type for notifications
  64    */
  65   typedef SignalV2< void (SuperBlurView source) > SuperBlurViewSignal;
  66
  67   /**
  68    * Creates an empty SuperBlurView handle
  69    */
  70   SuperBlurView();
  71
  72   /**
  73    * Create an initialized SuperBlurView
  74    * @param[in] blurLevels The final blur strength level. It decides how many filtering passes are used to create the group of blurred images.
  75    * @return A handle to a newly allocated Dali resource
  76    */
  77   static SuperBlurView New( unsigned int blurLevels );
  78
  79   /**
  80    * Copy constructor. Creates another handle that points to the same real object
  81    */
  82   SuperBlurView( const SuperBlurView& handle );
  83
  84   /**
  85    * Assignment operator. Changes this handle to point to another real object
  86    */
  87   SuperBlurView& operator=( const SuperBlurView& rhs );
  88
  89   /**
  90    * Virtual destructor.
  91    */
  92   virtual ~SuperBlurView();
  93
  94   /**
  95    * Downcast an Object handle to SuperBlurView.
  96    * If handle points to a SuperBlurView, the downcast produces valid handle.
  97    * If not, the returned handle is left uninitialized.
  98    * @param[in] handle Handle to an object
  99    * @return handle to a SuperBlurView or an uninitialized handle
 100    */
 101   static SuperBlurView DownCast( BaseHandle handle );
 102
 103   /**
 104    * Sets a custom image to be blurred
 105    * @param[in] inputImage The image that the user wishes to blur
 106    */
 107   void SetImage(Image inputImage);
 108
 109   /**
 110    * Get the index of the property that can be used to fade the blur in / out. This is the overall strength of the blur.
 111    * 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.
 112    * @return Index of the property that can be used to fade the blur in / out
 113    */
 114   Property::Index GetBlurStrengthPropertyIndex() const;
 115
 116   /**
 117    * Set the blur strength to display the image
 118    * @param[in] blurStrength The blur strength used to display the image.
 119    */
 120   void SetBlurStrength( float blurStrength );
 121
 122   /**
 123    * Get the current blur strength
 124    * @return The current blur strength
 125    */
 126   float GetCurrentBlurStrength() const;
 127
 128   /**
 129    * Connect to this signal to be notified when the all the blurs have completed.
 130    * @return The BlurFinished signal
 131    */
 132   SuperBlurViewSignal& BlurFinishedSignal();
 133
 134   /**
 135    * Get the blurred image. Should wait for the BlurFinishedSignal before calling this method
 136    * @param[in] level Indicate which blurred image to get, must be a value between 1 and  blurLevels
 137    * @return The level-th blurred image
 138    */
 139   Image GetBlurredImage( unsigned int level );
 140
 141 public: // Not intended for application developers
 142
 143   /**
 144    * Creates a handle using the Toolkit::Internal implementation.
 145    * @param[in]  implementation  The Control implementation.
 146    */
 147   DALI_INTERNAL SuperBlurView(Internal::SuperBlurView& implementation);
 148
 149   /**
 150    * Allows the creation of this Control from an Internal::CustomActor pointer.
 151    * @param[in]  internal  A pointer to the internal CustomActor.
 152    */
 153   DALI_INTERNAL SuperBlurView(Dali::Internal::CustomActor* internal);
 154
 155 };
 156
 157 } // namespace Toolkit
 158
 159 } // namespace Dali
 160
 161
 162 /**
 163  * @}
 164  */
 165 #endif /* __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__ */