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.
24 #include <dali-toolkit/public-api/controls/control.h>
32 namespace Internal DALI_INTERNAL
38 * @brief SuperBlurView accepts an image as input, and displays/animates it with various blur strength.
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
46 * // Set the input image
47 * Image image = Image::New(...);\n
48 * blurView.SetImage(image);\n
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
55 class DALI_IMPORT_API SuperBlurView : public Control
60 static const Dali::Property::Index PROPERTY_IMAGE; ///< name "image", @see SetImage, type MAP
63 * @brief Signal type for notifications.
65 typedef Signal< void (SuperBlurView source) > SuperBlurViewSignal;
68 * @brief Creates an empty SuperBlurView handle.
73 * @brief Create an initialized SuperBlurView.
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
78 static SuperBlurView New( unsigned int blurLevels );
81 * @brief Copy constructor.
83 * Creates another handle that points to the same real object.
84 * @param[in] handle the handle to copy from
86 SuperBlurView( const SuperBlurView& handle );
89 * @brief Assignment operator.
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
95 SuperBlurView& operator=( const SuperBlurView& rhs );
100 * This is non-virtual since derived Handle types must not contain data or virtual methods.
105 * @brief Downcast an Object handle to SuperBlurView.
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
112 static SuperBlurView DownCast( BaseHandle handle );
115 * @brief Sets a custom image to be blurred.
117 * @param[in] inputImage The image that the user wishes to blur
119 void SetImage(Image inputImage);
122 * @brief Get the index of the property that can be used to fade the blur in / out.
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
128 Dali::Property::Index GetBlurStrengthPropertyIndex() const;
131 * @brief Set the blur strength to display the image.
133 * @param[in] blurStrength The blur strength used to display the image.
135 void SetBlurStrength( float blurStrength );
138 * @brief Get the current blur strength.
140 * @return The current blur strength
142 float GetCurrentBlurStrength() const;
145 * @brief Connect to this signal to be notified when the all the blurs have completed.
147 * @return The BlurFinished signal
149 SuperBlurViewSignal& BlurFinishedSignal();
152 * @brief Get the blurred image.
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
158 Image GetBlurredImage( unsigned int level );
160 public: // Not intended for application developers
163 * @brief Creates a handle using the Toolkit::Internal implementation.
165 * @param[in] implementation The Control implementation.
167 DALI_INTERNAL SuperBlurView(Internal::SuperBlurView& implementation);
170 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
172 * @param[in] internal A pointer to the internal CustomActor.
174 explicit DALI_INTERNAL SuperBlurView(Dali::Internal::CustomActor* internal);
177 } // namespace Toolkit
181 #endif /* __DALI_TOOLKIT_SUPER_BLUR_VIEW_H__ */