1 #ifndef __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__
2 #define __DALI_TOOLKIT_SUPER_BLUR_VIEW_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_SUPER_BLUR_VIEW_MODULE
29 #include <dali-toolkit/public-api/controls/control.h>
31 namespace Dali DALI_IMPORT_API
37 namespace Internal DALI_INTERNAL
43 * @brief SuperBlurView accepts an image as input, and displays/animates it with various blur strength.
47 * SuperBlurView blurView = SuperBlurView::New( blurLevels );\n
48 * blurView.SetSize(); // it is important to set the display size before set the input image!!
49 * Stage::GetCurrent().Add(blurView);\n
51 * // Set the input image
52 * Image image = Image::New(...);\n
53 * blurView.SetImage(image);\n
55 * // animate the strength of the blur - this can fade between no blur and full blur. .\n
56 * Animation blurAnimation = Animation::New( ... );\n
57 * blurAnimation.AnimateTo( Property( blurView, blurView.GetBlurStrengthPropertyIndex() ), ... );\n
58 * blurAnimation.Play();\n
60 class SuperBlurView : public Control
65 static const Property::Index PROPERTY_IMAGE; ///< name "image", @see SetImage, type MAP
68 * @brief Signal type for notifications.
70 typedef SignalV2< void (SuperBlurView source) > SuperBlurViewSignal;
73 * @brief Creates an empty SuperBlurView handle.
78 * @brief Create an initialized SuperBlurView.
80 * @param[in] blurLevels The final blur strength level. It decides how many filtering passes are used to create the group of blurred images.
81 * @return A handle to a newly allocated Dali resource
83 static SuperBlurView New( unsigned int blurLevels );
86 * @brief Copy constructor.
88 * Creates another handle that points to the same real object.
89 * @param[in] handle the handle to copy from
91 SuperBlurView( const SuperBlurView& handle );
94 * @brief Assignment operator.
96 * Changes this handle to point to another real object.
97 * @param[in] rhs the handle to copy from
98 * @return a reference to this
100 SuperBlurView& operator=( const SuperBlurView& rhs );
103 * @brief Virtual destructor.
105 virtual ~SuperBlurView();
108 * @brief Downcast an Object handle to SuperBlurView.
110 * If handle points to a SuperBlurView, the downcast produces valid handle.
111 * If not, the returned handle is left uninitialized.
112 * @param[in] handle Handle to an object
113 * @return handle to a SuperBlurView or an uninitialized handle
115 static SuperBlurView DownCast( BaseHandle handle );
118 * @brief Sets a custom image to be blurred.
120 * @param[in] inputImage The image that the user wishes to blur
122 void SetImage(Image inputImage);
125 * @brief Get the index of the property that can be used to fade the blur in / out.
127 * This is the overall strength of the blur.
128 * 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.
129 * @return Index of the property that can be used to fade the blur in / out
131 Property::Index GetBlurStrengthPropertyIndex() const;
134 * @brief Set the blur strength to display the image.
136 * @param[in] blurStrength The blur strength used to display the image.
138 void SetBlurStrength( float blurStrength );
141 * @brief Get the current blur strength.
143 * @return The current blur strength
145 float GetCurrentBlurStrength() const;
148 * @brief Connect to this signal to be notified when the all the blurs have completed.
150 * @return The BlurFinished signal
152 SuperBlurViewSignal& BlurFinishedSignal();
155 * @brief Get the blurred image.
157 * Should wait for the BlurFinishedSignal before calling this method.
158 * @param[in] level Indicate which blurred image to get, must be a value between 1 and blurLevels
159 * @return The level-th blurred image
161 Image GetBlurredImage( unsigned int level );
163 public: // Not intended for application developers
166 * @brief Creates a handle using the Toolkit::Internal implementation.
168 * @param[in] implementation The Control implementation.
170 DALI_INTERNAL SuperBlurView(Internal::SuperBlurView& implementation);
173 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
175 * @param[in] internal A pointer to the internal CustomActor.
177 DALI_INTERNAL SuperBlurView(Dali::Internal::CustomActor* internal);
181 } // namespace Toolkit
189 #endif /* __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__ */