optional/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 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 // EXTERNAL INCLUDES
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/public-api/controls/control.h>
  25
  26 namespace Dali DALI_IMPORT_API
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class SuperBlurView;
  35 }
  36
  37 /**
  38  * @brief SuperBlurView accepts an image as input, and displays/animates it with various blur strength.
  39  * Usage example:-
  40  *
  41  *  // initialise\n
  42  *  SuperBlurView blurView = SuperBlurView::New( blurLevels );\n
  43  *  blurView.SetSize();  // it is important to set the display size before set the input image!!
  44  *  Stage::GetCurrent().Add(blurView);\n
  45  *
  46  *  // Set the input image
  47  *  Image image = Image::New(...);\n
  48  *  blurView.SetImage(image);\n
  49  *
  50  *  // animate the strength of the blur - this can fade between no blur and full blur. .\n
  51  *  Animation blurAnimation = Animation::New( ... );\n
  52  *  blurAnimation.AnimateTo( Property( blurView, blurView.GetBlurStrengthPropertyIndex() ), ... );\n
  53  *  blurAnimation.Play();\n
  54  */
  55 class SuperBlurView : public Control
  56 {
  57 public:
  58
  59   // Properties
  60   static const Property::Index PROPERTY_IMAGE;     ///< name "image",    @see SetImage,    type MAP
  61
  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 Destructor
  99    *
 100    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 101    */
 102   ~SuperBlurView();
 103
 104   /**
 105    * @brief Downcast an Object handle to SuperBlurView.
 106    *
 107    * If handle points to a SuperBlurView, the downcast produces valid handle.
 108    * If not, the returned handle is left uninitialized.
 109    * @param[in] handle Handle to an object
 110    * @return handle to a SuperBlurView or an uninitialized handle
 111    */
 112   static SuperBlurView DownCast( BaseHandle handle );
 113
 114   /**
 115    * @brief Sets a custom image to be blurred.
 116    *
 117    * @param[in] inputImage The image that the user wishes to blur
 118    */
 119   void SetImage(Image inputImage);
 120
 121   /**
 122    * @brief Get the index of the property that can be used to fade the blur in / out.
 123    *
 124    * This is the overall strength of the blur.
 125    * 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.
 126    * @return Index of the property that can be used to fade the blur in / out
 127    */
 128   Property::Index GetBlurStrengthPropertyIndex() const;
 129
 130   /**
 131    * @brief Set the blur strength to display the image.
 132    *
 133    * @param[in] blurStrength The blur strength used to display the image.
 134    */
 135   void SetBlurStrength( float blurStrength );
 136
 137   /**
 138    * @brief Get the current blur strength.
 139    *
 140    * @return The current blur strength
 141    */
 142   float GetCurrentBlurStrength() const;
 143
 144   /**
 145    * @brief Connect to this signal to be notified when the all the blurs have completed.
 146    *
 147    * @return The BlurFinished signal
 148    */
 149   SuperBlurViewSignal& BlurFinishedSignal();
 150
 151   /**
 152    * @brief Get the blurred image.
 153    *
 154    * Should wait for the BlurFinishedSignal before calling this method.
 155    * @param[in] level Indicate which blurred image to get, must be a value between 1 and  blurLevels
 156    * @return The level-th blurred image
 157    */
 158   Image GetBlurredImage( unsigned int level );
 159
 160 public: // Not intended for application developers
 161
 162   /**
 163    * @brief Creates a handle using the Toolkit::Internal implementation.
 164    *
 165    * @param[in]  implementation  The Control implementation.
 166    */
 167   DALI_INTERNAL SuperBlurView(Internal::SuperBlurView& implementation);
 168
 169   /**
 170    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 171    *
 172    * @param[in]  internal  A pointer to the internal CustomActor.
 173    */
 174   DALI_INTERNAL SuperBlurView(Dali::Internal::CustomActor* internal);
 175
 176 };
 177
 178 } // namespace Toolkit
 179
 180 } // namespace Dali
 181
 182 #endif /* __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__ */